volcart::RangeIterable< T, > Class Template Reference

Provides an iterable range of numbers with optional step size. More...

#include <vc/core/util/Iteration.hpp>

Classes
class	CountingIterator

Public Types
using	iterator = CountingIterator< T >
using	const_iterator = CountingIterator< T const & >

Public Member Functions
	RangeIterable (T start, T end, T step)
iterator	begin () const
iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
template<typename Q = T>
std::enable_if_t< std::is_floating_point< Q >::value, std::size_t >	size () const
template<typename Q = T>
std::enable_if_t< std::is_integral< Q >::value, std::size_t >	size () const

Private Attributes
T	start_ {0}
T	end_ {0}
T	step_ {1}

Detailed Description

template<typename T, std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>
class volcart::RangeIterable< T, >

Provides an iterable range of numbers with optional step size.

Convenience class for generating range-based for loops over numerical values. Note that this class only returns values and const references.

Template Parameters

T	Integral or floating-point type

Definition at line 24 of file Iteration.hpp.

Member Typedef Documentation

const_iterator

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

using volcart::RangeIterable< T, >::const_iterator = CountingIterator<T const&>

Const iterator type

Definition at line 83 of file Iteration.hpp.

iterator

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

using volcart::RangeIterable< T, >::iterator = CountingIterator<T>

Iterator type

Definition at line 81 of file Iteration.hpp.

Constructor & Destructor Documentation

RangeIterable()

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

volcart::RangeIterable< T, >::RangeIterable ( T  start, T  end, T  step  )

inline

Construct a new range

Definition at line 86 of file Iteration.hpp.

Member Function Documentation

begin()

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

iterator volcart::RangeIterable< T, >::begin ( ) const

inline

Return the start of the range

Definition at line 95 of file Iteration.hpp.

cbegin()

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

const_iterator volcart::RangeIterable< T, >::cbegin ( ) const

inline

Return the const start of the range

Definition at line 99 of file Iteration.hpp.

cend()

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

const_iterator volcart::RangeIterable< T, >::cend ( ) const

inline

Return the const end of the range

Definition at line 104 of file Iteration.hpp.

end()

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

iterator volcart::RangeIterable< T, >::end ( ) const

inline

Return the end of the range

Definition at line 97 of file Iteration.hpp.

size() [1/2]

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

template<typename Q = T>

std::enable_if_t< std::is_floating_point< Q >::value, std::size_t > volcart::RangeIterable< T, >::size ( ) const

inline

Returns the size of the range (floating point ranges)

Definition at line 108 of file Iteration.hpp.

size() [2/2]

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

template<typename Q = T>

std::enable_if_t< std::is_integral< Q >::value, std::size_t > volcart::RangeIterable< T, >::size ( ) const

inline

Returns the size of the range (integral ranges)

Definition at line 115 of file Iteration.hpp.

Member Data Documentation

end_

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

T volcart::RangeIterable< T, >::end_ {0}

private

Definition at line 122 of file Iteration.hpp.

start_

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

T volcart::RangeIterable< T, >::start_ {0}

private

Definition at line 121 of file Iteration.hpp.

step_

template<typename T , std::enable_if_t< std::is_arithmetic< T >::value, int > = 0>

T volcart::RangeIterable< T, >::step_ {1}

private

Definition at line 123 of file Iteration.hpp.

---

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

• vc/core/util/Iteration.hpp