IntervalUtility< TValue > Class Template Reference

Utility class for membership tests on a 1D interval. More...

#include <IntervalUtility.hpp>

Collaboration diagram for IntervalUtility< TValue >:

Public Member Functions
	KRATOS_CLASS_POINTER_DEFINITION (IntervalUtility)
	IntervalUtility ()
	Default constructor initializing boundaries to "Begin" and "End".
	IntervalUtility (Parameters Settings)
	Construct from parameters containing "interval".
	IntervalUtility (IntervalUtility &&rOther)=default
	IntervalUtility (const IntervalUtility &rOther)=default
TValue	GetIntervalBegin () const noexcept
TValue	GetIntervalEnd () const noexcept
bool	IsInInterval (TValue Value) const noexcept
	Check whether the input value is within the defined closed interval [Begin, End].
std::string	Info () const
	Return information as a string.
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object.
void	PrintData (std::ostream &rOStream) const
	Print object's data.

Static Public Member Functions
static Parameters	GetDefaultParameters ()

Detailed Description

template<class TValue>
class Kratos::WRApp::Impl::IntervalUtility< TValue >

Utility class for membership tests on a 1D interval.

Note

This class template has specializations for double and int but is not implemented for other types.

Constructor & Destructor Documentation

IntervalUtility() [1/4]

template<class TValue >

IntervalUtility

(

)

Default constructor initializing boundaries to "Begin" and "End".

IntervalUtility() [2/4]

template<class TValue >

IntervalUtility

(

Parameters

Settings

)

Construct from parameters containing "interval".

"interval" is expected as an array with exactly 2 items, defining the begin and end of the interval respectively. The first item can either be a numeric value or "Begin" (setting the smallest representable value of TValue), while the second one can be a numeric value or "End" (setting the highest representable value of TValue).

Note

String values ("Begin" and "End") are replaced with their numeric counterparts in the input Settings.

If "interval" is not in Settings, an "interval" with values corresponding to "Begin" and "End" is added to it.

Other parameters in Settings are not checked.

Exceptions

If	Settings has "interval" but has invalid value: not an array of size 2 first item is not "Begin" or an appropriate numeric value second item is not "End" or an appropriate numeric value swapped boundaries (end < begin)

IntervalUtility() [3/4]

template<class TValue >

IntervalUtility ( IntervalUtility< TValue > &&  rOther )

default

IntervalUtility() [4/4]

template<class TValue >

IntervalUtility ( const IntervalUtility< TValue > &  rOther )

default

Member Function Documentation

GetDefaultParameters()

template<class TValue >

static Parameters GetDefaultParameters ( )

static

GetIntervalBegin()

template<class TValue >

TValue GetIntervalBegin ( ) const

noexcept

GetIntervalEnd()

template<class TValue >

TValue GetIntervalEnd ( ) const

noexcept

Info()

template<class TValue >

std::string Info

(

)

const

Return information as a string.

IsInInterval()

template<class TValue >

bool IsInInterval ( TValue  Value ) const

noexcept

Check whether the input value is within the defined closed interval [Begin, End].

KRATOS_CLASS_POINTER_DEFINITION()

template<class TValue >

KRATOS_CLASS_POINTER_DEFINITION

(

IntervalUtility< TValue >

)

PrintData()

template<class TValue >

void PrintData

(

std::ostream &

rOStream

)

const

Print object's data.

PrintInfo()

template<class TValue >

void PrintInfo

(

std::ostream &

rOStream

)

const

Print information about this object.

---

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

• IntervalUtility.hpp