lar::util::details::SimplePolyFitterDataBase< T, D > Class Template Reference

Base class providing data collection for the simple polynomial fitters. More...

#include "SimpleFits.h"

Inheritance diagram for lar::util::details::SimplePolyFitterDataBase< T, D >:

Public Types
using	Data_t = typename Collector_t::Data_t
	type of the data More...
using	Measurement_t = typename Collector_t::Measurement_t
	type of measurement without uncertainty More...
using	MeasurementAndUncertainty_t = typename Collector_t::MeasurementAndUncertainty_t
	type of measurement with uncertainty More...

Public Member Functions
void	clear ()
	Clears all the statistics. More...
template<typename Stream >
void	PrintStats (Stream &out) const
	Prints the collected statistics into a stream. More...
Add elements
See also FitDataCollector
bool	add (Data_t x, Data_t y, Data_t sy=Data_t(1.0))
bool	add (Measurement_t value, Data_t sy=Data_t(1.0))
bool	add (MeasurementAndUncertainty_t value)
template<typename Iter >
void	add_without_uncertainty (Iter begin, Iter end)
template<typename Iter , typename Pred >
void	add_without_uncertainty (Iter begin, Iter end, Pred extractor)
template<typename Cont , typename Pred >
void	add_without_uncertainty (Cont cont, Pred extractor)
template<typename Cont >
void	add_without_uncertainty (Cont cont)
template<typename VIter , typename UIter , typename VPred , typename UPred = identity>
unsigned int	add_with_uncertainty (VIter begin_value, VIter end_value, UIter begin_uncertainty, VPred value_extractor, UPred uncertainty_extractor=UPred())
template<typename Iter >
unsigned int	add_with_uncertainty (Iter begin, Iter end)
template<typename Cont >
unsigned int	add_with_uncertainty (Cont cont)
Statistic retrieval
See also FitDataCollector
int	N () const
Data_t	AverageUncertainty () const

Static Public Member Functions
template<typename V >
static constexpr V	sqr (V const &v)
	Returns the square of the specified value. More...

Static Public Attributes
static constexpr unsigned int	Degree = Collector_t::Degree
	Degree of the fit. More...

Protected Member Functions
Data_t	XN (unsigned int n) const
	Returns the weighted sum of x^n. More...
Data_t	XNY (unsigned int n) const
	Returns the weighted sum of x^n y. More...

Protected Attributes
Collector_t	stats
	statistics collected from fit data input More...

Private Types
using	Collector_t = FitDataCollector< T, D >
	class storing input More...

Detailed Description

template<typename T, unsigned int D>
class lar::util::details::SimplePolyFitterDataBase< T, D >

Base class providing data collection for the simple polynomial fitters.

Definition at line 342 of file SimpleFits.h.

Member Typedef Documentation

template<typename T , unsigned int D>

using lar::util::details::SimplePolyFitterDataBase< T, D >::Collector_t = FitDataCollector<T, D>

private

class storing input

Definition at line 343 of file SimpleFits.h.

template<typename T , unsigned int D>

using lar::util::details::SimplePolyFitterDataBase< T, D >::Data_t = typename Collector_t::Data_t

type of the data

Definition at line 349 of file SimpleFits.h.

template<typename T , unsigned int D>

using lar::util::details::SimplePolyFitterDataBase< T, D >::Measurement_t = typename Collector_t::Measurement_t

type of measurement without uncertainty

Definition at line 352 of file SimpleFits.h.

template<typename T , unsigned int D>

using lar::util::details::SimplePolyFitterDataBase< T, D >::MeasurementAndUncertainty_t = typename Collector_t::MeasurementAndUncertainty_t

type of measurement with uncertainty

Definition at line 355 of file SimpleFits.h.

Member Function Documentation

template<typename T , unsigned int D>

bool lar::util::details::SimplePolyFitterDataBase< T, D >::add ( Data_t  x, Data_t  y, Data_t  sy = Data_t(1.0)  )

inline

Definition at line 363 of file SimpleFits.h.

Referenced by cluster::ClusterParamsAlg::IntegrateFitCharge().

{ return stats.add(x, y, sy); }

template<typename T , unsigned int D>

bool lar::util::details::SimplePolyFitterDataBase< T, D >::add ( Measurement_t  value, Data_t  sy = Data_t(1.0)  )

inline

Definition at line 365 of file SimpleFits.h.

{ return stats.add(value, sy); }

template<typename T , unsigned int D>

bool lar::util::details::SimplePolyFitterDataBase< T, D >::add ( MeasurementAndUncertainty_t  value )

inline

Definition at line 367 of file SimpleFits.h.

{ return stats.add(value); }

template<typename T , unsigned int D>

template<typename VIter , typename UIter , typename VPred , typename UPred = identity>

unsigned int lar::util::details::SimplePolyFitterDataBase< T, D >::add_with_uncertainty ( VIter  begin_value, VIter  end_value, UIter  begin_uncertainty, VPred  value_extractor, UPred  uncertainty_extractor = UPred()  )

inline

Definition at line 394 of file SimpleFits.h.

        {
          return stats.add_with_uncertainty(
            begin_value, end_value, begin_uncertainty, value_extractor, uncertainty_extractor);
        }

template<typename T , unsigned int D>

template<typename Iter >

unsigned int lar::util::details::SimplePolyFitterDataBase< T, D >::add_with_uncertainty ( Iter  begin, Iter  end  )

inline

Definition at line 405 of file SimpleFits.h.

        {
          return stats.add_with_uncertainty(begin, end);
        }

template<typename T , unsigned int D>

template<typename Cont >

unsigned int lar::util::details::SimplePolyFitterDataBase< T, D >::add_with_uncertainty ( Cont  cont )

inline

Definition at line 411 of file SimpleFits.h.

        {
          return stats.add_with_uncertainty(cont);
        }

template<typename T , unsigned int D>

template<typename Iter >

void lar::util::details::SimplePolyFitterDataBase< T, D >::add_without_uncertainty ( Iter  begin, Iter  end  )

inline

Definition at line 370 of file SimpleFits.h.

        {
          stats.add_without_uncertainty(begin, end);
        }

template<typename T , unsigned int D>

template<typename Iter , typename Pred >

void lar::util::details::SimplePolyFitterDataBase< T, D >::add_without_uncertainty ( Iter  begin, Iter  end, Pred  extractor  )

inline

Definition at line 376 of file SimpleFits.h.

        {
          stats.add_without_uncertainty(begin, end, extractor);
        }

template<typename T , unsigned int D>

template<typename Cont , typename Pred >

void lar::util::details::SimplePolyFitterDataBase< T, D >::add_without_uncertainty ( Cont  cont, Pred  extractor  )

inline

Definition at line 382 of file SimpleFits.h.

        {
          stats.add_without_uncertainty(cont, extractor);
        }

template<typename T , unsigned int D>

template<typename Cont >

void lar::util::details::SimplePolyFitterDataBase< T, D >::add_without_uncertainty ( Cont  cont )

inline

Definition at line 388 of file SimpleFits.h.

        {
          stats.add_without_uncertainty(cont);
        }

template<typename T , unsigned int D>

Data_t lar::util::details::SimplePolyFitterDataBase< T, D >::AverageUncertainty ( ) const

inline

Definition at line 427 of file SimpleFits.h.

{ return stats.AverageUncertainty(); }

template<typename T , unsigned int D>

void lar::util::details::SimplePolyFitterDataBase< T, D >::clear ( )

inline

Clears all the statistics.

Definition at line 419 of file SimpleFits.h.

{ stats.clear(); }

template<typename T , unsigned int D>

int lar::util::details::SimplePolyFitterDataBase< T, D >::N ( ) const

inline

Definition at line 425 of file SimpleFits.h.

{ return stats.N(); }

template<typename T , unsigned int D>

template<typename Stream >

void lar::util::details::SimplePolyFitterDataBase< T, D >::PrintStats ( Stream &  out ) const

inline

Prints the collected statistics into a stream.

Definition at line 433 of file SimpleFits.h.

        {
          stats.Print(out);
        }

template<typename T , unsigned int D>

template<typename V >

static constexpr V lar::util::details::SimplePolyFitterDataBase< T, D >::sqr ( V const &  v )

inlinestatic

Returns the square of the specified value.

Definition at line 440 of file SimpleFits.h.

References sqr().

        {
          return Collector_t::sqr(v);
        }

template<typename T , unsigned int D>

Data_t lar::util::details::SimplePolyFitterDataBase< T, D >::XN ( unsigned int  n ) const

inlineprotected

Returns the weighted sum of x^n.

Definition at line 449 of file SimpleFits.h.

References lar::util::details::FitDataCollector< T, D >::XN().

{ return stats.XN(n); }

template<typename T , unsigned int D>

Data_t lar::util::details::SimplePolyFitterDataBase< T, D >::XNY ( unsigned int  n ) const

inlineprotected

Returns the weighted sum of x^n y.

Definition at line 452 of file SimpleFits.h.

References lar::util::details::FitDataCollector< T, D >::XNY().

{ return stats.XNY(n); }

Member Data Documentation

template<typename T , unsigned int D>

constexpr unsigned int lar::util::details::SimplePolyFitterDataBase< T, D >::Degree = Collector_t::Degree

static

Degree of the fit.

Definition at line 347 of file SimpleFits.h.

template<typename T , unsigned int D>

Collector_t lar::util::details::SimplePolyFitterDataBase< T, D >::stats

protected

statistics collected from fit data input

Definition at line 446 of file SimpleFits.h.

---

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

• lardata/v09_16_03/source/lardata/Utilities/SimpleFits.h