Loading...
Searching...
No Matches
VdfIteratorRange< Iterator > Class Template Reference

This class allows for construction of iterable ranges. More...

#include <iteratorRange.h>

Public Types

using value_type = typename std::remove_cv< typename Iterator::value_type >::type
 Type of the elements this range gives access to.
 
using iterator = Iterator
 Type of iterator used in the range.
 
using const_iterator = Iterator
 Type of constant iterator used in the range.
 

Public Member Functions

template<typename... Args>
 VdfIteratorRange (Args &&... args)
 Constructs an iterable range from a begin iterator.
 
 VdfIteratorRange (Iterator begin, Iterator end)
 Constructs an iterable range from begin and end iterators.
 
Iterator begin () const
 Returns an iterator to the beginning of the iterable range.
 
Iterator end () const
 Returns an iterator to the end of the iterable range.
 
bool IsEmpty () const
 Returns true if the range is empty.
 

Detailed Description

template<typename Iterator>
class VdfIteratorRange< Iterator >

This class allows for construction of iterable ranges.

Definition at line 26 of file iteratorRange.h.

Member Typedef Documentation

◆ const_iterator

using const_iterator = Iterator

Type of constant iterator used in the range.

Definition at line 41 of file iteratorRange.h.

◆ iterator

using iterator = Iterator

Type of iterator used in the range.

Definition at line 37 of file iteratorRange.h.

◆ value_type

using value_type = typename std::remove_cv<typename Iterator::value_type>::type

Type of the elements this range gives access to.

Definition at line 32 of file iteratorRange.h.

Constructor & Destructor Documentation

◆ VdfIteratorRange() [1/2]

VdfIteratorRange ( Args &&...  args)
inline

Constructs an iterable range from a begin iterator.

Definition at line 46 of file iteratorRange.h.

◆ VdfIteratorRange() [2/2]

VdfIteratorRange ( Iterator  begin,
Iterator  end 
)
inline

Constructs an iterable range from begin and end iterators.

Definition at line 54 of file iteratorRange.h.

Member Function Documentation

◆ begin()

Iterator begin ( ) const
inline

Returns an iterator to the beginning of the iterable range.

Definition at line 58 of file iteratorRange.h.

◆ end()

Iterator end ( ) const
inline

Returns an iterator to the end of the iterable range.

Definition at line 64 of file iteratorRange.h.

◆ IsEmpty()

bool IsEmpty ( ) const
inline

Returns true if the range is empty.

Definition at line 70 of file iteratorRange.h.


The documentation for this class was generated from the following file: