The base for an N-dimensional data point to be contained in a Scatter<N> More...

#include <Point.h>

Inheritance diagram for YODA::PointBase< N >:

Public Types
using	NdVal = typename Utils::ndarray< double, N >

using	NdValPair = typename Utils::ndarray< std::pair< double, double >, N >

using	DataSize = std::integral_constant< size_t, 3 *N >

Public Types inherited from YODA::Point
using	ValuePair = std::pair< double, double >

Public Member Functions
size_t	dim () const
	Space dimension of the point.

Constructors
	PointBase ()

template<typename ValRange = ValList, typename = isIterable<ValRange>>
	PointBase (ValRange &&val)
	Constructor from position values without errors.

template<typename ValRange = ValList, typename PairRange = PairList, typename = isIterableWithPair<ValRange,PairRange>>
	PointBase (ValRange &&val, PairRange &&errs)
	Constructor from values and a set of asymmetric errors.

template<typename ValRange = ValList, typename = isIterable<ValRange>>
	PointBase (ValRange &&val, ValRange &&errs)
	Constructor from values and a set of symmetric errors.

template<typename ValRange = ValList, typename = isIterable<ValRange>>
	PointBase (ValRange &&val, ValRange &&errsdn, ValRange &&errsup)
	Constructor from values and a set of asymmetric errors.

	PointBase (const PointBase &p)

	PointBase (PointBase &&p)

Modifiers
void	clear ()
	Clear the point values and errors.

PointBase &	operator= (const PointBase &p)
	Assignment operator.

PointBase &	operator= (PointBase &&p)
	Assignment operator.

Coordinate accessors
Todo: addError, addErrors, setErrors
NdVal &	vals ()
	Get the coordinate vector.

const NdVal &	vals () const
	Get the coordinate vector (const version)

double	val (size_t i) const
	Get the value along direction i.

void	setVal (const NdVal &val)
	Set the coordinate vector.

void	setVal (const size_t i, const double val)
	Set a specific coordinate.

Error accessors
NdValPair &	errs ()
	Get error values.

const NdValPair &	errs () const
	Get error values (const version)

Pair	errs (const size_t i) const
	Get error values along axis i.

double	errMinus (const size_t i) const
	Get the minus error along axis i.

double	errPlus (const size_t i) const
	Get the plus error along axis i.

double	errAvg (const size_t i) const

double	min (const size_t i) const
	Get value minus negative error along axis i.

double	max (const size_t i) const
	Get value plus positive error along axis i.

void	setErr (const size_t i, const double e)
	Set a symmetric error pair along axis i.

void	setErrs (const size_t i, const double eminus, const double eplus)
	Set an asymmetric error pair along axis i.

void	setErrs (const size_t i, const std::pair< double, double > &e)
	Set a specific error pair along axis i.

void	setErrMinus (const size_t i, const double eminus)
	Set a specific minus error along axis i.

void	setErrPlus (const size_t i, const double eplus)
	Set a specific plus error along axis i.

Combined value and error setters
void	set (const size_t i, const double val, const double e)
	Set value and symmetric error for direction i.

void	set (const size_t i, const double val, const double eminus, const double eplus)
	Set value and asymmetric error for direction i.

void	set (const size_t i, const double val, const std::pair< double, double > &e)
	Set value and asymmetric error for direction i.

Scaling and transformations
void	scaleVal (const size_t i, const double scale)
	Scaling value along direction i.

void	scaleErr (const size_t i, const double scale)
	Scaling error along direction i.

void	scale (const size_t i, const double scale)
	Scaling along direction i.

void	scale (const NdVal &scales)
	Uniform scaling.

void	scale (const Trf< N > &trf)
	Generalised transformations with functors.

void	scale (const size_t i, const Trf< N > &trf)

void	transform (const size_t i, const Trf< N > &trf)

Public Member Functions inherited from YODA::Point
virtual	~Point ()
	Virtual destructor for inheritance.

Protected Types
using	Pair = std::pair< double, double >

using	ValList = std::initializer_list< double >

using	PairList = std::initializer_list< Pair >

template<typename Arr >
using	containedType = std::decay_t< decltype(*std::declval< Arr >().begin())>

template<typename Arr >
using	containsPair = typename std::is_same< containedType< Arr >, Pair >

template<typename T >
using	isIterable = std::enable_if_t< Iterable< T >::value >

template<typename T , typename U >
using	isIterableWithPair = std::enable_if_t<(Iterable< T >::value &&Iterable< U >::value &&containsPair< U >::value)>

Detailed Description

template<size_t N>
class YODA::PointBase< N >

The base for an N-dimensional data point to be contained in a Scatter<N>

Definition at line 119 of file Point.h.

Member Typedef Documentation

◆ containedType

template<size_t N>

template<typename Arr >

using YODA::PointBase< N >::containedType = std::decay_t<decltype(*std::declval<Arr>().begin())>

protected

Definition at line 129 of file Point.h.

◆ containsPair

template<size_t N>

template<typename Arr >

using YODA::PointBase< N >::containsPair = typename std::is_same<containedType<Arr>, Pair>

protected

Definition at line 133 of file Point.h.

◆ DataSize

template<size_t N>

using YODA::PointBase< N >::DataSize = std::integral_constant<size_t, 3*N>

Definition at line 148 of file Point.h.

◆ isIterable

template<size_t N>

template<typename T >

using YODA::PointBase< N >::isIterable = std::enable_if_t<Iterable<T>::value>

protected

Definition at line 137 of file Point.h.

◆ isIterableWithPair

template<size_t N>

template<typename T , typename U >

using YODA::PointBase< N >::isIterableWithPair = std::enable_if_t<(Iterable<T>::value && Iterable<U>::value && containsPair<U>::value)>

protected

Definition at line 141 of file Point.h.

◆ NdVal

template<size_t N>

using YODA::PointBase< N >::NdVal = typename Utils::ndarray<double, N>

Definition at line 146 of file Point.h.

◆ NdValPair

template<size_t N>

using YODA::PointBase< N >::NdValPair = typename Utils::ndarray<std::pair<double,double>, N>

Definition at line 147 of file Point.h.

◆ Pair

template<size_t N>

using YODA::PointBase< N >::Pair = std::pair<double,double>

protected

Definition at line 123 of file Point.h.

◆ PairList

template<size_t N>

using YODA::PointBase< N >::PairList = std::initializer_list<Pair>

protected

Definition at line 125 of file Point.h.

◆ ValList

template<size_t N>

using YODA::PointBase< N >::ValList = std::initializer_list<double>

protected

Definition at line 124 of file Point.h.

Constructor & Destructor Documentation

◆ PointBase() [1/7]

template<size_t N>

YODA::PointBase< N >::PointBase ( )

inline

Definition at line 155 of file Point.h.

                {
      clear();
    }

References YODA::PointBase< N >::clear().

◆ PointBase() [2/7]

template<size_t N>

template<typename ValRange = ValList, typename = isIterable<ValRange>>

YODA::PointBase< N >::PointBase ( ValRange && val )

inline

Constructor from position values without errors.

Definition at line 162 of file Point.h.

162: _val(std::forward<ValRange>(val)) { }

YODA::PointBase::val

double val(size_t i) const

Get the value along direction i.

Definition Point.h:273

◆ PointBase() [3/7]

template<size_t N>

template<typename ValRange = ValList, typename PairRange = PairList, typename = isIterableWithPair<ValRange,PairRange>>

YODA::PointBase< N >::PointBase	(	ValRange &&	val,
		PairRange &&	errs
	)

inline

Constructor from values and a set of asymmetric errors.

Definition at line 169 of file Point.h.

170 : _val(std::forward<ValRange>(val)), _errs(std::forward<PairRange>(errs)) { }

YODA::PointBase::errs

NdValPair & errs()

Get error values.

Definition Point.h:296

◆ PointBase() [4/7]

template<size_t N>

template<typename ValRange = ValList, typename = isIterable<ValRange>>

YODA::PointBase< N >::PointBase	(	ValRange &&	val,
		ValRange &&	errs
	)

inline

Constructor from values and a set of symmetric errors.

Definition at line 174 of file Point.h.

       : _val(std::forward<ValRange>(val)) {
      if (val.size() != N || errs.size() != N)
        throw RangeError("Expected " + std::to_string(N) + " dimensions.");
      size_t i = 0;
      auto it = std::begin(errs);
      const auto& itEnd = std::end(errs);
      for (; it != itEnd; ++it) {
        _errs[i++] = std::make_pair(*it, *it);
      }
    }

References YODA::PointBase< N >::errs(), and YODA::PointBase< N >::val().

◆ PointBase() [5/7]

template<size_t N>

template<typename ValRange = ValList, typename = isIterable<ValRange>>

YODA::PointBase< N >::PointBase	(	ValRange &&	val,
		ValRange &&	errsdn,
		ValRange &&	errsup
	)

