yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis 2.1.0
Public Types | List of all members
YODA::Estimate0D Class Reference

An estimate in 0D. More...

#include <Estimate0D.h>

Inheritance diagram for YODA::Estimate0D:
YODA::Estimate YODA::AnalysisObject

Public Types

using Ptr = std::shared_ptr< Estimate0D >
 
using BaseT = Estimate
 
- Public Types inherited from YODA::AnalysisObject
typedef std::map< std::string, std::string > Annotations
 Collection type for annotations, as a string-string map.
 

Public Member Functions

Constructors
 Estimate0D (const std::string &path="", const std::string &title="")
 Nullary constructor for unique pointers etc.
 
 Estimate0D (double v, std::map< std::string, std::pair< double, double > > &errors, const std::string &path="", const std::string &title="")
 Constructor to set an Estimate0D with a pre-filled state.
 
 Estimate0D (const double v, const std::pair< double, double > &e, const std::string &source="", const std::string &path="", const std::string &title="")
 Alternative constructor to set an Estimate0D with value and uncertainty.
 
 Estimate0D (const Estimate0D &other)
 Copy constructor (needed for clone functions).
 
 Estimate0D (Estimate0D &&other)
 Move constructor.
 
 Estimate0D (const BaseT &other, const std::string &path="", const std::string &title="")
 Copy constructor using base class.
 
 Estimate0D (BaseT &&other, const std::string &path="", const std::string &title="")
 Move constructor using base class.
 
Estimate0D clone () const noexcept
 Make a copy on the stack.
 
Estimate0D * newclone () const noexcept
 Make a copy on the heap.
 
Operators
Estimate0D & operator= (const Estimate0D &toCopy) noexcept
 
Estimate0D & operator= (Estimate0D &&toMove) noexcept
 Move assignment.
 
Estimate0D & add (const Estimate0D &toAdd, const std::string &pat_uncorr="^stat|^uncor")
 Add two Estimate0Ds.
 
Estimate0D & operator+= (const Estimate0D &toAdd)
 
Estimate0D & add (Estimate0D &&toAdd, const std::string &pat_uncorr="^stat|^uncor")
 Add two (rvalue) Estimate0Ds.
 
Estimate0D & operator+= (Estimate0D &&toAdd)
 
Estimate0D & subtract (const Estimate0D &toSubtract, const std::string &pat_uncorr="^stat|^uncor")
 Subtract two Estimate0Ds.
 
Estimate0D & operator-= (const Estimate0D &toSubtract)
 
Estimate0D & subtract (Estimate0D &&toSubtract, const std::string &pat_uncorr="^stat|^uncor")
 Subtract two (rvalue) Estimate0Ds.
 
Estimate0D & operator-= (Estimate0D &&toSubtract)
 
Dimensions
size_t dim () const noexcept
 Total dimension of this data object.
 
Modifiers
void reset () noexcept
 Reset the internal values.
 
MPI (de-)serialisation
size_t lengthContent (bool fixed_length=false) const noexcept
 Length of serialized content vector for MPI reduce operations.
 
std::vector< double > serializeContent (bool fixed_length=false) const noexcept
 Content serialisation for MPI reduce operations.
 
void deserializeContent (const std::vector< double > &data)
 Content deserialisation for MPI reduce operations.
 
Type reductions
Scatter1D mkScatter (const std::string &path="", const std::string &pat_match="") const noexcept
 
AnalysisObject * mkInert (const std::string &path="", const std::string &source="") const noexcept
 Method returns clone of the estimate with streamlined error source.
 
- Public Member Functions inherited from YODA::Estimate
 Estimate ()
 Default constructor of a new distribution.
 
 Estimate (double v, std::map< std::string, std::pair< double, double > > &errors)
 Constructor to set an Estimate with a pre-filled state.
 
 Estimate (const double v, const std::pair< double, double > &e, const std::string &source="")
 Alternative constructor to set an Estimate with value and uncertainty.
 
 Estimate (const Estimate &toCopy)
 
 Estimate (Estimate &&toMove)
 
