ComPWA
Common Partial-Wave-Analysis Framework
Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
ComPWA::FunctionTree::ParameterList Class Reference

This class provides a list of parameters and values of different types. More...

#include <ParameterList.hpp>

Public Member Functions

 ParameterList ()
 
 ParameterList (const ComPWA::Data::DataSet &DataSample)
 
 ParameterList (const ParameterList &in)=default
 Only shared_ptr are copied. More...
 
void DeepCopy (const ParameterList &in)
 Clear this parameter and deep-copy all parameters from in. More...
 
virtual ~ParameterList ()
 
virtual std::size_t numParameters () const
 
std::shared_ptr< FitParameter > addUniqueParameter (std::shared_ptr< FitParameter > par)
 
virtual void addParameter (std::shared_ptr< Parameter > par)
 
virtual void addParameter (std::shared_ptr< FitParameter > par)
 
virtual void addParameters (std::vector< std::shared_ptr< Parameter >> pars)
 
virtual std::size_t numValues () const
 
virtual void addValue (std::shared_ptr< Parameter > value)
 
virtual void addValues (std::vector< std::shared_ptr< Parameter >> values)
 
virtual std::shared_ptr< FitParameter > doubleParameter (size_t i) const
 
virtual std::vector< std::shared_ptr< FitParameter > > & doubleParameters ()
 
virtual const std::vector< std::shared_ptr< FitParameter > > & doubleParameters () const
 
virtual std::shared_ptr< Value< int > > intValue (size_t i)
 
virtual std::vector< std::shared_ptr< Value< int > > > & intValues ()
 
virtual const std::vector< std::shared_ptr< Value< int > > > & intValues () const
 
virtual std::shared_ptr< Value< double > > doubleValue (size_t i) const
 
virtual std::vector< std::shared_ptr< Value< double > > > & doubleValues ()
 
virtual const std::vector< std::shared_ptr< Value< double > > > & doubleValues () const
 
virtual std::shared_ptr< Value< std::complex< double > > > complexValue (size_t i) const
 
virtual std::vector< std::shared_ptr< Value< std::complex< double > > > > & complexValues ()
 
virtual const std::vector< std::shared_ptr< Value< std::complex< double > > > > & complexValues () const
 
virtual std::shared_ptr< Value< std::vector< int > > > mIntValue (size_t i) const
 
virtual std::vector< std::shared_ptr< Value< std::vector< int > > > > & mIntValues ()
 
virtual const std::vector< std::shared_ptr< Value< std::vector< int > > > > & mIntValues () const
 
virtual std::shared_ptr< Value< std::vector< double > > > mDoubleValue (size_t i) const
 
virtual std::vector< std::shared_ptr< Value< std::vector< double > > > > & mDoubleValues ()
 
virtual const std::vector< std::shared_ptr< Value< std::vector< double > > > > & mDoubleValues () const
 
virtual std::shared_ptr< Value< std::vector< std::complex< double > > > > mComplexValue (size_t i) const
 
virtual std::vector< std::shared_ptr< Value< std::vector< std::complex< double > > > > > & mComplexValues ()
 
virtual const std::vector< std::shared_ptr< Value< std::vector< std::complex< double > > > > > & mComplexValues () const
 
virtual std::string to_str () const
 A public function returning a string with parameter information. More...
 

Protected Attributes

std::vector< std::shared_ptr< Value< int > > > IntValues
 
std::vector< std::shared_ptr< Value< double > > > DoubleValues
 
std::vector< std::shared_ptr< Value< std::complex< double > > > > ComplexValues
 
std::vector< std::shared_ptr< Value< std::vector< int > > > > MultiIntValues
 
std::vector< std::shared_ptr< Value< std::vector< double > > > > MultiDoubleValues
 
std::vector< std::shared_ptr< Value< std::vector< std::complex< double > > > > > MultiComplexValues
 
std::vector< std::shared_ptr< FitParameter > > FitParameters
 

Private Member Functions

template<class archive >
void serialize (archive &ar, const unsigned int version)
 

Friends

std::ostream & operator<< (std::ostream &out, const ParameterList &b)
 

Detailed Description

This class provides a list of parameters and values of different types.

Definition at line 37 of file ParameterList.hpp.

+ Collaboration diagram for ComPWA::FunctionTree::ParameterList:

Constructor & Destructor Documentation

◆ ParameterList() [1/3]

ComPWA::FunctionTree::ParameterList::ParameterList ( )
inline

Definition at line 39 of file ParameterList.hpp.

◆ ParameterList() [2/3]

ComPWA::FunctionTree::ParameterList::ParameterList ( const ComPWA::Data::DataSet &  DataSample)

Definition at line 20 of file ParameterList.cpp.

◆ ParameterList() [3/3]

ComPWA::FunctionTree::ParameterList::ParameterList ( const ParameterList &  in)
default

