Kaskade::ScalarModelFunction Class Reference

Interface for a scalar model function on a scalar domain that may fit data. More...

#include <modelfunction.hh>

Detailed Description

Interface for a scalar model function on a scalar domain that may fit data.

Definition at line 22 of file modelfunction.hh.

Inheritance diagram for Kaskade::ScalarModelFunction:

Public Member Functions
	ScalarModelFunction ()
virtual void	update (double abscissa, double value)
	Add new value to the sample points, will be overwritten by the next update, until fixUpdate() is called. More...
virtual double	getValue (double abscissa)=0
	Compute value of the model function at abscissa. More...
virtual double	getIntegral (double high, double low)
	Compute integral of the model function from low to high. More...
virtual double	getAbscissa (double value)
	Compute abscissa corresponding to a value. This is of course only possible for monotone functions. More...
virtual void	fixUpdate ()
	fix the last updated value and thus increase the number of sampling points More...
virtual	~ScalarModelFunction ()
void	setDataStart (int ds)

Protected Member Functions
virtual double	getDataVal (int i)
virtual double	getDataAbsc (int i)
virtual double	getScaling (int i)

Protected Attributes
LoggedQuantity< std::pair< double, double > >	data
bool	modified
int	datastart

Constructor & Destructor Documentation

ScalarModelFunction()

Kaskade::ScalarModelFunction::ScalarModelFunction ( )

inline

Definition at line 25 of file modelfunction.hh.

~ScalarModelFunction()

virtual Kaskade::ScalarModelFunction::~ScalarModelFunction ( )

inlinevirtual

Definition at line 42 of file modelfunction.hh.

Member Function Documentation

fixUpdate()

virtual void Kaskade::ScalarModelFunction::fixUpdate ( )

inlinevirtual

fix the last updated value and thus increase the number of sampling points

Definition at line 40 of file modelfunction.hh.

getAbscissa()

virtual double Kaskade::ScalarModelFunction::getAbscissa ( double  value )

inlinevirtual

Compute abscissa corresponding to a value. This is of course only possible for monotone functions.

Reimplemented in Kaskade::PolynomialModel, and Kaskade::TransformedPolynomialModel.

Definition at line 37 of file modelfunction.hh.

getDataAbsc()

virtual double Kaskade::ScalarModelFunction::getDataAbsc ( int  i )

inlineprotectedvirtual

Reimplemented in Kaskade::TransformedPolynomialModel, and Kaskade::JModel.

Definition at line 47 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients().

getDataVal()

virtual double Kaskade::ScalarModelFunction::getDataVal ( int  i )

inlineprotectedvirtual

Reimplemented in Kaskade::TransformedPolynomialModel, and Kaskade::JModel.

Definition at line 46 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients().

getIntegral()

virtual double Kaskade::ScalarModelFunction::getIntegral ( double  high, double  low  )

inlinevirtual

Compute integral of the model function from low to high.

Reimplemented in Kaskade::LogLogModel.

Definition at line 34 of file modelfunction.hh.

getScaling()

virtual double Kaskade::ScalarModelFunction::getScaling ( int  i )

inlineprotectedvirtual

Reimplemented in Kaskade::JModel.

Definition at line 48 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients().

getValue()

virtual double Kaskade::ScalarModelFunction::getValue ( double  abscissa )

pure virtual

Compute value of the model function at abscissa.

Implemented in Kaskade::PolynomialModel, and Kaskade::TransformedPolynomialModel.

setDataStart()

void Kaskade::ScalarModelFunction::setDataStart ( int  ds )

inline

Definition at line 44 of file modelfunction.hh.

Referenced by Kaskade::JModel::JModel().

update()

virtual void Kaskade::ScalarModelFunction::update ( double  abscissa, double  value  )

inlinevirtual

Add new value to the sample points, will be overwritten by the next update, until fixUpdate() is called.

Reimplemented in Kaskade::JModel.

Definition at line 28 of file modelfunction.hh.

Member Data Documentation

data

LoggedQuantity<std::pair<double, double> > Kaskade::ScalarModelFunction::data

protected

Definition at line 51 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients(), fixUpdate(), getDataAbsc(), Kaskade::TransformedPolynomialModel::getDataAbsc(), Kaskade::JModel::getDataAbsc(), getDataVal(), Kaskade::TransformedPolynomialModel::getDataVal(), Kaskade::JModel::getDataVal(), and Kaskade::JModel::getScaling().

datastart

int Kaskade::ScalarModelFunction::datastart

protected

Definition at line 53 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients(), and setDataStart().

modified

bool Kaskade::ScalarModelFunction::modified

protected

Definition at line 52 of file modelfunction.hh.

Referenced by Kaskade::PolynomialModel::computeCoefficients(), Kaskade::OmegaModel::computeCoefficients(), Kaskade::EtaModel::computeCoefficients(), and Kaskade::JModel::computeCoefficients().

---

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

• modelfunction.hh