iris::Array< V, D > Class Template Reference
Doxygen 1.15.0 generates this reference during each site build from the public headers. The C++ guide shows the API in use.
A view of an array of depth D, whose elements are views of depth D - 1. More...
#include <iris/handle.hpp>
Classes | |
| class | Iterator |
| An iterator over the elements. More... | |
Public Types | |
| using | Element = detail::ViewOf<V, D - 1>::Type |
| The view of an element. | |
Public Member Functions | |
| std::size_t | size () const |
| Return the number of elements. | |
| bool | empty () const |
| Whether there are no elements. | |
| Element | operator[] (std::size_t i) const |
| Return element i, counted from 0. | |
| Iterator | begin () const |
| Return an iterator at the first element. | |
| Iterator | end () const |
| Return an iterator after the last element. | |
| ValueRef | value () const |
| Return the untyped view of the array. | |
Detailed Description
class iris::Array< V, D >
A view of an array of depth D, whose elements are views of depth D - 1.
Data::get returns it for an array of strings of depth 1 and for every array of depth 2 or more. Like ValueRef, it stays valid while any copy of the Data it comes from exists.
Member Typedef Documentation
Element
| using iris::Array< V, D >::Element = detail::ViewOf<V, D - 1>::Type |
The view of an element.
Member Function Documentation
begin()
|
inlinenodiscard |
Return an iterator at the first element.
empty()
|
inlinenodiscard |
Whether there are no elements.
end()
|
inlinenodiscard |
Return an iterator after the last element.
operator[]()
|
inlinenodiscard |
Return element i, counted from 0.
Throws AccessError if i is out of range.
size()
|
inlinenodiscard |
Return the number of elements.
value()
|
inlinenodiscard |
Return the untyped view of the array.