Only shared_ptr are copied.

Those still point to the same object. See DeepCopy(const ParameterList &in).

◆ ~ParameterList()

virtual ComPWA::FunctionTree::ParameterList::~ParameterList ( )
inlinevirtual

Definition at line 50 of file ParameterList.hpp.

Member Function Documentation

◆ addParameter() [1/2]

void ComPWA::FunctionTree::ParameterList::addParameter ( std::shared_ptr< Parameter >  par)
virtual

Definition at line 91 of file ParameterList.cpp.

◆ addParameter() [2/2]

void ComPWA::FunctionTree::ParameterList::addParameter ( std::shared_ptr< FitParameter >  par)
virtual

Definition at line 86 of file ParameterList.cpp.

◆ addParameters()

void ComPWA::FunctionTree::ParameterList::addParameters ( std::vector< std::shared_ptr< Parameter >>  pars)
virtual

Definition at line 62 of file ParameterList.cpp.

◆ addUniqueParameter()

std::shared_ptr< FitParameter > ComPWA::FunctionTree::ParameterList::addUniqueParameter ( std::shared_ptr< FitParameter >  par)

Definition at line 69 of file ParameterList.cpp.

◆ addValue()

void ComPWA::FunctionTree::ParameterList::addValue ( std::shared_ptr< Parameter >  value)
virtual

Definition at line 111 of file ParameterList.cpp.

◆ addValues()

void ComPWA::FunctionTree::ParameterList::addValues ( std::vector< std::shared_ptr< Parameter >>  values)
virtual

Definition at line 106 of file ParameterList.cpp.

◆ complexValue()

virtual std::shared_ptr<Value<std::complex<double> > > ComPWA::FunctionTree::ParameterList::complexValue ( size_t  i) const
inlinevirtual

Definition at line 111 of file ParameterList.hpp.

◆ complexValues() [1/2]

virtual std::vector<std::shared_ptr<Value<std::complex<double> > > >& ComPWA::FunctionTree::ParameterList::complexValues ( )
inlinevirtual

Definition at line 116 of file ParameterList.hpp.

◆ complexValues() [2/2]

virtual const std::vector<std::shared_ptr<Value<std::complex<double> > > >& ComPWA::FunctionTree::ParameterList::complexValues ( ) const
inlinevirtual

Definition at line 121 of file ParameterList.hpp.

◆ DeepCopy()

void ComPWA::FunctionTree::ParameterList::DeepCopy ( const ParameterList &  in)

Clear this parameter and deep-copy all parameters from in.

Deep-copy means that for each parameter a new object is created (not only the shared_ptr is copied).

Definition at line 28 of file ParameterList.cpp.

◆ doubleParameter()

virtual std::shared_ptr<FitParameter> ComPWA::FunctionTree::ParameterList::doubleParameter ( size_t  i) const
inlinevirtual

Definition at line 70 of file ParameterList.hpp.

◆ doubleParameters() [1/2]

virtual std::vector<std::shared_ptr<FitParameter> >& ComPWA::FunctionTree::ParameterList::doubleParameters ( )
inlinevirtual

Definition at line 74 of file ParameterList.hpp.

◆ doubleParameters() [2/2]

virtual const std::vector<std::shared_ptr<FitParameter> >& ComPWA::FunctionTree::ParameterList::doubleParameters ( ) const
inlinevirtual

Definition at line 79 of file ParameterList.hpp.

◆ doubleValue()

virtual std::shared_ptr<Value<double> > ComPWA::FunctionTree::ParameterList::doubleValue ( size_t  i) const
inlinevirtual

Definition at line 97 of file ParameterList.hpp.

◆ doubleValues() [1/2]

virtual std::vector<std::shared_ptr<Value<double> > >& ComPWA::FunctionTree::ParameterList::doubleValues ( )
inlinevirtual

Definition at line 101 of file ParameterList.hpp.

◆ doubleValues() [2/2]

virtual const std::vector<std::shared_ptr<Value<double> > >& ComPWA::FunctionTree::ParameterList::doubleValues ( ) const
inlinevirtual

Definition at line 106 of file ParameterList.hpp.

◆ intValue()

virtual std::shared_ptr<Value<int> > ComPWA::FunctionTree::ParameterList::intValue ( size_t  i)
inlinevirtual

Definition at line 85 of file ParameterList.hpp.

◆ intValues() [1/2]

virtual std::vector<std::shared_ptr<Value<int> > >& ComPWA::FunctionTree::ParameterList::intValues ( )
inlinevirtual

Definition at line 89 of file ParameterList.hpp.

◆ intValues() [2/2]

virtual const std::vector<std::shared_ptr<Value<int> > >& ComPWA::FunctionTree::ParameterList::intValues ( ) const
inlinevirtual