Estimate & operator= (const Estimate &toCopy) noexcept
 
Estimate & operator= (Estimate &&toMove) noexcept
 
Estimate & add (const Estimate &toAdd, const std::string &pat_uncorr="^stat|^uncor")
 Add two Estimates.
 
Estimate & operator+= (const Estimate &toAdd)
 
Estimate & subtract (const Estimate &toSubtract, const std::string &pat_uncorr="^stat|^uncor")
 Subtract one Estimate from another.
 
Estimate & operator-= (const Estimate &toSubtract)
 
void setValue (const double value) noexcept
 Set the central value of this estimator.
 
void setVal (const double val) noexcept
 Alias for setValue.
 
void setErr (const std::pair< double, double > &err, const std::string &source="")
 Set a signed uncertainty component.
 
void setErr (const double err, const std::string &source="")
 Set a symmetric uncertainty component.
 
void set (const double val, const std::pair< double, double > &err, const std::string source="")
 Set both central value and uncertainty component.
 
void set (const double val, const double err, const std::string &source="")
 Set both central value and uncertainty component.
 
void reset () noexcept
 Reset the internal values.
 
void scale (const double scalefactor) noexcept
 Rescale as if value and uncertainty had been different by factor scalefactor.
 
void scale (const Trf< 1 > &trf)
 Generalised transformations with functors.
 
void transform (const Trf< 1 > &trf)
 Generalised transformations with functors.
 
void renameSource (const std::string &old_label, const std::string &new_label)
 Replace a source label in the error breakdown.
 
void rmSource (const std::string &source)
 
void rmErrs ()
 
double val () const noexcept
 The central value.
 
std::pair< double, double > errDownUp (const std::string &source="") const
 The signed absolute error on the central value.
 
std::pair< double, double > err (const std::string &source="") const
 Convenience alias for errorDownUp(source)
 
std::pair< double, double > errNegPos (std::string source="") const
 The signed negative and positive uncertainty component.
 
double errNeg (const std::string &source="") const
 The signed negative uncertainty component.
 
double errPos (const std::string &source="") const
 The signed positive uncertainty component.
 
double errDown (const std::string &source="") const
 The signed error due to the systematic downward variation.
 
double errUp (const std::string &source="") const
 The signed error due to the systematic upward variation.
 
double errAvg (const std::string &source="") const
 The unsigned error from an average of the downwards/upwards shifts.
 
double errEnv (const std::string &source="") const
 The unsigned symmetrised error from the largest component of the downwards/upwards shifts.
 
std::pair< double, double > relErrDownUp (const std::string &source="") const
 The relative signed error pair with respect to the central value.
 
std::pair< double, double > relErr (const std::string &source="") const
 Convenience alias for relErrDownUp.
 
double relErrDown (const std::string &source="") const
 The relative negative error with respect to the central value.
 
double relErrUp (const std::string &source="") const
 The relative positive error with respect to the central value.
 
double relErrAvg (const std::string &source="") const
 The relative uncertainty from an average of the downward/upward shifts with respect to the central value.
 
double relErrEnv (const std::string &source="") const
 The relative unsigned symmetrised error from the largest component of the downwards/upwards shifts with respect to the central value.
 
double valMax (const std::string &source="") const
 The maximal shift of the central value according to systematic variation source.
 
double valMin (const std::string &source="") const
 The minimal shift of the central value according to systematic variation source.
 
std::pair< double, double > quadSum (const std::string &pat_match="") const noexcept
 The quadrature sum of uncertainty components.
 
double quadSumNeg (const std::string &pat_match="") const noexcept
 The negative component of the quad-sum-based total uncertainty components.
 
double quadSumPos (const std::string &pat_match="") const noexcept
 The positive component of the quad-sum-based total uncertainty components.
 
double quadSumAvg (const std::string &pat_match="") const noexcept
 The unsigned average of the two quad-sum-based total uncertainty components.
 
