A point estimate (base class for the Estimate) More...

#include <Estimate.h>

Inheritance diagram for YODA::Estimate:

Public Member Functions
Constructors
	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

Operators
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)

Modifiers
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.

Estimate getters
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 average uncertainty component.

std::pair< double, double >	relErrDownUp (const std::string &source="") const
	The relative error on 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 on the central value.

double	relErrUp (const std::string &source="") const
	The relative positive on the central value.

double	relErrAvg (const std::string &source="") const
	The average uncertainty component.

double	valMax (const std::string &source="") const

double	valMin (const std::string &source="") const

std::pair< double, double >	quadSum () const noexcept
	Get the quadrature sum of uncertainty components.

double	quadSumNeg () const noexcept

double	quadSumPos () const noexcept

double	quadSumAvg () const noexcept
	The average uncertainty component.

std::pair< double, double >	totalErr () const noexcept
	The total uncertainty.

double	totalErrNeg () const noexcept
	The negative total uncertainty.

double	totalErrPos () const noexcept
	The positive total uncertainty.

double	totalErrAvg () const
	The average total uncertainty.

double	valueErr () const
	The unsigned average total uncertainty.

std::pair< double, double >	relTotalErr () const noexcept
	The relative negative/positive total uncertainty on the central value.

double	relTotalErrNeg () const noexcept
	The relative negative total uncertainty on the central value.

double	relTotalErrPos () const noexcept
	The relative positive total uncertainty on the central value.

double	relTotalErrAvg () const noexcept
	The average uncertainty component.

std::vector< std::string >	sources () const noexcept

bool	hasSource (const std::string &key) const noexcept

size_t	numErrs () const noexcept

MPI (de-)serialisation
std::vector< std::string >	serializeSources () const noexcept

void	deserializeSources (const std::vector< std::string > &data)

Detailed Description

A point estimate (base class for the Estimate)

This class is used internally by YODA to centralise the storage of static statistical results or estimators. Each estimate is made up of a value and an error map. The error map uses the source of uncertainty as the keys and the (possibly asymmetric) uncertainty pair as the values. The empty string is interpreted as the total uncertainty.

Definition at line 29 of file Estimate.h.

Constructor & Destructor Documentation

◆ Estimate() [1/5]

YODA::Estimate::Estimate ( )

inline

Default constructor of a new distribution.

Definition at line 36 of file Estimate.h.

36{ reset(); }

YODA::Estimate::reset

void reset() noexcept

Reset the internal values.

Definition Estimate.h:194

References reset().

◆ Estimate() [2/5]

YODA::Estimate::Estimate	(	double	v,
		std::map< std::string, std::pair< double, double > > &	errors
	)

inline

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

Principally designed for internal persistency use.

Definition at line 42 of file Estimate.h.

43 : _value(v), _error(errors) { }

◆ Estimate() [3/5]

YODA::Estimate::Estimate	(	const double	v,
		const std::pair< double, double > &	e,
		const std::string &	source = `""`
	)

inline

Alternative constructor to set an Estimate with value and uncertainty.

Definition at line 47 of file Estimate.h.

48 : _value(v) { setErr(e, source); }

YODA::Estimate::setErr

void setErr(const std::pair< double, double > &err, const std::string &source="")

Set a signed uncertainty component.

Definition Estimate.h:165

References setErr().

◆ Estimate() [4/5]

YODA::Estimate::Estimate ( const Estimate & toCopy )

inline

Copy constructor

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

Definition at line 53 of file Estimate.h.

                                     {
      _value = toCopy._value;
      _error = toCopy._error;
    }

◆ Estimate() [5/5]

YODA::Estimate::Estimate ( Estimate && toMove )

inline

Move constructor

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

Definition at line 61 of file Estimate.h.

                                {
      _value = std::move(toMove._value);
      _error = std::move(toMove._error);
    }

Member Function Documentation

◆ add()

Estimate & YODA::Estimate::add	(	const Estimate &	toAdd,
		const std::string &	pat_uncorr = `"^stat\|^uncor"`
	)

inline

Add two Estimates.

