LArSoft  v10_06_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Types | Public Member Functions | Private Types | List of all members
cluster::details::Measure_t< T > Class Template Reference

Type for a simple measurement: value and error. More...

#include "ClusterParamsAlgBase.h"

Inheritance diagram for cluster::details::Measure_t< T >:

Public Types

using Data_t = T
 

Public Member Functions

 Measure_t ()
 Default constructor: initializes to 0. More...
 
 Measure_t (Data_t value)
 Constructor: initializes to the specified value, error is 0. More...
 
 Measure_t (Data_t value, Data_t error)
 Constructor: initializes to the specified value and error. More...
 
Data_t value () const
 
Data_t & value ()
 
Data_t error () const
 
Data_t & error ()
 

Private Types

using Base_t = std::pair< T, T >
 

Detailed Description

template<typename T>
class cluster::details::Measure_t< T >

Type for a simple measurement: value and error.

Definition at line 39 of file ClusterParamsAlgBase.h.

Member Typedef Documentation

template<typename T>
using cluster::details::Measure_t< T >::Base_t = std::pair<T, T>
private

Definition at line 40 of file ClusterParamsAlgBase.h.

template<typename T>
using cluster::details::Measure_t< T >::Data_t = T

Definition at line 43 of file ClusterParamsAlgBase.h.

Constructor & Destructor Documentation

template<typename T>
cluster::details::Measure_t< T >::Measure_t ( )
inline

Default constructor: initializes to 0.

Definition at line 46 of file ClusterParamsAlgBase.h.

46 : Base_t(Data_t(0), Data_t(0)) {}
cluster::details::Measure_t::Base_t
std::pair< T, T > Base_t
Definition: ClusterParamsAlgBase.h:40
cluster::details::Measure_t::Data_t
T Data_t
Definition: ClusterParamsAlgBase.h:43
template<typename T>
cluster::details::Measure_t< T >::Measure_t ( Data_t  value)
inline

Constructor: initializes to the specified value, error is 0.

Definition at line 49 of file ClusterParamsAlgBase.h.

49 : Base_t(value, Data_t(0)) {}
cluster::details::Measure_t::Base_t
std::pair< T, T > Base_t
Definition: ClusterParamsAlgBase.h:40
cluster::details::Measure_t::Data_t
T Data_t
Definition: ClusterParamsAlgBase.h:43
cluster::details::Measure_t::value
Data_t value() const
Definition: ClusterParamsAlgBase.h:54
template<typename T>
cluster::details::Measure_t< T >::Measure_t ( Data_t  value,
Data_t  error 
)
inline

Constructor: initializes to the specified value and error.

Definition at line 52 of file ClusterParamsAlgBase.h.

52 : Base_t(value, error) {}
cluster::details::Measure_t::error
Data_t error() const
Definition: ClusterParamsAlgBase.h:57
cluster::details::Measure_t::Base_t
std::pair< T, T > Base_t
Definition: ClusterParamsAlgBase.h:40
cluster::details::Measure_t::value
Data_t value() const
Definition: ClusterParamsAlgBase.h:54

Member Function Documentation

template<typename T>
Data_t cluster::details::Measure_t< T >::error ( ) const
inline

Definition at line 57 of file ClusterParamsAlgBase.h.

57 { return Base_t::second; }
util::quantities::second
second_as<> second
Type of time stored in seconds, in double precision.
Definition: spacetime.h:82
template<typename T>
Data_t& cluster::details::Measure_t< T >::error ( )
inline

Definition at line 58 of file ClusterParamsAlgBase.h.

58 { return Base_t::second; }
util::quantities::second
second_as<> second
Type of time stored in seconds, in double precision.
Definition: spacetime.h:82
template<typename T>
Data_t cluster::details::Measure_t< T >::value ( ) const
inline

Definition at line 54 of file ClusterParamsAlgBase.h.

Referenced by cluster::ClusterMergeHelper::AppendResult(), and cluster::ClusterCreator::CreateCluster().

54 { return Base_t::first; }
template<typename T>
Data_t& cluster::details::Measure_t< T >::value ( )
inline

Definition at line 55 of file ClusterParamsAlgBase.h.

55 { return Base_t::first; }
The documentation for this class was generated from the following file: