YODA::Transformation< N, Args > Class Template Reference

#include <Transformation.h>

Public Types
using	Pair = std::pair< double, double >
	Convenient aliases.
using	NdVal = typename Utils::ndarray< double, N >
using	NdValPair = typename Utils::ndarray< Pair, N >
using	Breakdown = std::map< std::string, std::pair< double, double > >

Public Member Functions
Constructors
	Transformation ()=delete
	Transformation (const std::function< double(double, Args...)> &fn)
	Default constructor setting the trf method.
	Transformation (std::function< double(double, Args...)> &&fn)
	Default constructor setting the trf method.
double	operator() (const double v, Args &&... args) const
	Operator calling the functor.
Modifiers
void	transform (double &val, Args &&... args) const
	Transform value val.
void	transform (NdVal &vals, Args &&... args) const
	Transform values vals.
void	transform (double &val, Breakdown &signed_errs, Args &&... args) const
	Transform value val and breakdown of signed error pairs signed_errs.
void	transform (double &val, Pair &errs, Args &&... args) const
	Transform value val and error pair errs.
void	transform (NdVal &vals, NdValPair &errs, Args &&... args) const
	Transform values vals and error pairs errs.

Detailed Description

template<size_t N, typename... Args>
class YODA::Transformation< N, Args >

Generalised transformation

The tranformation uses a functor that acts on a double (possibly with additional arguments) and returns a double. The generalisation is in the number of dimensions in which the trf can be applied.

Definition at line 31 of file Transformation.h.

Member Typedef Documentation

Breakdown

template<size_t N, typename... Args>

using YODA::Transformation< N, Args >::Breakdown = std::map<std::string,std::pair<double,double> >

Definition at line 38 of file Transformation.h.

NdVal

template<size_t N, typename... Args>

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

Definition at line 36 of file Transformation.h.

NdValPair

template<size_t N, typename... Args>

using YODA::Transformation< N, Args >::NdValPair = typename Utils::ndarray<Pair, N>

Definition at line 37 of file Transformation.h.

Pair

template<size_t N, typename... Args>

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

Convenient aliases.

Definition at line 35 of file Transformation.h.

Constructor & Destructor Documentation

Transformation() [1/3]

template<size_t N, typename... Args>

YODA::Transformation< N, Args >::Transformation ( )

delete

No nullary constructor since a trf method should always be supplied

Transformation() [2/3]

template<size_t N, typename... Args>

YODA::Transformation< N, Args >::Transformation ( const std::function< double(double, Args...)> &  fn )

inline

Default constructor setting the trf method.

Definition at line 49 of file Transformation.h.

: _Fn(fn) { }

Transformation() [3/3]

template<size_t N, typename... Args>

YODA::Transformation< N, Args >::Transformation ( std::function< double(double, Args...)> &&  fn )

inline

Default constructor setting the trf method.

Definition at line 52 of file Transformation.h.

: _Fn(std::move(fn)) { }

Member Function Documentation

operator()()

template<size_t N, typename... Args>

double YODA::Transformation< N, Args >::operator() ( const double  v, Args &&...  args  ) const

inline

Operator calling the functor.

Definition at line 56 of file Transformation.h.

{ return _Fn(v, std::forward<Args>(args)...); }

transform() [1/5]

template<size_t N, typename... Args>

void YODA::Transformation< N, Args >::transform ( double &  val, Args &&...  args  ) const

inline

Transform value val.

Definition at line 65 of file Transformation.h.

{ val = _Fn(val, std::forward<Args>(args)...); }

Referenced by YODA::PointBase< N >::scale(), YODA::Estimate::scale(), YODA::PointBase< N >::scale(), YODA::Transformation< N, Args >::transform(), YODA::Transformation< N, Args >::transform(), YODA::Transformation< N, Args >::transform(), and YODA::Transformation< N, Args >::transform().

transform() [2/5]

template<size_t N, typename... Args>

void YODA::Transformation< N, Args >::transform ( double &  val, Breakdown &  signed_errs, Args &&...  args  ) const

inline

Transform value val and breakdown of signed error pairs signed_errs.

Definition at line 77 of file Transformation.h.

                                                                              {
      // keep track of original central value
      const double oldval = val;
      // transform central value
      transform(val, std::forward<Args>(args)...);
      // transform errors
      for (auto& item : signed_errs) {
        item.second.first = _Fn(oldval + item.second.first, std::forward<Args>(args)...) - val;
        item.second.second = _Fn(oldval + item.second.second, std::forward<Args>(args)...) - val;
      }
    }

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

transform() [3/5]

template<size_t N, typename... Args>

void YODA::Transformation< N, Args >::transform ( double &  val, Pair &  errs, Args &&...  args  ) const

inline

Transform value val and error pair errs.

Definition at line 90 of file Transformation.h.

                                                                  {
      // transform errors
      const double trf_min = _Fn(val - errs.first, std::forward<Args>(args)...);
      const double trf_max = _Fn(val + errs.second, std::forward<Args>(args)...);
      // transform central value
      transform(val, std::forward<Args>(args)...);
      // Deal with possible inversions of min/max ordering under the transformation
      const double new_min = std::min(trf_min, trf_max);
      const double new_max = std::max(trf_min, trf_max);
      errs = std::make_pair(val - new_min, new_max - val);
    }

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

transform() [4/5]

template<size_t N, typename... Args>

void YODA::Transformation< N, Args >::transform ( NdVal &  vals, Args &&...  args  ) const

inline

Transform values vals.

Definition at line 68 of file Transformation.h.

                                                      {
      for (double& val : vals) {
        transform(val, std::forward<Args>(args)...);
      }
    }

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

transform() [5/5]

template<size_t N, typename... Args>

void YODA::Transformation< N, Args >::transform ( NdVal &  vals, NdValPair &  errs, Args &&...  args  ) const

inline

Transform values vals and error pairs errs.

Definition at line 103 of file Transformation.h.

                                                                       {
      for (size_t i = 0; i < N; ++i) {
        transform(vals[i], errs[i], std::forward<Args>(args)...);
      }
    }

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

---

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

• include/YODA/Transformation.h