Definition at line 95 of file Estimate.h.

                                                                                      {
      setVal(val() + toAdd.val());
      std::smatch match;
      const std::regex re(pat_uncorr);
      for (const std::string& src : toAdd.sources()) {
        if (!hasSource(src))  setErr(toAdd.errDownUp(src), src);
        else if (std::regex_search(src, match, re)) {
          // treat as uncorrelated between AOs:
          // add in quadrature
          const auto [l_dn,l_up] = errDownUp(src);
          const auto [r_dn,r_up] = toAdd.errDownUp(src);
          const double new_dn = std::sqrt(l_dn*l_dn + r_dn*r_dn);
          const double new_up = std::sqrt(l_up*l_up + r_up*r_up);
          setErr({-new_dn,new_up}, src);
        }
        else {
          // treat as correlated between AOs: add linearly
          const auto [l_dn,l_up] = errDownUp(src);
          const auto [r_dn,r_up] = toAdd.errDownUp(src);
          setErr({l_dn+r_dn, l_up+r_up}, src);
        }
      }
      return *this;
    }

References errDownUp(), hasSource(), setErr(), setVal(), sources(), and val().

Referenced by YODA::Estimate0D::add(), YODA::Estimate0D::add(), and operator+=().

◆ deserializeSources()

void YODA::Estimate::deserializeSources ( const std::vector< std::string > & data )

inline

Definition at line 482 of file Estimate.h.

                                                              {
 
      const size_t nErrs = numErrs();
      if (data.size() != nErrs)
        throw UserError("Expected " + std::to_string(nErrs) + " error source labels!");
 
      for (size_t i = 0; i < data.size(); ++i) {
        const std::string name("source" + std::to_string(i+1));
        if (!_error.count(name))
          throw UserError("Key names have already been updated!");
        renameSource(name, data[i]);
      }
 
    }

References numErrs(), and renameSource().

◆ err()

std::pair< double, double > YODA::Estimate::err ( const std::string & source = "" ) const

inline

Convenience alias for errorDownUp(source)

Definition at line 252 of file Estimate.h.

                                                                   {
      return errDownUp(source);
    }

References errDownUp().

Referenced by set(), set(), setErr(), and setErr().

◆ errAvg()

double YODA::Estimate::errAvg ( const std::string & source = "" ) const

inline

The average uncertainty component.

Definition at line 282 of file Estimate.h.

                                                      {
      return _average(errDownUp(source));
    }

References errDownUp().

◆ errDown()

double YODA::Estimate::errDown ( const std::string & source = "" ) const

inline

The signed error due to the systematic downward variation.

Definition at line 272 of file Estimate.h.

                                                       {
      return errDownUp(source).first;
    }

References errDownUp().

Referenced by YODA::divide().

◆ errDownUp()

std::pair< double, double > YODA::Estimate::errDownUp ( const std::string & source = "" ) const

inline

The signed absolute error on the central value.

Note: first/second element corresponds to systematic down/up variation

Definition at line 244 of file Estimate.h.

                                                                         {
      const size_t count = _error.count(source);
      if (!count)
        throw RangeError("Error map has no such key: "+source);
      return _error.at(source);
    }

Referenced by add(), err(), errAvg(), errDown(), errNegPos(), errUp(), relErrDownUp(), and subtract().

◆ errNeg()

double YODA::Estimate::errNeg ( const std::string & source = "" ) const

inline

The signed negative uncertainty component.

Definition at line 262 of file Estimate.h.

                                                      {
      return errNegPos(source).first;
    }

References errNegPos().

Referenced by valMin().

◆ errNegPos()

std::pair< double, double > YODA::Estimate::errNegPos ( std::string source = "" ) const

inline

The signed negative and positive uncertainty component.

Definition at line 257 of file Estimate.h.

                                                                  {
      return _downUp2NegPos( errDownUp(source) );
    }

References errDownUp().

Referenced by errNeg(), and errPos().

◆ errPos()

double YODA::Estimate::errPos ( const std::string & source = "" ) const

inline

The signed positive uncertainty component.

Definition at line 267 of file Estimate.h.

                                                      {
      return errNegPos(source).second;
    }

References errNegPos().

Referenced by valMax().

◆ errUp()

double YODA::Estimate::errUp ( const std::string & source = "" ) const

inline

The signed error due to the systematic upward variation.

