yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis 2.0.0
YODA::Point Class Referenceabstract

Base class for all Point*Ds, providing generic access to their numerical properties. More...

#include <Point.h>

Inheritance diagram for YODA::Point:
YODA::PointBase< 1 > YODA::PointBase< 2 > YODA::PointBase< 3 > YODA::PointBase< N > YODA::PointND< 1 > YODA::PointND< 2 > YODA::PointND< 3 > YODA::PointND< N >

Public Types

using ValuePair = std::pair< double, double >
 

Public Member Functions

virtual ~Point ()
 Virtual destructor for inheritance.
 
Core properties
virtual size_t dim () const =0
 Space dimension of the point.
 
virtual double val (size_t i) const =0
 Get the point value for direction i.
 
virtual void setVal (const size_t i, const double val)=0
 Set the point value for direction i.
 
Errors
virtual void setErr (const size_t i, const double e)=0
 Get error values for direction i.
 
virtual void setErrs (const size_t i, const double eminus, const double eplus)=0
 Set asymmetric error for direction i.
 
virtual void setErrs (const size_t i, const std::pair< double, double > &e)=0
 Set error pair for direction i.
 
virtual void setErrMinus (const size_t i, const double eminus)=0
 Get negative error value for direction i.
 
virtual void setErrPlus (const size_t i, const double eplus)=0
 Get positive error value for direction i.
 
Combined value and error setters

Get average error value for direction i

virtual void set (const size_t i, const double val, const double e)=0
 Set value and symmetric error for direction i.
 
virtual void set (const size_t i, const double val, const double eminus, const double eplus)=0
 Set value and asymmetric error for direction i.
 
virtual void set (const size_t i, const double val, const std::pair< double, double > &e)=0
 Set value and asymmetric error for direction i.
 
Manipulations
virtual void scale (const size_t i, const double scale)=0
 

Detailed Description

Base class for all Point*Ds, providing generic access to their numerical properties.

Definition at line 26 of file Point.h.

Member Typedef Documentation

◆ ValuePair

using YODA::Point::ValuePair = std::pair<double,double>

Definition at line 29 of file Point.h.

Constructor & Destructor Documentation

◆ ~Point()

virtual YODA::Point::~Point ( )
inlinevirtual

Virtual destructor for inheritance.

Definition at line 33 of file Point.h.

33{};

Member Function Documentation

◆ dim()

virtual size_t YODA::Point::dim ( ) const
pure virtual

Space dimension of the point.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ scale()

virtual void YODA::Point::scale ( const size_t  i,
const double  scale 
)
pure virtual

◆ set() [1/3]

virtual void YODA::Point::set ( const size_t  i,
const double  val,
const double  e 
)
pure virtual

Set value and symmetric error for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ set() [2/3]

virtual void YODA::Point::set ( const size_t  i,
const double  val,
const double  eminus,
const double  eplus 
)
pure virtual

Set value and asymmetric error for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ set() [3/3]

virtual void YODA::Point::set ( const size_t  i,
const double  val,
const std::pair< double, double > &  e 
)
pure virtual

Set value and asymmetric error for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setErr()

virtual void YODA::Point::setErr ( const size_t  i,
const double  e 
)
pure virtual

Get error values for direction i.

Set symmetric error for direction i

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setErrMinus()

virtual void YODA::Point::setErrMinus ( const size_t  i,
const double  eminus 
)
pure virtual

Get negative error value for direction i.

Set negative error for direction i

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setErrPlus()

virtual void YODA::Point::setErrPlus ( const size_t  i,
const double  eplus 
)
pure virtual

Get positive error value for direction i.

Set positive error for direction i

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setErrs() [1/2]

virtual void YODA::Point::setErrs ( const size_t  i,
const double  eminus,
const double  eplus 
)
pure virtual

Set asymmetric error for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setErrs() [2/2]

virtual void YODA::Point::setErrs ( const size_t  i,
const std::pair< double, double > &  e 
)
pure virtual

Set error pair for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ setVal()

virtual void YODA::Point::setVal ( const size_t  i,
const double  val 
)
pure virtual

Set the point value for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, and YODA::PointBase< 3 >.

◆ val()

virtual double YODA::Point::val ( size_t  i) const
pure virtual

Get the point value for direction i.

Implemented in YODA::PointBase< N >, YODA::PointBase< 1 >, YODA::PointBase< 2 >, YODA::PointBase< 3 >, and YODA::PointND< 1 >.


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