Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::detail::RestrictedParameterTraits< 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 within the limits.
 
template<typename value_t >
static constexpr value_t getDifference (const value_t &lhs, const value_t &rhs)
 Compute the difference between two values with limit handling.
 

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::RestrictedParameterTraits< limits_t >

Traits class for a parameter with a restricted value range.

Template Parameters
limits_ta type with static lowest() and max() member functions

This parameter type could be useful to describe parameter with physical meaningful bounds (e.g. radius).

Definition at line 45 of file ParameterTraits.hpp.

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

Member Function Documentation

template<typename limits_t >
template<typename value_t >
static constexpr value_t Acts::detail::RestrictedParameterTraits< limits_t >::getDifference ( const value_t &  lhs,
const value_t &  rhs 
)
inlinestatic

Compute the difference between two values with limit handling.

Definition at line 61 of file ParameterTraits.hpp.

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

References Acts::detail::RestrictedParameterTraits< limits_t >::getValue().

+ Here is the call graph for this function:

template<typename limits_t >
template<typename value_t >
static constexpr value_t Acts::detail::RestrictedParameterTraits< limits_t >::getValue ( const value_t &  value)
inlinestatic

Get the corrected value within the limits.

Definition at line 55 of file ParameterTraits.hpp.

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

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

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

+ Here is the caller graph for this function:

Member Data Documentation

template<typename limits_t >
constexpr double Acts::detail::RestrictedParameterTraits< limits_t >::max = limits_t::max()
static

Upper bound of range.

Definition at line 51 of file ParameterTraits.hpp.

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

Referenced by Acts::detail::RestrictedParameterTraits< limits_t >::getValue().

template<typename limits_t >
constexpr bool Acts::detail::RestrictedParameterTraits< limits_t >::may_modify_value = true
static

Parameter values may need adjustment.

Definition at line 47 of file ParameterTraits.hpp.

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

template<typename limits_t >
constexpr double Acts::detail::RestrictedParameterTraits< limits_t >::min = limits_t::lowest()
static

Lower bound of range.

Definition at line 49 of file ParameterTraits.hpp.

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

Referenced by Acts::detail::RestrictedParameterTraits< limits_t >::getValue().


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