Definition at line 277 of file Estimate.h.

                                                     {
      return errDownUp(source).second;
    }

References errDownUp().

Referenced by YODA::divide().

◆ hasSource()

bool YODA::Estimate::hasSource ( const std::string & key ) const

inlinenoexcept

Definition at line 414 of file Estimate.h.

                                                        {
      return _error.count(key);
    }

Referenced by add(), YODA::divide(), renameSource(), and subtract().

◆ numErrs()

size_t YODA::Estimate::numErrs ( ) const

inlinenoexcept

Definition at line 418 of file Estimate.h.

                                    {
      return _error.size();
    }

Referenced by deserializeSources(), and YODA::Estimate0D::mkInert().

◆ operator+=()

Estimate & YODA::Estimate::operator+= ( const Estimate & toAdd )

inline

Definition at line 120 of file Estimate.h.

                                                {
      return add(toAdd);
    }

References add().

◆ operator-=()

Estimate & YODA::Estimate::operator-= ( const Estimate & toSubtract )

inline

Definition at line 149 of file Estimate.h.

                                                     {
      return subtract(toSubtract);
    }

References subtract().

◆ operator=() [1/2]

Estimate & YODA::Estimate::operator= ( const Estimate & toCopy )

inlinenoexcept

Copy assignment

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

Definition at line 69 of file Estimate.h.

                                                         {
      if (this != &toCopy) {
        _value = toCopy._value;
        _error = toCopy._error;
      }
      return *this;
    }

Referenced by YODA::Estimate0D::operator=(), and YODA::Estimate0D::operator=().

◆ operator=() [2/2]

Estimate & YODA::Estimate::operator= ( Estimate && toMove )

inlinenoexcept

Move assignment

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

Definition at line 80 of file Estimate.h.

                                                    {
      if (this != &toMove) {
        _value = std::move(toMove._value);
        _error = std::move(toMove._error);
      }
      return *this;
    }

◆ quadSum()

std::pair< double, double > YODA::Estimate::quadSum ( ) const

inlinenoexcept

Get the quadrature sum of uncertainty components.

Note: The first element is for the negative error, the second element for the positive error.

Definition at line 330 of file Estimate.h.

                                                    {
      // interpret as { neg , pos } quad sums
      std::pair<double, double> ret = { 0., 0. };
      for (const auto& item : _error) {
        const auto [dn,up] = _downUp2NegPos(item.second);
        ret.first += dn*dn;
        ret.second += up*up;
      }
      return { - std::sqrt(ret.first), std::sqrt(ret.second) };
    }

Referenced by YODA::Estimate0D::mkScatter(), quadSumAvg(), quadSumNeg(), quadSumPos(), and totalErr().

◆ quadSumAvg()

double YODA::Estimate::quadSumAvg ( ) const

inlinenoexcept

The average uncertainty component.

Definition at line 350 of file Estimate.h.

                                       {
      return _average(quadSum());
    }

References quadSum().

◆ quadSumNeg()

double YODA::Estimate::quadSumNeg ( ) const

inlinenoexcept

Definition at line 341 of file Estimate.h.

                                       {
      return quadSum().first;
    }

References quadSum().

◆ quadSumPos()

double YODA::Estimate::quadSumPos ( ) const

inlinenoexcept

Definition at line 345 of file Estimate.h.

                                       {
      return quadSum().second;
    }

References quadSum().

◆ relErr()

std::pair< double, double > YODA::Estimate::relErr ( const std::string & source = "" ) const

inline

Convenience alias for relErrDownUp.

Definition at line 295 of file Estimate.h.

                                                                      {
      return relErrDownUp(source);
    }

References relErrDownUp().

Referenced by relErrDown(), and relErrUp().

◆ relErrAvg()

double YODA::Estimate::relErrAvg ( const std::string & source = "" ) const

inline

The average uncertainty component.

Definition at line 310 of file Estimate.h.

                                                         {
      return _average(relErrDownUp(source));
    }

References relErrDownUp().

◆ relErrDown()

double YODA::Estimate::relErrDown ( const std::string & source = "" ) const

inline

The relative negative on the central value.

Definition at line 300 of file Estimate.h.

                                                          {
      return relErr(source).first;
    }

References relErr().