inline

Constructor from values and a set of asymmetric errors.

Definition at line 189 of file Point.h.

       : _val(std::forward<ValRange>(val)) {
      if (val.size() != N || errsdn.size() != N || errsup.size() != N)
        throw RangeError("Expected " + std::to_string(N) + " dimensions.");
      size_t i = 0;
      auto itdn = std::begin(errsdn);
      auto itup = std::begin(errsup);
      const auto& itEnd = std::end(errsdn);
      for (; itdn != itEnd; ) {
        _errs[i++] = std::make_pair(*itdn++, *itup++);
      }
    }

References YODA::PointBase< N >::val().

◆ PointBase() [6/7]

template<size_t N>

YODA::PointBase< N >::PointBase ( const PointBase< N > & p )

inline

Definition at line 202 of file Point.h.

202: _val(p._val), _errs(p._errs) { }

◆ PointBase() [7/7]

template<size_t N>

YODA::PointBase< N >::PointBase ( PointBase< N > && p )

inline

Definition at line 204 of file Point.h.

204: _val(std::move(p._val)), _errs(std::move(p._errs)) { }

Member Function Documentation

◆ clear()

template<size_t N>

void YODA::PointBase< N >::clear ( )

inline

Clear the point values and errors.

Definition at line 231 of file Point.h.

                 {
      for (size_t i = 0; i < N; ++i) {
        _val[i] = 0;
        _errs[i] = {0.,0.};
      }
    }

Referenced by YODA::PointBase< N >::PointBase().

◆ dim()

template<size_t N>

size_t YODA::PointBase< N >::dim ( ) const

inlinevirtual

Space dimension of the point.

Implements YODA::Point.

Definition at line 209 of file Point.h.

209{ return N; }

◆ errAvg()

template<size_t N>

double YODA::PointBase< N >::errAvg ( const size_t i ) const

inline

Definition at line 324 of file Point.h.

                                        {
      return 0.5*(errMinus(i) + errPlus(i));
    }

References YODA::PointBase< N >::errMinus(), and YODA::PointBase< N >::errPlus().

◆ errMinus()

template<size_t N>

double YODA::PointBase< N >::errMinus ( const size_t i ) const

inline

Get the minus error along axis i.

Definition at line 312 of file Point.h.

                                          {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _errs[i].first;
    }

Referenced by YODA::PointBase< N >::errAvg().

◆ errPlus()

template<size_t N>

double YODA::PointBase< N >::errPlus ( const size_t i ) const

inline

Get the plus error along axis i.

Definition at line 318 of file Point.h.

                                         {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _errs[i].second;
    }

Referenced by YODA::PointBase< N >::errAvg().

◆ errs() [1/3]

template<size_t N>

NdValPair & YODA::PointBase< N >::errs ( )

inline

Get error values.

Definition at line 296 of file Point.h.

                      {
      return _errs;
    }

Referenced by YODA::operator<(), YODA::operator==(), and YODA::PointBase< N >::PointBase().

◆ errs() [2/3]

template<size_t N>

const NdValPair & YODA::PointBase< N >::errs ( ) const

inline

Get error values (const version)

Definition at line 301 of file Point.h.

                                  {
      return _errs;
    }

◆ errs() [3/3]

template<size_t N>

Pair YODA::PointBase< N >::errs ( const size_t i ) const

inline

Get error values along axis i.

Definition at line 306 of file Point.h.

                                    {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _errs[i];
    }

◆ max()

template<size_t N>

double YODA::PointBase< N >::max ( const size_t i ) const

inline

Get value plus positive error along axis i.

Definition at line 335 of file Point.h.

                                     {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _val[i] + _errs[i].second;
    }

◆ min()

template<size_t N>

double YODA::PointBase< N >::min ( const size_t i ) const

inline

Get value minus negative error along axis i.

Definition at line 329 of file Point.h.

                                     {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _val[i] - _errs[i].first;
    }

◆ operator=() [1/2]

template<size_t N>

PointBase & YODA::PointBase< N >::operator= ( const PointBase< N > & p )

inline

Assignment operator.

Definition at line 239 of file Point.h.

                                               {
      if (this != &p) {
        _val = p._val;
        _errs = p._errs;
      }
      return *this;
    }

◆ operator=() [2/2]

template<size_t N>

PointBase & YODA::PointBase< N >::operator= ( PointBase< N > && p )

inline

Assignment operator.

