This class implements an interpolation map allowing to determine an interplated value between several individual key values. More...

#include <Interpolation.h>

Public Types
using	ValueMap = std::map< TKey, TValue >
	Definition of a map mapping keys to values.

using	LinearInterpolationFunction = TValue(*)(const TValue &, const TValue &, const TFactor &)
	Definition of a function pointer for a function providing a linear interpolation.

Public Member Functions
	InterpolationMap ()
	Default constructor.

	InterpolationMap (const InterpolationMap< TKey, TValue, TFactor > &interpolationMap)
	Copy constructor for interpolation maps.

	InterpolationMap (InterpolationMap< TKey, TValue, TFactor > &&interpolationMap) noexcept
	Move constructor for interpolation maps.

	InterpolationMap (const ValueMap &valueMap)
	Creates a new interpolation map object by a given value map.

	InterpolationMap (ValueMap &&valueMap)
	Creates a new interpolation map object by a given value map.

size_t	size () const
	Returns the number of elements (pairs of keys and values) of this interpolation map.

bool	isEmpty () const
	Returns whether this interpolation map object is empty.

void	clear ()
	Clears all elements (pairs of keys and values) of this interpolation map object.

const ValueMap &	interpolationMap () const
	Returns the entire internal interpolation map.

void	setInterpolationMap (const ValueMap &interpolationMap)
	Sets or changes the entire internal interpolation map.

void	setInterpolationMap (ValueMap &&interpolationMap)
	Sets or changes the entire internal interpolation map.

bool	hasValue (const TKey &key) const
	Returns whether this interpolation map object holds a value for a specified key.

TValue &	value (const TKey &key)
	Returns the value of this interpolation map object defined by a corresponding key.

bool	remove (const TKey &key)
	Removes an elements (pair of key and value) from this interpolation map object.

bool	insert (const TKey &key, const TValue &value, const bool forceOverwrite=false)
	Inserts a new pair of key and value to this map object.

bool	insert (const TKey &key, TValue &&value, const bool forceOverwrite=false)
	Inserts a new pair of key and value to this map object.

TValue	linear (const TKey &key) const
	Returns the linear interpolation of the stored values for a given key.

TValue	linear (const TKey &key, const LinearInterpolationFunction interpolationFunction) const
	Returns the linear interpolation of the stored values for a given key and a given interpolation function.

InterpolationMap< TKey, TValue, TFactor > &	operator= (const InterpolationMap< TKey, TValue, TFactor > &object)
	Assign operator.

InterpolationMap< TKey, TValue, TFactor > &	operator= (InterpolationMap< TKey, TValue, TFactor > &&object) noexcept
	Move operator.

bool	operator== (const InterpolationMap< TKey, TValue, TFactor > &object) const
	Returns whether two interpolation objects are equal.

bool	operator!= (const InterpolationMap< TKey, TValue, TFactor > &object) const
	Returns whether two interpolation objects are not equal.

TValue &	operator[] (const TKey &key)
	Returns the value of this interpolation map object defined by a corresponding key.

Static Public Member Functions
static TValue	linear (const ValueMap &valueMap, const TKey &key)
	Returns the linear interpolation of given values for a given key.

static TValue	linear (const ValueMap &valueMap, const TKey &key, const LinearInterpolationFunction interpolationFunction)
	Returns the linear interpolation of given values for a given key and a given interpolation function.

Protected Attributes
ValueMap	interpolationValueMap
	Map mapping keys to values.

Detailed Description

template<typename TKey, typename TValue, typename TFactor>
class Ocean::InterpolationMap< TKey, TValue, TFactor >

This class implements an interpolation map allowing to determine an interplated value between several individual key values.

Template Parameters

TKey	The data type of the stored keys
TValue	The data type of the stored values
TFactor	The data type of the interpolation factor

Member Typedef Documentation

◆ LinearInterpolationFunction

template<typename TKey , typename TValue , typename TFactor >

using Ocean::InterpolationMap< TKey, TValue, TFactor >::LinearInterpolationFunction = TValue (*)(const TValue&, const TValue&, const TFactor&)

Definition of a function pointer for a function providing a linear interpolation.

The first parameter defines the first interpolation value.
The second parameter defines the second interpolation value.
The third parameter defines the interpolation factor, with range [0, 1].

◆ ValueMap

template<typename TKey , typename TValue , typename TFactor >

using Ocean::InterpolationMap< TKey, TValue, TFactor >::ValueMap = std::map<TKey, TValue>

Definition of a map mapping keys to values.

Constructor & Destructor Documentation

◆ InterpolationMap() [1/5]

template<typename TKey , typename TValue , typename TFactor >

Ocean::InterpolationMap< TKey, TValue, TFactor >::InterpolationMap ( )

inline

Default constructor.

◆ InterpolationMap() [2/5]

template<typename TKey , typename TValue , typename TFactor >

Ocean::InterpolationMap< TKey, TValue, TFactor >::InterpolationMap ( const InterpolationMap< TKey, TValue, TFactor > & interpolationMap )

inline

Copy constructor for interpolation maps.

Parameters

interpolationMap The interpolation map to copy

◆ InterpolationMap() [3/5]

template<typename TKey , typename TValue , typename TFactor >

Ocean::InterpolationMap< TKey, TValue, TFactor >::InterpolationMap ( InterpolationMap< TKey, TValue, TFactor > && interpolationMap )

inlinenoexcept

Move constructor for interpolation maps.

Parameters

interpolationMap The interpolation map to move

◆ InterpolationMap() [4/5]

template<typename TKey , typename TValue , typename TFactor >

Ocean::InterpolationMap< TKey, TValue, TFactor >::InterpolationMap ( const ValueMap & valueMap )

inline

Creates a new interpolation map object by a given value map.

Parameters

valueMap The value map that will be stored in this object

◆ InterpolationMap() [5/5]

template<typename TKey , typename TValue , typename TFactor >

Ocean::InterpolationMap< TKey, TValue, TFactor >::InterpolationMap ( ValueMap && valueMap )

inline

Creates a new interpolation map object by a given value map.

Parameters

valueMap The value map that will be moved to this object

Member Function Documentation

◆ clear()

template<typename TKey , typename TValue , typename TFactor >

void Ocean::InterpolationMap< TKey, TValue, TFactor >::clear ( )

inline

Clears all elements (pairs of keys and values) of this interpolation map object.

◆ hasValue()

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::hasValue ( const TKey & key ) const

inline

Returns whether this interpolation map object holds a value for a specified key.

Parameters

key	Key which is checked

Returns: True, if so

◆ insert() [1/2]

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::insert	(	const TKey &	key,
		const TValue &	value,
		const bool	forceOverwrite = `false`
	)

inline

Inserts a new pair of key and value to this map object.

Parameters

key	New key to be inserted
value	Corresponding value to be instered
forceOverwrite	True, if an already existing pair with same key will be overwritten by the given pair

Returns: True, if the given pair has been inserted

◆ insert() [2/2]

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::insert	(	const TKey &	key,
		TValue &&	value,
		const bool	forceOverwrite = `false`
	)

inline

Inserts a new pair of key and value to this map object.

Parameters

key	New key to be inserted
value	Corresponding value to be moved
forceOverwrite	True, if an already existing pair with same key will be overwritten by the given pair

Returns: True, if the given pair has been inserted

◆ interpolationMap()

template<typename TKey , typename TValue , typename TFactor >

const InterpolationMap< TKey, TValue, TFactor >::ValueMap & Ocean::InterpolationMap< TKey, TValue, TFactor >::interpolationMap ( ) const

inline

Returns the entire internal interpolation map.

Returns: Interpolation map of this object

◆ isEmpty()

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::isEmpty ( ) const

inline

Returns whether this interpolation map object is empty.

Returns: True, if so

◆ linear() [1/4]

template<typename TKey , typename TValue , typename TFactor >

TValue Ocean::InterpolationMap< TKey, TValue, TFactor >::linear ( const TKey & key ) const

inline

Returns the linear interpolation of the stored values for a given key.

Parameters

key	The key of the value that will be (interpolated and) returned

Returns: Resulting interpolated value

◆ linear() [2/4]

template<typename TKey , typename TValue , typename TFactor >

TValue Ocean::InterpolationMap< TKey, TValue, TFactor >::linear	(	const TKey &	key,
		const LinearInterpolationFunction	interpolationFunction
	)		const

inline

Returns the linear interpolation of the stored values for a given key and a given interpolation function.

Parameters

key	The key of the value that will be (interpolated and) returned
interpolationFunction	An explicit interpolation function that is applied

Returns: Resulting interpolated value

◆ linear() [3/4]

template<typename TKey , typename TValue , typename TFactor >

TValue Ocean::InterpolationMap< TKey, TValue, TFactor >::linear	(	const ValueMap &	valueMap,
		const TKey &	key
	)

static

Returns the linear interpolation of given values for a given key.

Parameters

valueMap	The map of values that are used for interpolation
key	The key of the value that will be (interpolated and) returned

Returns: Resulting interpolated value

◆ linear() [4/4]

template<typename TKey , typename TValue , typename TFactor >

TValue Ocean::InterpolationMap< TKey, TValue, TFactor >::linear	(	const ValueMap &	valueMap,
		const TKey &	key,
		const LinearInterpolationFunction	interpolationFunction
	)

static

Returns the linear interpolation of given values for a given key and a given interpolation function.

Parameters

valueMap	The map of values that are used for interpolation
key	The key of the value that will be (interpolated and) returned
interpolationFunction	An explicit interpolation function that is applied

Returns: Resulting interpolated value

◆ operator!=()

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::operator!= ( const InterpolationMap< TKey, TValue, TFactor > & object ) const

inline

Returns whether two interpolation objects are not equal.

Parameters

object Second interpoation object

Returns: True, if so

◆ operator=() [1/2]

template<typename TKey , typename TValue , typename TFactor >

InterpolationMap< TKey, TValue, TFactor > & Ocean::InterpolationMap< TKey, TValue, TFactor >::operator= ( const InterpolationMap< TKey, TValue, TFactor > & object )

inline

Assign operator.

Parameters

object The interpolation map object which will be assigned to this object

Returns: Reference to this object

◆ operator=() [2/2]

template<typename TKey , typename TValue , typename TFactor >

InterpolationMap< TKey, TValue, TFactor > & Ocean::InterpolationMap< TKey, TValue, TFactor >::operator= ( InterpolationMap< TKey, TValue, TFactor > && object )

inlinenoexcept

Move operator.

Parameters

object The interpolation map object which will be moved to this object

Returns: Reference to this object

◆ operator==()

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::operator== ( const InterpolationMap< TKey, TValue, TFactor > & object ) const

inline

Returns whether two interpolation objects are equal.

Parameters

object Second interpoation object

Returns: True, if so

◆ operator[]()

template<typename TKey , typename TValue , typename TFactor >

TValue & Ocean::InterpolationMap< TKey, TValue, TFactor >::operator[] ( const TKey & key )

inline

Returns the value of this interpolation map object defined by a corresponding key.

If no value exists for this key, the pair of key and value is inserted and the default value is returned.

Parameters

key	Key for that the value is returned

Returns: Value that corresponds to the specified key

See also: value(), hasValue().

◆ remove()

template<typename TKey , typename TValue , typename TFactor >

bool Ocean::InterpolationMap< TKey, TValue, TFactor >::remove ( const TKey & key )

inline

Removes an elements (pair of key and value) from this interpolation map object.

Parameters

key	The key of the element to be removed

Returns: True, if the element existed

◆ setInterpolationMap() [1/2]

template<typename TKey , typename TValue , typename TFactor >

void Ocean::InterpolationMap< TKey, TValue, TFactor >::setInterpolationMap ( const ValueMap & interpolationMap )

inline

Sets or changes the entire internal interpolation map.

Parameters

interpolationMap The interpolation map that will replace the current one

◆ setInterpolationMap() [2/2]

template<typename TKey , typename TValue , typename TFactor >

void Ocean::InterpolationMap< TKey, TValue, TFactor >::setInterpolationMap ( ValueMap && interpolationMap )

inline

Sets or changes the entire internal interpolation map.

Parameters

interpolationMap The interpolation map that will be moved to this object

◆ size()

template<typename TKey , typename TValue , typename TFactor >

size_t Ocean::InterpolationMap< TKey, TValue, TFactor >::size ( ) const

inline

Returns the number of elements (pairs of keys and values) of this interpolation map.

Returns: The number of stored elements

◆ value()

template<typename TKey , typename TValue , typename TFactor >

TValue & Ocean::InterpolationMap< TKey, TValue, TFactor >::value ( const TKey & key )

inline

Returns the value of this interpolation map object defined by a corresponding key.

If no value exists for this key, the pair of key and value is inserted and the default value is returned.

Parameters

key	Key for that the value is returned

Returns: Value that corresponds to the specified key

See also: hasValue().

Field Documentation

◆ interpolationValueMap

template<typename TKey , typename TValue , typename TFactor >

ValueMap Ocean::InterpolationMap< TKey, TValue, TFactor >::interpolationValueMap

protected

Map mapping keys to values.

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

Interpolation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ LinearInterpolationFunction

◆ ValueMap

Constructor & Destructor Documentation

◆ InterpolationMap() [1/5]

◆ InterpolationMap() [2/5]

◆ InterpolationMap() [3/5]

◆ InterpolationMap() [4/5]

◆ InterpolationMap() [5/5]

Member Function Documentation

◆ clear()

◆ hasValue()

◆ insert() [1/2]

◆ insert() [2/2]

◆ interpolationMap()

◆ isEmpty()

◆ linear() [1/4]

◆ linear() [2/4]

◆ linear() [3/4]

◆ linear() [4/4]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ remove()

◆ setInterpolationMap() [1/2]

◆ setInterpolationMap() [2/2]

◆ size()

◆ value()

Field Documentation

◆ interpolationValueMap