ComPWA::Function< OutputType, InputTypes > Class Template Reference

Interface template for a general Function of the form OutputType Function(InputTypes) The concept closely follows the mathematical definition of a function/mapping. More...

#include <Function.hpp>

Public Member Functions
virtual	~Function ()=default
virtual OutputType	evaluate (const InputTypes &... args) noexcept=0
virtual void	updateParametersFrom (const std::vector< double > &)=0
	It is important to input the vector in the same length and order as defined in the getParameters() method. More...
virtual std::vector< Parameter >	getParameters () const =0

Detailed Description

template<typename OutputType, typename... InputTypes>
class ComPWA::Function< OutputType, InputTypes >

Interface template for a general Function of the form OutputType Function(InputTypes) The concept closely follows the mathematical definition of a function/mapping.

The parameters are stated by the Function and can be retrieved via getParameters(). The only difference to a mathematical function is that the evaluation and the setting of the parameters are separated. Parameter have to be altered with updateParametersFrom().

Definition at line 24 of file Function.hpp.

Inheritance diagram for ComPWA::Function< OutputType, InputTypes >:

Collaboration diagram for ComPWA::Function< OutputType, InputTypes >:

Constructor & Destructor Documentation

~Function()

template<typename OutputType, typename... InputTypes>

virtual ComPWA::Function< OutputType, InputTypes >::~Function ( )

virtualdefault

Member Function Documentation

evaluate()

template<typename OutputType, typename... InputTypes>

virtual OutputType ComPWA::Function< OutputType, InputTypes >::evaluate ( const InputTypes &...  args )

pure virtualnoexcept

getParameters()

template<typename OutputType, typename... InputTypes>

virtual std::vector<Parameter> ComPWA::Function< OutputType, InputTypes >::getParameters ( ) const

pure virtual

Implemented in ComPWA::Estimator::MinLogLH, ComPWA::Physics::EvtGen::EvtGenIF, ComPWA::Estimator::SumMinLogLH, ComPWA::FunctionTree::FunctionTreeEstimator, and ComPWA::FunctionTree::FunctionTreeIntensity.

updateParametersFrom()

template<typename OutputType, typename... InputTypes>

virtual void ComPWA::Function< OutputType, InputTypes >::updateParametersFrom ( const std::vector< double > &  )

pure virtual

It is important to input the vector in the same length and order as defined in the getParameters() method.

So in other words, call getParameters() first, then use this ordering and to input new values in this method.

Implemented in ComPWA::Estimator::MinLogLH, ComPWA::Physics::EvtGen::EvtGenIF, ComPWA::Estimator::SumMinLogLH, ComPWA::FunctionTree::FunctionTreeIntensity, and ComPWA::FunctionTree::FunctionTreeEstimator.

---

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

• Core/Function.hpp