Definition at line 248 of file Point.h.

                                          {
      if (this != &p) {
        _val = std::move(p._val);
        _errs = std::move(p._errs);
      }
      return *this;
    }

◆ scale() [1/4]

template<size_t N>

void YODA::PointBase< N >::scale ( const NdVal & scales )

inline

Uniform scaling.

Definition at line 421 of file Point.h.

                                    {
      for (size_t i = 0; i < N; ++i) {
        scale(i, scales[i]);
      }
    }

References YODA::PointBase< N >::scale().

◆ scale() [2/4]

template<size_t N>

void YODA::PointBase< N >::scale	(	const size_t	i,
		const double	scale
	)

inlinevirtual

Scaling along direction i.

Implements YODA::Point.

Definition at line 415 of file Point.h.

                                                   {
      scaleVal(i, scale);
      scaleErr(i, scale);
    }

References YODA::PointBase< N >::scale(), YODA::PointBase< N >::scaleErr(), and YODA::PointBase< N >::scaleVal().

Referenced by YODA::PointBase< N >::scale(), YODA::PointBase< N >::scale(), YODA::PointBase< N >::scaleErr(), YODA::PointBase< N >::scaleVal(), and YODA::PointBase< N >::transform().

◆ scale() [3/4]

template<size_t N>

void YODA::PointBase< N >::scale	(	const size_t	i,
		const Trf< N > &	trf
	)

inline

Generalised transformations with functors along axis i

Definition at line 434 of file Point.h.

                                                  {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      trf.transform(_val[i], _errs[i]);
    }

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

◆ scale() [4/4]

template<size_t N>

void YODA::PointBase< N >::scale ( const Trf< N > & trf )

inline

Generalised transformations with functors.

Definition at line 428 of file Point.h.

                                  {
      trf.transform(_val, _errs);
    }

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

◆ scaleErr()

template<size_t N>

void YODA::PointBase< N >::scaleErr	(	const size_t	i,
		const double	scale
	)

inline

Scaling error along direction i.

Definition at line 408 of file Point.h.

                                                      {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _errs[i].first  *= scale;
      _errs[i].second *= scale;
    }

References YODA::PointBase< N >::scale().

Referenced by YODA::PointBase< N >::scale().

◆ scaleVal()

template<size_t N>

void YODA::PointBase< N >::scaleVal	(	const size_t	i,
		const double	scale
	)

inline

Scaling value along direction i.

Definition at line 402 of file Point.h.

                                                      {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _val[i] *= scale;
    }

References YODA::PointBase< N >::scale().

Referenced by YODA::PointBase< N >::scale().

◆ set() [1/3]

template<size_t N>

void YODA::PointBase< N >::set	(	const size_t	i,
		const double	val,
		const double	e
	)

inlinevirtual

Set value and symmetric error for direction i.

Implements YODA::Point.

Definition at line 376 of file Point.h.

                                                               {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      const double err = fabs(e);
      _val[i] = val;
      _errs[i] = {err,err};
    }

References YODA::PointBase< N >::val().

◆ set() [2/3]

template<size_t N>

void YODA::PointBase< N >::set	(	const size_t	i,
		const double	val,
		const double	eminus,
		const double	eplus
	)

inlinevirtual

Set value and asymmetric error for direction i.

Implements YODA::Point.

Definition at line 383 of file Point.h.

                                                                                        {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _val[i] = val;
      _errs[i].first = eminus;
      _errs[i].second = eplus;
    }

References YODA::PointBase< N >::val().

◆ set() [3/3]

template<size_t N>

void YODA::PointBase< N >::set	(	const size_t	i,
		const double	val,
		const std::pair< double, double > &	e
	)

inlinevirtual

Set value and asymmetric error for direction i.

Implements YODA::Point.

Definition at line 390 of file Point.h.

                                                                                {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _val[i] = val;
      _errs[i] = e;
    }

References YODA::PointBase< N >::val().

◆ setErr()

template<size_t N>

void YODA::PointBase< N >::setErr	(	const size_t	i,
		const double	e
	)

inlinevirtual

Set a symmetric error pair along axis i.

Implements YODA::Point.

Definition at line 341 of file Point.h.

                                                {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      const double err = fabs(e);
      _errs[i] = { err, err};
    }

◆ setErrMinus()

template<size_t N>

void YODA::PointBase< N >::setErrMinus	(	const size_t	i,
		const double	eminus
	)

inlinevirtual

Set a specific minus error along axis i.

Implements YODA::Point.

