hgps::core::Interval< TYPE > Class Template Reference

Numeric interval representation data type. More...

#include <interval.h>

Public Member Functions
	Interval ()=default
	Initialises a new instance of the Interval class.
	Interval (TYPE lower_value, TYPE upper_value)
	Initialises a new instance of the Interval class.
TYPE	lower () const noexcept
	Gets the interval lower bound.
TYPE	upper () const noexcept
	Gets the interval upper bound.
TYPE	length () const noexcept
	Gets the interval length.
bool	contains (TYPE value) const noexcept
	Determines whether a value is in the Interval.
bool	contains (Interval< TYPE > &other) const noexcept
	Determines whether an Interval is inside this instance interval.
TYPE	clamp (TYPE value) const noexcept
	Clamp a given value to the interval boundaries.
std::string	to_string () const noexcept
	Convert this instance to a string representation.
auto	operator<=> (const Interval< TYPE > &rhs) const =default
	Compare two Interval instances.

Detailed Description

template<Numerical TYPE>
class hgps::core::Interval< TYPE >

Numeric interval representation data type.

Template Parameters

TYPE	The numerical type

Constructor & Destructor Documentation

Interval() [1/2]

template<Numerical TYPE>

hgps::core::Interval< TYPE >::Interval ( )

default

Initialises a new instance of the Interval class.

Interval() [2/2]

template<Numerical TYPE>

hgps::core::Interval< TYPE >::Interval ( TYPE  lower_value, TYPE  upper_value  )

inlineexplicit

Initialises a new instance of the Interval class.

Parameters

lower_value	Lower bound value
upper_value	Upper bound value

Member Function Documentation

clamp()

template<Numerical TYPE>

TYPE hgps::core::Interval< TYPE >::clamp ( TYPE  value ) const

inlinenoexcept

Clamp a given value to the interval boundaries.

Parameters

value

The value to clamp

Returns

The clamped value

contains() [1/2]

template<Numerical TYPE>

bool hgps::core::Interval< TYPE >::contains ( Interval< TYPE > &  other ) const

inlinenoexcept

Determines whether an Interval is inside this instance interval.

Parameters

other

The other Interval to check

Returns

true if the other Interval is inside this instance; otherwise, false.

Here is the call graph for this function:

contains() [2/2]

template<Numerical TYPE>

bool hgps::core::Interval< TYPE >::contains ( TYPE  value ) const

inlinenoexcept

Determines whether a value is in the Interval.

Parameters

value

The value to check

Returns

true if the value is in the interval; otherwise, false.

Here is the caller graph for this function:

length()

template<Numerical TYPE>

TYPE hgps::core::Interval< TYPE >::length ( ) const

inlinenoexcept

Gets the interval length.

Returns

Length of the interval

Here is the caller graph for this function:

lower()

template<Numerical TYPE>

TYPE hgps::core::Interval< TYPE >::lower ( ) const

inlinenoexcept

Gets the interval lower bound.

Returns

The lower bound value

Here is the caller graph for this function:

operator<=>()

template<Numerical TYPE>

auto hgps::core::Interval< TYPE >::operator<=> ( const Interval< TYPE > &  rhs ) const

default

Compare two Interval instances.

Parameters

rhs	The Interval to compare to this instance.

Returns

The comparison result

to_string()

template<Numerical TYPE>

std::string hgps::core::Interval< TYPE >::to_string ( ) const

inlinenoexcept

Convert this instance to a string representation.

Returns

The equivalent string representation

upper()

template<Numerical TYPE>

TYPE hgps::core::Interval< TYPE >::upper ( ) const

inlinenoexcept

Gets the interval upper bound.

Returns

The upper bound value

Here is the caller graph for this function:

---

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

• HealthGPS.Core/interval.h