double quadSumEnv (const std::string &pat_match="") const noexcept
 The unsigned symmetrised uncertainty from the largest of the quad-sum-based total uncertainty components.
 
double quadSumMax (const std::string &pat_match="") const
 The maximal shift of the central value from the quad-sum-based total uncertainty components.
 
double quadSumMin (const std::string &pat_match="") const
 The minimal shift of the central value from the quad-sum-based total uncertainty components.
 
std::pair< double, double > totalErr (const std::string &pat_match="") const noexcept
 The total uncertainty.
 
double totalErrNeg (const std::string &pat_match="") const noexcept
 The negative total uncertainty.
 
double totalErrPos (const std::string &pat_match="") const noexcept
 The positive total uncertainty.
 
double totalErrAvg (const std::string &pat_match="") const
 The average of the total downward/upward uncertainty shifts, which are taken to be the signed quadrature sums of the error sources.
 
double totalErrEnv (const std::string &pat_match="") const
 The unsigned symmetrised uncertainty from the largest of the downward/upward shifts of the quad-sum-based total uncertainty.
 
double totalErrMax (const std::string &pat_match="") const
 The maximal shift of the central value from the total uncertainty components.
 
double totalErrMin (const std::string &pat_match="") const
 The minimal shift of the central value from the total uncertainty components.
 
double valueErr (const std::string &pat_match="") const
 The unsigned average total uncertainty.
 
std::pair< double, double > relTotalErr (const std::string &pat_match="") const noexcept
 The relative negative/positive total uncertainty with respect to the central value.
 
double relTotalErrNeg (const std::string &pat_match="") const noexcept
 The relative negative total uncertainty on the central value.
 
double relTotalErrPos (const std::string &pat_match="") const noexcept
 The relative positive total uncertainty on the central value.
 
double relTotalErrAvg (const std::string &pat_match="") const noexcept
 The relative average of the quad-sum-based total downward/upward uncertainty components.
 
double relTotalErrEnv (const std::string &pat_match="") const noexcept
 The unsigned symmetrised error from the largest downward/upward components of the relative total quad-sum-based uncertainty.
 
std::vector< std::string > sources () const noexcept
 The list of error source names.
 
bool hasSource (const std::string &key) const noexcept
 Returns true/false if the error map contains key.
 
size_t numErrs () const noexcept
 The number of error sources in the error map.
 
std::vector< std::string > serializeSources () const noexcept
 
void deserializeSources (const std::vector< std::string > &data)
 
- Public Member Functions inherited from YODA::AnalysisObject
 AnalysisObject ()
 Default constructor.
 
 AnalysisObject (const std::string &type, const std::string &path, const std::string &title="")
 Constructor giving a type, a path and an optional title.
 
 AnalysisObject (const std::string &type, const std::string &path, const AnalysisObject &ao, const std::string &title="")
 Constructor giving a type, a path, another AO to copy annotation from, and an optional title.
 
virtual ~AnalysisObject ()
 Default destructor.
 
virtual AnalysisObject & operator= (const AnalysisObject &ao) noexcept
 Default copy assignment operator.
 
std::vector< std::string > annotations () const
 
bool hasAnnotation (const std::string &name) const
 Check if an annotation is defined.
 
const std::string & annotation (const std::string &name) const
 Get an annotation by name (as a string)
 
const std::string & annotation (const std::string &name, const std::string &defaultreturn) const
 Get an annotation by name (as a string) with a default in case the annotation is not found.
 
template<typename T >
const T annotation (const std::string &name) const
 Get an annotation by name (copied to another type)
 
template<typename T >
const T annotation (const std::string &name, const T &defaultreturn) const
 Get an annotation by name (copied to another type) with a default in case the annotation is not found.
 
template<typename T >
void setAnnotation (const std::string &name, const T &value)
 Add or set an annotation by name (templated for remaining types)
 
void setAnnotations (const Annotations &anns)
 Set all annotations at once.
 
template<typename T >
void addAnnotation (const std::string &name, const T &value)
 Add or set an annotation by name.
 
void rmAnnotation (const std::string &name)
 Delete an annotation by name.
 
void clearAnnotations ()
 Delete an annotation by name.
 
const std::string title () const
 Get the AO title.
 
void setTitle (const std::string &title)
 Set the AO title.
 
const std::string path () const
 Get the AO path.
 
void setPath (const std::string &path)
 
const std::string name () const
 
virtual std::string type () const
 Get name of the analysis object type.
 
size_t lengthMeta (const bool skipPath=true, const bool skipTitle=true) const noexcept
 Length of serialized meta-data vector for MPI reduce operations.
 
std::vector< std::string > serializeMeta (const bool skipPath=true, const bool skipTitle=true) const noexcept
 Meta-data serialisation for MPI reduce operations.
 
virtual void deserializeMeta (const std::vector< std::string > &data, const bool resetPath=false, const bool resetTitle=false)
 Mate-data deserialisation for MPI reduce operations.
 

Detailed Description

An estimate in 0D.

This class linkes the Estimate class with AnalysisObject, so it can be used as a type reduction for the Counter type.

Definition at line 27 of file Estimate0D.h.

Member Typedef Documentation

◆ BaseT

using YODA::Estimate0D::BaseT = Estimate

Definition at line 32 of file Estimate0D.h.

◆ Ptr

using YODA::Estimate0D::Ptr = std::shared_ptr<Estimate0D>

Definition at line 31 of file Estimate0D.h.

Constructor & Destructor Documentation

◆ Estimate0D() [1/7]

YODA::Estimate0D::Estimate0D ( const std::string &  path = "",
const std::string &  title = "" 
)
inline

Nullary constructor for unique pointers etc.

Note
The setting of optional path/title is not possible here in order to avoid overload ambiguity for brace-initialised constructors.

Definition at line 45 of file Estimate0D.h.

46 : BaseT(), AnalysisObject("Estimate0D", path, title) { }
YODA::AnalysisObject::title
const std::string title() const
Get the AO title.
Definition AnalysisObject.h:233
YODA::AnalysisObject::path
const std::string path() const
Get the AO path.
Definition AnalysisObject.h:246
YODA::AnalysisObject::AnalysisObject
AnalysisObject()
Default constructor.
Definition AnalysisObject.h:38

◆ Estimate0D() [2/7]

