The array_range class provides a view into an underlying data structure with lower and upper limits. More...
#include <array_range.h>
Public Types
Public Member Functions
Detailed Description
template<typename T, typename Predicate = detail::default_predicate<T>>
class rttr::array_range< T, Predicate >
The array_range class provides a view into an underlying data structure with lower and upper limits.
In order to iterate over the data structure use the returned forward iterators from begin() or rbegin(). To check whether the end of the range has reached use end() or rend(). Using the standard C++ range-based for loop will implicit do all this work.
- Remarks
- When the underlying data structure gets modified while holding a range, its iterators and the range itself will be invalidated.
Member Typedef Documentation
A constant forward iterator.
A constant forward iterator that reverses the direction.
A forward iterator.
A forward iterator that reverses the direction.
Constructor & Destructor Documentation
Default constructor.
Constructs an empty array_range.
Predicate()
Constructs an array range starting from begin to end [begin, end).
- Parameters
-
begin Marks the start of the range. Is included of the range.size The number of elements to include in the range.pred Determines whether an element in the range fulfills the condition of the predicate.
Member Function Documentation
Returns an iterator to the first element of the range.
- Remarks
- If the range is empty, the returned iterator will be equal to end().
- Returns
- Iterator to the first element.
Returns a constant iterator to the first element of the range.
- Remarks
- If the range is empty, the returned iterator will be equal to end().
- Returns
- Constant iterator to the first element.
Returns a constant iterator to the first element of the range.
- Remarks
- If the range is empty, the returned iterator will be equal to end().
- Returns
- Constant iterator to the first element.
Returns a constant iterator to the element following the last element of the range.
- Remarks
- This element acts as placeholder, attempting to access it results in undefined behavior. If the range is empty, the returned iterator will be equal to begin().
- Returns
- Constant iterator to the element following the last element.
Returns a constant reverse iterator to the first element of the reversed range.
It corresponds to the last element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rend().
- Returns
- Constant reverse iterator to the first element.
Returns a constant reverse iterator to the element following the last element of the reversed range.
It corresponds to the element preceding the first element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rbegin().
- Returns
- Constant reverse iterator to the element following the last element.
Checks if the range has no elements, i.e.
- Remarks
- Every element will be checked against the condition of the used predicate. Only when every element doe not fulfill the condition of predicate, the range is declared empty. That means, in order to check for emptiness, the underlying algorithm needs to iterate through the whole range. So don't call it to often. It's better to cache the result in a temporary variable.
- Returns
Trueif this range is empty, otherwisefalse.
Returns an iterator to the element following the last element of the range.
- Remarks
- This element acts as placeholder, attempting to access it results in undefined behavior. If the range is empty, the returned iterator will be equal to begin().
- Returns
- Iterator to the element following the last element.
Returns a constant iterator to the element following the last element of the range.
- Remarks
- This element acts as placeholder, attempting to access it results in undefined behavior. If the range is empty, the returned iterator will be equal to begin().
- Returns
- Constant iterator to the element following the last element.
Returns a reverse iterator to the first element of the reversed range.
It corresponds to the last element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rend().
- Returns
- Reverse iterator to the first element.
Returns a constant reverse iterator to the first element of the reversed range.
It corresponds to the last element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rend().
- Returns
- Constant reverse iterator to the first element.
Returns a reverse iterator to the element following the last element of the reversed range.
It corresponds to the element preceding the first element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rbegin().
- Returns
- Reverse iterator to the element following the last element.
Returns a constant reverse iterator to the element following the last element of the reversed range.
It corresponds to the element preceding the first element of the non-reversed range.
- Remarks
- If the range is empty, the returned iterator will be equal to rbegin().
- Returns
- Constant reverse iterator to the element following the last element.
Returns the number of elements in the range.
- Remarks
- Every element will be checked against the condition of the used predicate. Only elements which fulfill the condition of predicate will be included in the counter. That means, in order to determine the size of the range, the underlying algorithm needs to iterate through the whole range. So don't call it to often. It's better to cache the result in a temporary variable.
- Returns
- The number of elements in the range.
The documentation for this class was generated from the following file: