peak::ipl::Range< T > Class Template Reference

Range support and convenience class. More...

#include <peak_ipl/types/peak_ipl_range.hpp>

Public Member Functions
constexpr	Range (T min, T max, T inc)
	Constructor for the Range.
constexpr T	Minimum () const
	Get the minimum value for the range.
constexpr T	Maximum () const
	Get the maximum value for the range.
constexpr T	Increment () const
	Get the increment value for the range.
constexpr std::tuple< T, T, T >	GetRange () const
	Get the range as tuple.
constexpr bool	InRange (T value) const
	Check if the value is in range.

Detailed Description

template<typename T>
class peak::ipl::Range< T >

Range support and convenience class.

Constructor & Destructor Documentation

Range()

template<typename T>

peak::ipl::Range< T >::Range ( T min, T max, T inc )

inlineconstexpr

Constructor for the Range.

Parameters

min	The minimum value for the range.
max	The maximum value for the range.
inc	The increment value for the range.

Exceptions

InvalidArgumentException

for invalid input values.

Member Function Documentation

GetRange()

template<typename T>

std::tuple< T, T, T > peak::ipl::Range< T >::GetRange ( ) const

inlineconstexpr

Get the range as tuple.

Returns

the Range as tuple with <minimum, maximum, increment> in that order.

Increment()

template<typename T>

T peak::ipl::Range< T >::Increment ( ) const

inlineconstexpr

Get the increment value for the range.

Returns

the increment value.

InRange()

template<typename T>

bool peak::ipl::Range< T >::InRange ( T value ) const

inlineconstexpr

Check if the value is in range.

Parameters

value

The value to check.

Returns

true if in range, false otherwise.

Maximum()

template<typename T>

T peak::ipl::Range< T >::Maximum ( ) const

inlineconstexpr

Get the maximum value for the range.

Returns

the maximum value.

Minimum()

template<typename T>

T peak::ipl::Range< T >::Minimum ( ) const

inlineconstexpr

Get the minimum value for the range.

Returns

the minimum value.

---

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

• peak_ipl/types/peak_ipl_range.hpp