YODA::Estimate0D::Estimate0D ( double  v,
std::map< std::string, std::pair< double, double > > &  errors,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Constructor to set an Estimate0D with a pre-filled state.

Principally designed for internal persistency use.

Definition at line 52 of file Estimate0D.h.

55 : BaseT(v, errors), AnalysisObject("Estimate0D", path, title) { }

◆ Estimate0D() [3/7]

YODA::Estimate0D::Estimate0D ( const double  v,
const std::pair< double, double > &  e,
const std::string &  source = "",
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Alternative constructor to set an Estimate0D with value and uncertainty.

Definition at line 59 of file Estimate0D.h.

61 : BaseT(v, e, source), AnalysisObject("Estimate0D", path, title) { }

◆ Estimate0D() [4/7]

YODA::Estimate0D::Estimate0D ( const Estimate0D &  other)
inline

Copy constructor (needed for clone functions).

Note
Compiler won't generate this constructor automatically.

Definition at line 66 of file Estimate0D.h.

66 : Estimate(other),
67 AnalysisObject(other.type(), other.path(), other, other.title()) { }
YODA::Estimate::Estimate
Estimate()
Default constructor of a new distribution.
Definition Estimate.h:36

◆ Estimate0D() [5/7]

YODA::Estimate0D::Estimate0D ( Estimate0D &&  other)
inline

Move constructor.

Definition at line 70 of file Estimate0D.h.

70 : BaseT(std::move(other)),
71 AnalysisObject(other.type(), other.path(), other, other.title()) { }

◆ Estimate0D() [6/7]

YODA::Estimate0D::Estimate0D ( const BaseT &  other,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Copy constructor using base class.

Definition at line 74 of file Estimate0D.h.

75 : BaseT(other), AnalysisObject("Estimate0D", path, title) { }

◆ Estimate0D() [7/7]

YODA::Estimate0D::Estimate0D ( BaseT &&  other,
const std::string &  path = "",
const std::string &  title = "" 
)
inline

Move constructor using base class.

Definition at line 78 of file Estimate0D.h.

79 : BaseT(std::move(other)), AnalysisObject("Estimate0D", path, title) { }

Member Function Documentation

◆ add() [1/2]

Estimate0D & YODA::Estimate0D::add ( const Estimate0D &  toAdd,
const std::string &  pat_uncorr = "^stat|^uncor" 
)
inline

Add two Estimate0Ds.

Definition at line 118 of file Estimate0D.h.

118 {
119 if (hasAnnotation("ScaledBy")) rmAnnotation("ScaledBy");
120 BaseT::add(toAdd, pat_uncorr);
121 return *this;
122 }
YODA::AnalysisObject::rmAnnotation
void rmAnnotation(const std::string &name)
Delete an annotation by name.
Definition AnalysisObject.h:214
YODA::AnalysisObject::hasAnnotation
bool hasAnnotation(const std::string &name) const
Check if an annotation is defined.
Definition AnalysisObject.h:132
YODA::Estimate::add
Estimate & add(const Estimate &toAdd, const std::string &pat_uncorr="^stat|^uncor")
Add two Estimates.
Definition Estimate.h:95

References YODA::Estimate::add(), YODA::AnalysisObject::hasAnnotation(), and YODA::AnalysisObject::rmAnnotation().

Referenced by operator+=(), and operator+=().

◆ add() [2/2]

Estimate0D & YODA::Estimate0D::add ( Estimate0D &&  toAdd,
const std::string &  pat_uncorr = "^stat|^uncor" 
)
inline

Add two (rvalue) Estimate0Ds.

Definition at line 129 of file Estimate0D.h.

129 {
130 if (hasAnnotation("ScaledBy")) rmAnnotation("ScaledBy");
131 BaseT::add(std::move(toAdd), pat_uncorr);
132 return *this;
133 }

References YODA::Estimate::add(), YODA::AnalysisObject::hasAnnotation(), and YODA::AnalysisObject::rmAnnotation().

◆ clone()

Estimate0D YODA::Estimate0D::clone ( ) const
inlinenoexcept

Make a copy on the stack.

Definition at line 82 of file Estimate0D.h.

82 {
83 return Estimate0D(*this);
84 }
YODA::Estimate0D::Estimate0D
Estimate0D(const std::string &path="", const std::string &title="")
Nullary constructor for unique pointers etc.
Definition Estimate0D.h:45

◆ deserializeContent()

void YODA::Estimate0D::deserializeContent ( const std::vector< double > &  data)
inlinevirtual

Content deserialisation for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 283 of file Estimate0D.h.

283 {
284 BaseT::_deserializeContent(data, data.size() == 4);
285 }

◆ dim()

size_t YODA::Estimate0D::dim ( ) const
inlinevirtualnoexcept

Total dimension of this data object.

Implements YODA::AnalysisObject.

Definition at line 166 of file Estimate0D.h.

166{ return 1; }

◆ lengthContent()

size_t YODA::Estimate0D::lengthContent ( bool  fixed_length = false) const
inlinevirtualnoexcept

Length of serialized content vector for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 275 of file Estimate0D.h.

275 {
276 return BaseT::_lengthContent(fixed_length);
277 }

◆ mkInert()

AnalysisObject * YODA::Estimate0D::mkInert ( const std::string &  path = "",
const std::string &  source = "" 
) const
inlinevirtualnoexcept

Method returns clone of the estimate with streamlined error source.

Reimplemented from YODA::AnalysisObject.

Definition at line 308 of file Estimate0D.h.

309 {
310 Estimate0D* rtn = newclone();
311 rtn->setPath(path);
312 if (rtn->numErrs() == 1) {
313 try {
314 rtn->renameSource("", source);
315 }
316 catch (YODA::UserError& e) { }
317 }
318 return rtn;
319 }
YODA::Estimate0D::newclone
Estimate0D * newclone() const noexcept
Make a copy on the heap.
Definition Estimate0D.h:87
YODA::UserError
Error for problems introduced outside YODA, to put it nicely.
Definition Exceptions.h:86

References newclone(), YODA::Estimate::numErrs(), YODA::AnalysisObject::path(), YODA::Estimate::renameSource(), and YODA::AnalysisObject::setPath().

◆ mkScatter()

Scatter1D YODA::Estimate0D::mkScatter ( const std::string &  path = "",
const std::string &  pat_match = "" 
) const
inlinenoexcept

Definition at line 292 of file Estimate0D.h.

293 {
294 Scatter1D rtn;
295 for (const std::string& a : annotations()) {
296 if (a != "Type") rtn.setAnnotation(a, annotation(a));
297 }
298 rtn.setAnnotation("Path", path);
299
300 // Add the PointND
301 const double tot = fabs(totalErrPos(pat_match)); // use positive error component
302 rtn.addPoint( Point1D(val(), {tot, tot}) );
303
304 return rtn;
305 }
YODA::AnalysisObject::annotations
std::vector< std::string > annotations() const
Definition AnalysisObject.h:123
YODA::AnalysisObject::annotation
const std::string & annotation(const std::string &name) const
Get an annotation by name (as a string)
Definition AnalysisObject.h:138
YODA::Estimate::totalErrPos
double totalErrPos(const std::string &pat_match="") const noexcept
The positive total uncertainty.
Definition Estimate.h:423
YODA::Estimate::val
double val() const noexcept
The central value.
Definition Estimate.h:249
YODA::Point1D
PointND< 1 > Point1D
User-familiar alias.
Definition Point.h:714
YODA::Scatter1D
ScatterND< 1 > Scatter1D
Definition Scatter.h:901

References YODA::ScatterND< N >::addPoint(), YODA::AnalysisObject::annotation(), YODA::AnalysisObject::annotations(), YODA::AnalysisObject::path(), YODA::AnalysisObject::setAnnotation(), YODA::Estimate::totalErrPos(), and YODA::Estimate::val().

◆ newclone()

Estimate0D * YODA::Estimate0D::newclone ( ) const
inlinevirtualnoexcept

Make a copy on the heap.

Implements YODA::AnalysisObject.

Definition at line 87 of file Estimate0D.h.

87 {
88 return new Estimate0D(*this);
89 }

Referenced by YODA::Counter::mkInert(), and mkInert().

◆ operator+=() [1/2]

Estimate0D & YODA::Estimate0D::operator+= ( const Estimate0D &  toAdd)
inline

Definition at line 124 of file Estimate0D.h.

124 {
125 return add(toAdd);
126 }
YODA::Estimate0D::add
Estimate0D & add(const Estimate0D &toAdd, const std::string &pat_uncorr="^stat|^uncor")
Add two Estimate0Ds.
Definition Estimate0D.h:118

References add().

◆ operator+=() [2/2]

Estimate0D & YODA::Estimate0D::operator+= ( Estimate0D &&  toAdd)
inline

Definition at line 135 of file Estimate0D.h.

135 {
136 return add(std::move(toAdd));
137 }

References add().

◆ operator-=() [1/2]

Estimate0D & YODA::Estimate0D::operator-= ( const Estimate0D &  toSubtract)
inline

Definition at line 146 of file Estimate0D.h.

146 {
147 return subtract(toSubtract);
148 }
YODA::Estimate0D::subtract
Estimate0D & subtract(const Estimate0D &toSubtract, const std::string &pat_uncorr="^stat|^uncor")
Subtract two Estimate0Ds.
Definition Estimate0D.h:140

References subtract().

◆ operator-=() [2/2]

Estimate0D & YODA::Estimate0D::operator-= ( Estimate0D &&  toSubtract)
inline

Definition at line 156 of file Estimate0D.h.

156 {
157 return subtract(std::move(toSubtract));
158 }

References subtract().

◆ operator=() [1/2]

Estimate0D & YODA::Estimate0D::operator= ( const Estimate0D &  toCopy)
inlinenoexcept

Copy assignment

Sets all the parameters using the ones provided from an existing Estimate0D.

Definition at line 100 of file Estimate0D.h.

100 {
101 if (this != &toCopy) {
102 AnalysisObject::operator = (toCopy);
103 BaseT::operator = (toCopy);
104 }
105 return *this;
106 }
YODA::AnalysisObject::operator=
virtual AnalysisObject & operator=(const AnalysisObject &ao) noexcept
Default copy assignment operator.
Definition AnalysisObject.h:66
YODA::Estimate::operator=
Estimate & operator=(const Estimate &toCopy) noexcept
Definition Estimate.h:69

References YODA::AnalysisObject::operator=(), and YODA::Estimate::operator=().

◆ operator=() [2/2]

Estimate0D & YODA::Estimate0D::operator= ( Estimate0D &&  toMove)
inlinenoexcept

Move assignment.

Definition at line 109 of file Estimate0D.h.

109 {
110 if (this != &toMove) {
111 AnalysisObject::operator = (toMove);
112 BaseT::operator = (std::move(toMove));
113 }
114 return *this;
115 }

References YODA::AnalysisObject::operator=(), and YODA::Estimate::operator=().

◆ reset()

void YODA::Estimate0D::reset ( )
inlinevirtualnoexcept

Reset the internal values.

Implements YODA::AnalysisObject.

Definition at line 174 of file Estimate0D.h.

174 {
175 BaseT::reset();
176 }
YODA::Estimate::reset
void reset() noexcept
Reset the internal values.
Definition Estimate.h:194

References YODA::Estimate::reset().

◆ serializeContent()

std::vector< double > YODA::Estimate0D::serializeContent ( bool  fixed_length = false) const
inlinevirtualnoexcept

Content serialisation for MPI reduce operations.

Implements YODA::AnalysisObject.

Definition at line 279 of file Estimate0D.h.

279 {
280 return BaseT::_serializeContent(fixed_length);
281 }

◆ subtract() [1/2]

Estimate0D & YODA::Estimate0D::subtract ( const Estimate0D &  toSubtract,
const std::string &  pat_uncorr = "^stat|^uncor" 
)
inline

Subtract two Estimate0Ds.

Definition at line 140 of file Estimate0D.h.

140 {
141 if (hasAnnotation("ScaledBy")) rmAnnotation("ScaledBy");
142 BaseT::subtract(toSubtract, pat_uncorr);
143 return *this;
144 }
YODA::Estimate::subtract
Estimate & subtract(const Estimate &toSubtract, const std::string &pat_uncorr="^stat|^uncor")
Subtract one Estimate from another.
Definition Estimate.h:125

References YODA::AnalysisObject::hasAnnotation(), YODA::AnalysisObject::rmAnnotation(), and YODA::Estimate::subtract().

Referenced by operator-=(), and operator-=().

◆ subtract() [2/2]

Estimate0D & YODA::Estimate0D::subtract ( Estimate0D &&  toSubtract,
const std::string &  pat_uncorr = "^stat|^uncor" 
)
inline

Subtract two (rvalue) Estimate0Ds.

Definition at line 151 of file Estimate0D.h.

151 {
152 if (hasAnnotation("ScaledBy")) rmAnnotation("ScaledBy");
153 BaseT::subtract(std::move(toSubtract), pat_uncorr);
154 return *this;
155 }

References YODA::AnalysisObject::hasAnnotation(), YODA::AnalysisObject::rmAnnotation(), and YODA::Estimate::subtract().

The documentation for this class was generated from the following file:
Generated on Fri Mar 7 2025 09:06:40 for YODA - Yet more Objects for Data Analysis by doxygen 1.9.8