Acts::cyclic_parameter< T, MIN, MAX > Struct Template Reference

type for parameter with cyclic value range More...

#include <acts/blob/master/Core/include/Acts/Utilities/ParameterTypes.hpp>

Static Public Member Functions
template<typename U >
static U	getValue (const U &input)
	retrieve value for constrained cyclic parameter value ranges
template<typename U >
static U	getDifference (const U &first, const U &second)

Static Public Attributes
static constexpr bool	may_modify_value
	parameter values may need adjustment
static constexpr T	min {MIN()}
	lower bound of range
static constexpr T	max {MAX()}
	upper bound of range

Detailed Description

template<typename T, T(*)() MIN, T(*)() MAX>
struct Acts::cyclic_parameter< T, MIN, MAX >

type for parameter with cyclic value range

This parameter type is useful to e.g. describe angles.

Template Parameters

T	type for boundary value (usually double)
MIN	pointer to a constexpr function returning the lower bound of the value range
MAX	pointer to a constexpr function returning the upper bound of the value range

Definition at line 97 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 97 of file ParameterTypes.hpp

Member Function Documentation

template<typename T , T(*)() MIN, T(*)() MAX>

template<typename U >

static U Acts::cyclic_parameter< T, MIN, MAX >::getDifference ( const U &  first, const U &  second  )

inlinestatic

Definition at line 124 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 124 of file ParameterTypes.hpp

References Acts::cyclic_parameter< T, MIN, MAX >::getValue(), Acts::cyclic_parameter< T, MIN, MAX >::max, Acts::cyclic_parameter< T, MIN, MAX >::min, and tmp.

Here is the call graph for this function:

template<typename T , T(*)() MIN, T(*)() MAX>

template<typename U >

static U Acts::cyclic_parameter< T, MIN, MAX >::getValue ( const U &  input )

inlinestatic

retrieve value for constrained cyclic parameter value ranges

Template Parameters

U	type of the input parameter

Parameters

input

input parameter value

Returns

parameter value in the range [bound_parameter<U,MIN,MAX>::min, bound_parameter<U,MIN,MAX>::max] taking into account the cycle of this parameter type.

Definition at line 115 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 115 of file ParameterTypes.hpp

References Acts::cyclic_parameter< T, MIN, MAX >::max, and Acts::cyclic_parameter< T, MIN, MAX >::min.

Referenced by Acts::cyclic_parameter< T, MIN, MAX >::getDifference().

Here is the caller graph for this function:

Member Data Documentation

template<typename T , T(*)() MIN, T(*)() MAX>

constexpr T Acts::cyclic_parameter< T, MIN, MAX >::max {MAX()}

static

upper bound of range

Definition at line 101 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 101 of file ParameterTypes.hpp

Referenced by Acts::cyclic_parameter< T, MIN, MAX >::getDifference(), and Acts::cyclic_parameter< T, MIN, MAX >::getValue().

template<typename T , T(*)() MIN, T(*)() MAX>

constexpr bool Acts::cyclic_parameter< T, MIN, MAX >::may_modify_value

static

Initial value:

{
      true}

parameter values may need adjustment

Definition at line 98 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 98 of file ParameterTypes.hpp

template<typename T , T(*)() MIN, T(*)() MAX>

constexpr T Acts::cyclic_parameter< T, MIN, MAX >::min {MIN()}

static

lower bound of range

Definition at line 100 of file ParameterTypes.hpp.

View newest version in sPHENIX GitHub at line 100 of file ParameterTypes.hpp

Referenced by Acts::cyclic_parameter< T, MIN, MAX >::getDifference(), and Acts::cyclic_parameter< T, MIN, MAX >::getValue().

---

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

• acts/blob/master/Core/include/Acts/Utilities/ParameterTypes.hpp