Definition at line 93 of file ParameterList.hpp.

◆ mComplexValue()

virtual std::shared_ptr<Value<std::vector<std::complex<double> > > > ComPWA::FunctionTree::ParameterList::mComplexValue ( size_t  i) const
inlinevirtual

Definition at line 154 of file ParameterList.hpp.

◆ mComplexValues() [1/2]

virtual std::vector<std::shared_ptr<Value<std::vector<std::complex<double> > > > >& ComPWA::FunctionTree::ParameterList::mComplexValues ( )
inlinevirtual

Definition at line 159 of file ParameterList.hpp.

◆ mComplexValues() [2/2]

virtual const std::vector< std::shared_ptr<Value<std::vector<std::complex<double> > > > >& ComPWA::FunctionTree::ParameterList::mComplexValues ( ) const
inlinevirtual

Definition at line 165 of file ParameterList.hpp.

◆ mDoubleValue()

virtual std::shared_ptr<Value<std::vector<double> > > ComPWA::FunctionTree::ParameterList::mDoubleValue ( size_t  i) const
inlinevirtual

Definition at line 139 of file ParameterList.hpp.

◆ mDoubleValues() [1/2]

virtual std::vector<std::shared_ptr<Value<std::vector<double> > > >& ComPWA::FunctionTree::ParameterList::mDoubleValues ( )
inlinevirtual

Definition at line 144 of file ParameterList.hpp.

◆ mDoubleValues() [2/2]

virtual const std::vector<std::shared_ptr<Value<std::vector<double> > > >& ComPWA::FunctionTree::ParameterList::mDoubleValues ( ) const
inlinevirtual

Definition at line 149 of file ParameterList.hpp.

◆ mIntValue()

virtual std::shared_ptr<Value<std::vector<int> > > ComPWA::FunctionTree::ParameterList::mIntValue ( size_t  i) const
inlinevirtual

Definition at line 125 of file ParameterList.hpp.

◆ mIntValues() [1/2]

virtual std::vector<std::shared_ptr<Value<std::vector<int> > > >& ComPWA::FunctionTree::ParameterList::mIntValues ( )
inlinevirtual

Definition at line 129 of file ParameterList.hpp.

◆ mIntValues() [2/2]

virtual const std::vector<std::shared_ptr<Value<std::vector<int> > > >& ComPWA::FunctionTree::ParameterList::mIntValues ( ) const
inlinevirtual

Definition at line 134 of file ParameterList.hpp.

◆ numParameters()

std::size_t ComPWA::FunctionTree::ParameterList::numParameters ( ) const
virtual

Definition at line 58 of file ParameterList.cpp.

◆ numValues()

std::size_t ComPWA::FunctionTree::ParameterList::numValues ( ) const
virtual

Definition at line 101 of file ParameterList.cpp.

◆ serialize()

template<class archive >
void ComPWA::FunctionTree::ParameterList::serialize ( archive &  ar,
const unsigned int  version 
)
inlineprivate

Definition at line 195 of file ParameterList.hpp.

◆ to_str()

std::string ComPWA::FunctionTree::ParameterList::to_str ( ) const
virtual

A public function returning a string with parameter information.

Definition at line 146 of file ParameterList.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const ParameterList &  b 
)
friend

Definition at line 169 of file ParameterList.hpp.

Member Data Documentation

◆ ComplexValues

std::vector<std::shared_ptr<Value<std::complex<double> > > > ComPWA::FunctionTree::ParameterList::ComplexValues
protected

Definition at line 181 of file ParameterList.hpp.

◆ DoubleValues

std::vector<std::shared_ptr<Value<double> > > ComPWA::FunctionTree::ParameterList::DoubleValues
protected

Definition at line 179 of file ParameterList.hpp.

◆ FitParameters

std::vector<std::shared_ptr<FitParameter> > ComPWA::FunctionTree::ParameterList::FitParameters
protected

Definition at line 190 of file ParameterList.hpp.

◆ IntValues

std::vector<std::shared_ptr<Value<int> > > ComPWA::FunctionTree::ParameterList::IntValues
protected

Definition at line 177 of file ParameterList.hpp.

◆ MultiComplexValues

std::vector<std::shared_ptr<Value<std::vector<std::complex<double> > > > > ComPWA::FunctionTree::ParameterList::MultiComplexValues
protected

Definition at line 188 of file ParameterList.hpp.

◆ MultiDoubleValues

std::vector<std::shared_ptr<Value<std::vector<double> > > > ComPWA::FunctionTree::ParameterList::MultiDoubleValues
protected

Definition at line 185 of file ParameterList.hpp.

◆ MultiIntValues

std::vector<std::shared_ptr<Value<std::vector<int> > > > ComPWA::FunctionTree::ParameterList::MultiIntValues
protected

Definition at line 183 of file ParameterList.hpp.

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