Zivid::Range< T > Class Template Reference

Class describing a range of values for a given type T. More...

#include <Zivid/Range.h>

Public Types
using	Type = T
	Underlying type.

Public Member Functions
constexpr	Range ()=default
	Default constructor.
constexpr	Range (T min, T max)
	Constructor.
constexpr const T &	min () const
	Get the minimum value of the range.
constexpr const T &	max () const
	Get the maximum value of the range.
constexpr bool	isInRange (const T &value) const
	Check if the value is in range.
bool	operator== (const Range< T > &other) const
	Comparison operator.
bool	operator!= (const Range< T > &other) const
	Comparison operator.
std::string	toString () const
	Get the range as string.

Detailed Description

template<typename T>
class Zivid::Range< T >

Class describing a range of values for a given type T.

The range is inclusive, in other words both the minimum and maximum values are included in the range.

Member Typedef Documentation

Type

template<typename T >

using Zivid::Range< T >::Type = T

Underlying type.

Constructor & Destructor Documentation

Range() [1/2]

template<typename T >

constexpr Zivid::Range< T >::Range ( )

constexprdefault

Default constructor.

Range() [2/2]

template<typename T >

constexpr Zivid::Range< T >::Range ( T  min, T  max  )

inlineconstexpr

Constructor.

Member Function Documentation

isInRange()

template<typename T >

constexpr bool Zivid::Range< T >::isInRange ( const T &  value ) const

inlineconstexpr

Check if the value is in range.

The range is inclusive, in other words both the minimum and maximum values are included in the range.

max()

template<typename T >

constexpr const T & Zivid::Range< T >::max ( ) const

inlineconstexpr

Get the maximum value of the range.

min()

template<typename T >

constexpr const T & Zivid::Range< T >::min ( ) const

inlineconstexpr

Get the minimum value of the range.

operator!=()

template<typename T >

bool Zivid::Range< T >::operator!= ( const Range< T > &  other ) const

inline

Comparison operator.

operator==()

template<typename T >

bool Zivid::Range< T >::operator== ( const Range< T > &  other ) const

inline

Comparison operator.

toString()

template<typename T >

std::string Zivid::Range< T >::toString ( ) const

inline

Get the range as string.

---

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

• Zivid/Range.h