Definition at line 360 of file Point.h.

                                                          {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _errs[i].first = eminus;
    }

◆ setErrPlus()

template<size_t N>

void YODA::PointBase< N >::setErrPlus	(	const size_t	i,
		const double	eplus
	)

inlinevirtual

Set a specific plus error along axis i.

Implements YODA::Point.

Definition at line 366 of file Point.h.

                                                        {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _errs[i].second = eplus;
    }

◆ setErrs() [1/2]

template<size_t N>

void YODA::PointBase< N >::setErrs	(	const size_t	i,
		const double	eminus,
		const double	eplus
	)

inlinevirtual

Set an asymmetric error pair along axis i.

Implements YODA::Point.

Definition at line 348 of file Point.h.

                                                                          {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _errs[i] = { eminus, eplus};
    }

◆ setErrs() [2/2]

template<size_t N>

void YODA::PointBase< N >::setErrs	(	const size_t	i,
		const std::pair< double, double > &	e
	)

inlinevirtual

Set a specific error pair along axis i.

Implements YODA::Point.

Definition at line 354 of file Point.h.

                                                                  {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _errs[i] = e;
    }

◆ setVal() [1/2]

template<size_t N>

void YODA::PointBase< N >::setVal ( const NdVal & val )

inline

Set the coordinate vector.

Definition at line 279 of file Point.h.

                                  {
      _val = val;
    }

References YODA::PointBase< N >::val().

◆ setVal() [2/2]

template<size_t N>

void YODA::PointBase< N >::setVal	(	const size_t	i,
		const double	val
	)

inlinevirtual

Set a specific coordinate.

Implements YODA::Point.

Definition at line 284 of file Point.h.

                                                  {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      _val[i] = val;
    }

References YODA::PointBase< N >::val().

◆ transform()

template<size_t N>

void YODA::PointBase< N >::transform	(	const size_t	i,
		const Trf< N > &	trf
	)

inline

Definition at line 439 of file Point.h.

                                                      {
      scale(i, trf);
    }

References YODA::PointBase< N >::scale().

◆ val()

template<size_t N>

double YODA::PointBase< N >::val ( size_t i ) const

inlinevirtual

Get the value along direction i.

Implements YODA::Point.

Reimplemented in YODA::PointND< 1 >.

Definition at line 273 of file Point.h.

                               {
      if (i >= N) throw RangeError("Invalid axis int, must be in range 0..dim-1");
      return _val[i];
    }

Referenced by YODA::PointBase< N >::PointBase(), YODA::PointBase< N >::PointBase(), YODA::PointBase< N >::set(), YODA::PointBase< N >::set(), YODA::PointBase< N >::set(), YODA::PointBase< N >::setVal(), and YODA::PointBase< N >::setVal().

◆ vals() [1/2]

template<size_t N>

NdVal & YODA::PointBase< N >::vals ( )

inline

Get the coordinate vector.

Definition at line 267 of file Point.h.

267{ return _val; }

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

◆ vals() [2/2]

template<size_t N>

const NdVal & YODA::PointBase< N >::vals ( ) const

inline

Get the coordinate vector (const version)

Definition at line 270 of file Point.h.

270{ return _val; }

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

include/YODA/Point.h

Public Types

Public Member Functions

Protected Types

Detailed Description

Member Typedef Documentation

◆ containedType

◆ containsPair

◆ DataSize

◆ isIterable

◆ isIterableWithPair

◆ NdVal

◆ NdValPair

◆ Pair

◆ PairList

◆ ValList

Constructor & Destructor Documentation

◆ PointBase() [1/7]

◆ PointBase() [2/7]

◆ PointBase() [3/7]

◆ PointBase() [4/7]

◆ PointBase() [5/7]

◆ PointBase() [6/7]

◆ PointBase() [7/7]

Member Function Documentation

◆ clear()

◆ dim()

◆ errAvg()

◆ errMinus()

◆ errPlus()

◆ errs() [1/3]

◆ errs() [2/3]

◆ errs() [3/3]

◆ max()

◆ min()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ scale() [1/4]

◆ scale() [2/4]

◆ scale() [3/4]

◆ scale() [4/4]

◆ scaleErr()

◆ scaleVal()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setErr()

◆ setErrMinus()

◆ setErrPlus()

◆ setErrs() [1/2]

◆ setErrs() [2/2]

◆ setVal() [1/2]

◆ setVal() [2/2]

◆ transform()

◆ val()

◆ vals() [1/2]

◆ vals() [2/2]