ComPWA
Common Partial-Wave-Analysis Framework
ComPWA::FunctionTree::FunctionTreeEstimator Class Reference

#include <FunctionTreeEstimator.hpp>

Public Member Functions

 FunctionTreeEstimator (std::shared_ptr< TreeNode > tree, ParameterList parameters)
 
 FunctionTreeEstimator (const FunctionTreeEstimator &other)=delete
 
 FunctionTreeEstimator (FunctionTreeEstimator &&other)=default
 
double evaluate () noexcept
 
void updateParametersFrom (const std::vector< double > &params)
 It is important to input the vector in the same length and order as defined in the getParameters() method. More...
 
std::vector< ComPWA::ParametergetParameters () const
 
std::string print (int level) const
 
std::shared_ptr< TreeNodegetFunctionTree () const
 
ParameterList getParameterList () const
 
- Public Member Functions inherited from ComPWA::Function< double >
virtual ~Function ()=default
 
virtual double evaluate (const InputTypes &... args) noexcept=0
 

Private Attributes

std::shared_ptr< TreeNodeTree
 
ParameterList Parameters
 

Detailed Description

Definition at line 15 of file FunctionTreeEstimator.hpp.

+ Inheritance diagram for ComPWA::FunctionTree::FunctionTreeEstimator:
+ Collaboration diagram for ComPWA::FunctionTree::FunctionTreeEstimator:

Constructor & Destructor Documentation

◆ FunctionTreeEstimator() [1/3]

ComPWA::FunctionTree::FunctionTreeEstimator::FunctionTreeEstimator ( std::shared_ptr< TreeNode tree,
ParameterList  parameters 
)

Definition at line 9 of file FunctionTreeEstimator.cpp.

◆ FunctionTreeEstimator() [2/3]

ComPWA::FunctionTree::FunctionTreeEstimator::FunctionTreeEstimator ( const FunctionTreeEstimator other)
delete

◆ FunctionTreeEstimator() [3/3]

ComPWA::FunctionTree::FunctionTreeEstimator::FunctionTreeEstimator ( FunctionTreeEstimator &&  other)
default

Member Function Documentation

◆ evaluate()

double ComPWA::FunctionTree::FunctionTreeEstimator::evaluate ( )
noexcept

Definition at line 35 of file FunctionTreeEstimator.cpp.

◆ getFunctionTree()

std::shared_ptr< TreeNode > ComPWA::FunctionTree::FunctionTreeEstimator::getFunctionTree ( ) const

Definition at line 61 of file FunctionTreeEstimator.cpp.

◆ getParameterList()

ParameterList ComPWA::FunctionTree::FunctionTreeEstimator::getParameterList ( ) const

Definition at line 64 of file FunctionTreeEstimator.cpp.

◆ getParameters()

std::vector< ComPWA::Parameter > ComPWA::FunctionTree::FunctionTreeEstimator::getParameters ( ) const
virtual

Implements ComPWA::Function< double >.

Definition at line 49 of file FunctionTreeEstimator.cpp.

◆ print()

std::string ComPWA::FunctionTree::FunctionTreeEstimator::print ( int  level) const

Definition at line 57 of file FunctionTreeEstimator.cpp.

◆ updateParametersFrom()

void ComPWA::FunctionTree::FunctionTreeEstimator::updateParametersFrom ( const std::vector< double > &  )
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.

Implements ComPWA::Function< double >.

Definition at line 40 of file FunctionTreeEstimator.cpp.

Member Data Documentation

◆ Parameters

ParameterList ComPWA::FunctionTree::FunctionTreeEstimator::Parameters
private

Definition at line 37 of file FunctionTreeEstimator.hpp.

◆ Tree

std::shared_ptr<TreeNode> ComPWA::FunctionTree::FunctionTreeEstimator::Tree
private

Definition at line 36 of file FunctionTreeEstimator.hpp.


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