Referenced by YODA::divide().

◆ relErrDownUp()

std::pair< double, double > YODA::Estimate::relErrDownUp ( const std::string & source = "" ) const

inline

The relative error on the central value.

Definition at line 287 of file Estimate.h.

                                                                            {
      auto [dn,up] = errDownUp(source);
      dn = _value != 0 ? dn/fabs(_value) : std::numeric_limits<double>::quiet_NaN();
      up = _value != 0 ? up/fabs(_value) : std::numeric_limits<double>::quiet_NaN();
      return {dn,up};
    }

References errDownUp().

Referenced by relErr(), and relErrAvg().

◆ relErrUp()

double YODA::Estimate::relErrUp ( const std::string & source = "" ) const

inline

The relative positive on the central value.

Definition at line 305 of file Estimate.h.

                                                        {
      return relErr(source).second;
    }

References relErr().

Referenced by YODA::divide().

◆ relTotalErr()

std::pair< double, double > YODA::Estimate::relTotalErr ( ) const

inlinenoexcept

The relative negative/positive total uncertainty on the central value.

Definition at line 386 of file Estimate.h.

                                                        {
      auto [neg,pos] = totalErr();
      neg = _value != 0 ? neg/fabs(_value) : std::numeric_limits<double>::quiet_NaN();
      pos = _value != 0 ? pos/fabs(_value) : std::numeric_limits<double>::quiet_NaN();
      return {neg,pos};
    }

References totalErr().

Referenced by relTotalErrAvg(), relTotalErrNeg(), and relTotalErrPos().

◆ relTotalErrAvg()

double YODA::Estimate::relTotalErrAvg ( ) const

inlinenoexcept

The average uncertainty component.

Definition at line 404 of file Estimate.h.

                                           {
      return _average(relTotalErr());
    }

References relTotalErr().

Referenced by YODA::efficiency().

◆ relTotalErrNeg()

double YODA::Estimate::relTotalErrNeg ( ) const

inlinenoexcept

The relative negative total uncertainty on the central value.

Definition at line 394 of file Estimate.h.

                                           {
      return relTotalErr().first;
    }

References relTotalErr().

◆ relTotalErrPos()

double YODA::Estimate::relTotalErrPos ( ) const

inlinenoexcept

The relative positive total uncertainty on the central value.

Definition at line 399 of file Estimate.h.

                                           {
      return relTotalErr().second;
    }

References relTotalErr().

◆ renameSource()

void YODA::Estimate::renameSource	(	const std::string &	old_label,
		const std::string &	new_label
	)

inline

Replace a source label in the error breakdown.

Definition at line 219 of file Estimate.h.

                                                                              {
      if (!hasSource(old_label)) {
        throw UserError("Error map has no such key: "+old_label);
      }
      auto entry = _error.extract(old_label);
      entry.key() = new_label;
      _error.insert(std::move(entry));
    }

References hasSource().

Referenced by deserializeSources(), and YODA::Estimate0D::mkInert().

◆ reset()

void YODA::Estimate::reset ( )

inlinenoexcept

Reset the internal values.

Definition at line 194 of file Estimate.h.

                          {
      _value = std::numeric_limits<double>::quiet_NaN();
      _error.clear();
    }

Referenced by Estimate(), and YODA::Estimate0D::reset().

◆ scale() [1/2]

void YODA::Estimate::scale ( const double scalefactor )

inlinenoexcept

Rescale as if value and uncertainty had been different by factor scalefactor.

Definition at line 201 of file Estimate.h.

                                                  {
      _value *= scalefactor;
      for (auto& item : _error) {
        item.second = { item.second.first * scalefactor, item.second.second * scalefactor };
      }
    }

Referenced by transform().

◆ scale() [2/2]

void YODA::Estimate::scale ( const Trf< 1 > & trf )

inline

Generalised transformations with functors.

Definition at line 209 of file Estimate.h.

                                  {
      trf.transform(_value, _error);
    }

References YODA::Transformation< N, Args >::transform().

◆ serializeSources()

std::vector< std::string > YODA::Estimate::serializeSources ( ) const

inlinenoexcept

Definition at line 478 of file Estimate.h.

                                                           {
      return sources();
    }

References sources().

◆ set() [1/2]

void YODA::Estimate::set	(	const double	val,
		const double	err,
		const std::string &	source = `""`
	)

inline

Set both central value and uncertainty component.

Definition at line 188 of file Estimate.h.

                                                                               {
      setVal(val);
      setErr(err, source);
    }

References err(), setErr(), setVal(), and val().

◆ set() [2/2]

void YODA::Estimate::set	(	const double	val,
		const std::pair< double, double > &	err,
		const std::string	source = `""`
	)

inline

Set both central value and uncertainty component.

Definition at line 181 of file Estimate.h.

                                                                                                {
      setVal(val);
      setErr(err, source);
    }

References err(), setErr(), setVal(), and val().

Referenced by YODA::divide(), YODA::efficiency(), and YODA::Counter::mkEstimate().

◆ setErr() [1/2]

void YODA::Estimate::setErr	(	const double	err,
		const std::string &	source = `""`
	)

inline

Set a symmetric uncertainty component.

Note: The down-component will be set to -|err| and the up-component will be set to +|err|.

Definition at line 176 of file Estimate.h.

                                                                {
      setErr({-fabs(err),fabs(err)}, source);
    }

References err(), and setErr().

◆ setErr() [2/2]

void YODA::Estimate::setErr	(	const std::pair< double, double > &	err,
		const std::string &	source = `""`
	)

inline

Set a signed uncertainty component.

Definition at line 165 of file Estimate.h.

                                                                                  {
      const std::string& s = Utils::toUpper(source);
      if (s == "TOTAL")
        throw UserError("Use empty string for the total uncertainty!");
      _error[source] = err;
    }

References err().

Referenced by add(), YODA::divide(), YODA::efficiency(), Estimate(), set(), set(), setErr(), and subtract().

◆ setVal()

void YODA::Estimate::setVal ( const double val )

inlinenoexcept

Alias for setValue.

Definition at line 162 of file Estimate.h.

162{ setValue(val); }

YODA::Estimate::setValue

void setValue(const double value) noexcept

Set the central value of this estimator.

Definition Estimate.h:159

References setValue(), and val().

Referenced by add(), YODA::divide(), set(), set(), and subtract().

◆ setValue()

void YODA::Estimate::setValue ( const double value )

inlinenoexcept

Set the central value of this estimator.

Definition at line 159 of file Estimate.h.

159{ _value = value; }

Referenced by setVal().

◆ sources()

std::vector< std::string > YODA::Estimate::sources ( ) const

inlinenoexcept

Definition at line 408 of file Estimate.h.

                                                  {
      std::vector<std::string> keys;
      for (const auto& item : _error)  keys.push_back(item.first);
      return keys;
    }

Referenced by add(), YODA::divide(), YODA::efficiency(), serializeSources(), and subtract().

◆ subtract()

Estimate & YODA::Estimate::subtract	(	const Estimate &	toSubtract,
		const std::string &	pat_uncorr = `"^stat\|^uncor"`
	)

inline

Subtract one Estimate from another.

Definition at line 125 of file Estimate.h.

                                                                                                {
      setVal(val() - toSubtract.val());
      std::smatch match;
      const std::regex re(pat_uncorr);
      for (const std::string& src : toSubtract.sources()) {
        if (!hasSource(src))  setErr(toSubtract.errDownUp(src), src);
        else if (std::regex_search(src, match, re)) {
          // treat as uncorrelated between AOs: add in quadrature
          const auto [l_dn,l_up] = errDownUp(src);
          const auto [r_dn,r_up] = toSubtract.errDownUp(src);
          const double new_dn = std::sqrt(l_dn*l_dn + r_dn*r_dn);
          const double new_up = std::sqrt(l_up*l_up + r_up*r_up);
          setErr({-new_dn,new_up}, src);;
        }
        else {
          // treat as correlated between AOs: add linearly
          const auto [l_dn,l_up] = errDownUp(src);
          const auto [r_dn,r_up] = toSubtract.errDownUp(src);
          setErr({l_dn+r_dn, l_up+r_up}, src);
        }
      }
      return *this;
    }

References errDownUp(), hasSource(), setErr(), setVal(), sources(), and val().

