Acts::detail::CyclicParameterTraits< limits_t > Struct Template Reference

#include <acts/blob/sPHENIX/Core/include/Acts/EventData/detail/ParameterTraits.hpp>

Static Public Member Functions
template<typename value_t >
static constexpr value_t	getValue (const value_t &value)
	Get the corrected value folded into the central range.
template<typename value_t >
static constexpr value_t	getDifference (const value_t &lhs, const value_t &rhs)
	Compute the smallest equivalent difference when using the periodicity.

Static Public Attributes
static constexpr bool	may_modify_value = true
	Parameter values may need adjustment.
static constexpr double	min = limits_t::lowest()
	Lower bound of range.
static constexpr double	max = limits_t::max()
	Upper bound of range.

Detailed Description

template<typename limits_t>
struct Acts::detail::CyclicParameterTraits< limits_t >

Traits class for a parameter with a cyclic value range.

Template Parameters

limits_t

a type with static lowest() and max() member functions

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

Definition at line 72 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 72 of file ParameterTraits.hpp

Member Function Documentation

template<typename limits_t >

template<typename value_t >

static constexpr value_t Acts::detail::CyclicParameterTraits< limits_t >::getDifference ( const value_t &  lhs, const value_t &  rhs  )

inlinestatic

Compute the smallest equivalent difference when using the periodicity.

Definition at line 91 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 91 of file ParameterTraits.hpp

References Acts::Test::delta, Acts::detail::CyclicParameterTraits< limits_t >::getValue(), Acts::detail::CyclicParameterTraits< limits_t >::max, and Acts::detail::CyclicParameterTraits< limits_t >::min.

Here is the call graph for this function:

template<typename limits_t >

template<typename value_t >

static constexpr value_t Acts::detail::CyclicParameterTraits< limits_t >::getValue ( const value_t &  value )

inlinestatic

Get the corrected value folded into the central range.

Definition at line 82 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 82 of file ParameterTraits.hpp

References Acts::detail::CyclicParameterTraits< limits_t >::max, Acts::detail::CyclicParameterTraits< limits_t >::min, and value.

Referenced by Acts::detail::CyclicParameterTraits< limits_t >::getDifference().

Here is the caller graph for this function:

Member Data Documentation

template<typename limits_t >

constexpr double Acts::detail::CyclicParameterTraits< limits_t >::max = limits_t::max()

static

Upper bound of range.

Definition at line 78 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 78 of file ParameterTraits.hpp

Referenced by Acts::detail::CyclicParameterTraits< limits_t >::getDifference(), and Acts::detail::CyclicParameterTraits< limits_t >::getValue().

template<typename limits_t >

constexpr bool Acts::detail::CyclicParameterTraits< limits_t >::may_modify_value = true

static

Parameter values may need adjustment.

Definition at line 74 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 74 of file ParameterTraits.hpp

template<typename limits_t >

constexpr double Acts::detail::CyclicParameterTraits< limits_t >::min = limits_t::lowest()

static

Lower bound of range.

Definition at line 76 of file ParameterTraits.hpp.

View newest version in sPHENIX GitHub at line 76 of file ParameterTraits.hpp

Referenced by Acts::detail::CyclicParameterTraits< limits_t >::getDifference(), and Acts::detail::CyclicParameterTraits< limits_t >::getValue().

---

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

• acts/blob/sPHENIX/Core/include/Acts/EventData/detail/ParameterTraits.hpp