Referenced by operator-=(), YODA::Estimate0D::subtract(), and YODA::Estimate0D::subtract().

◆ totalErr()

std::pair< double, double > YODA::Estimate::totalErr ( ) const

inlinenoexcept

The total uncertainty.

Note: If the user didn't specify a total uncertainty using the empty string, the sum in quadrature is returned.

Definition at line 358 of file Estimate.h.

                                                     {
      // check if the user specified the total uncertainty
      if (_error.count(""))  return _downUp2NegPos(_error.at(""));
      // otherwise return quadrature sum
      return quadSum();
    }

References quadSum().

Referenced by relTotalErr(), totalErrAvg(), totalErrNeg(), and totalErrPos().

◆ totalErrAvg()

double YODA::Estimate::totalErrAvg ( ) const

inline

The average total uncertainty.

Definition at line 376 of file Estimate.h.

                               {
      return _average(totalErr());
    }

References totalErr().

Referenced by YODA::efficiency(), and valueErr().

◆ totalErrNeg()

double YODA::Estimate::totalErrNeg ( ) const

inlinenoexcept

The negative total uncertainty.

Definition at line 366 of file Estimate.h.

                                        {
      return totalErr().first;
    }

References totalErr().

◆ totalErrPos()

double YODA::Estimate::totalErrPos ( ) const

inlinenoexcept

The positive total uncertainty.

Definition at line 371 of file Estimate.h.

                                        {
      return totalErr().second;
    }

References totalErr().

◆ transform()

void YODA::Estimate::transform ( const Trf< 1 > & trf )

inline

Generalised transformations with functors.

Definition at line 214 of file Estimate.h.

                                      {
      scale(trf);
    }

References scale().

Referenced by YODA::transform().

◆ val()

double YODA::Estimate::val ( ) const

inlinenoexcept

The central value.

Definition at line 238 of file Estimate.h.

238{ return _value; }

Referenced by add(), YODA::divide(), YODA::efficiency(), YODA::Estimate0D::mkScatter(), set(), set(), setVal(), subtract(), valMax(), and valMin().

◆ valMax()

double YODA::Estimate::valMax ( const std::string & source = "" ) const

inline

The maximal shift of the central value according to systematic variation source

Definition at line 316 of file Estimate.h.

                                                      {
      return val() + errPos(source);
    }

References errPos(), and val().

◆ valMin()

double YODA::Estimate::valMin ( const std::string & source = "" ) const

inline

The minimal shift of the central value according to systematic variation source

Definition at line 322 of file Estimate.h.

                                                      {
      return val() + errNeg(source);
    }

References errNeg(), and val().

◆ valueErr()

double YODA::Estimate::valueErr ( ) const

inline

The unsigned average total uncertainty.

Definition at line 381 of file Estimate.h.

                            {
      return fabs(totalErrAvg());
    }

References totalErrAvg().

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

include/YODA/Estimate.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Estimate() [1/5]

◆ Estimate() [2/5]

◆ Estimate() [3/5]

◆ Estimate() [4/5]

◆ Estimate() [5/5]

Member Function Documentation

◆ add()

◆ deserializeSources()

◆ err()

◆ errAvg()

◆ errDown()

◆ errDownUp()

◆ errNeg()

◆ errNegPos()

◆ errPos()

◆ errUp()

◆ hasSource()

◆ numErrs()

◆ operator+=()

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ quadSum()

◆ quadSumAvg()

◆ quadSumNeg()

◆ quadSumPos()

◆ relErr()

◆ relErrAvg()

◆ relErrDown()

◆ relErrDownUp()

◆ relErrUp()

◆ relTotalErr()

◆ relTotalErrAvg()

◆ relTotalErrNeg()

◆ relTotalErrPos()

◆ renameSource()

◆ reset()

◆ scale() [1/2]

◆ scale() [2/2]

◆ serializeSources()

◆ set() [1/2]

◆ set() [2/2]

◆ setErr() [1/2]

◆ setErr() [2/2]

◆ setVal()

◆ setValue()

◆ sources()

◆ subtract()

◆ totalErr()

◆ totalErrAvg()

◆ totalErrNeg()

◆ totalErrPos()

◆ transform()

◆ val()

◆ valMax()

◆ valMin()

◆ valueErr()