cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.5
Central exclusive processes event generator
Loading...
Searching...
No Matches
+ Inheritance diagram for FunctionalTinyExpr:
+ Collaboration diagram for FunctionalTinyExpr:

Public Member Functions

 FunctionalTinyExpr (const ParametersList &)
 
double eval () const override
 Compute the functional for a given value of the variables.
 
double operator() (double x) const
 Compute the functional for a given value of the variable (one-dimensional case)
 
double operator() (const std::vector< double > &x) const
 Compute the functional for a given value of the variables.
 
const std::vector< std::string > & variables () const
 List of string variable names.
 
const std::string & expression () const
 String expression held by this functional parser.
 
const std::string & name () const
 Module unique indexing name.
 
bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersListparameters () const override
 Module user-defined parameters.
 
virtual void setParameters (const ParametersList &params) override
 Set module parameters.
 
void setDescribedParameters (const ParametersList &params_orig)
 Set (documented) module parameters.
 

Static Public Member Functions

static ParametersDescription description ()
 
static ParametersList fromExpression (const std::string &expr, const std::vector< std::string > &vars)
 Build a collection of parameters to define a functional from its mathematical expression.
 

Protected Member Functions

template<typename T >
steer (const std::string &key) const
 Retrieve a parameters as previously steered.
 
template<typename T , typename U >
U steerAs (const std::string &key) const
 Retrieve a recasted parameters as previously steered.
 
std::string steerName () const
 Retrieve module name from parameters.
 
std::string steerPath (const std::string &key) const
 Retrieve a path from common search paths.
 

Protected Attributes

std::vector< std::string > vars_
 Computer-readable variable to be reached.
 
std::string expression_
 Computer-readable expression.
 
std::vector< double > values_
 Last arguments list fed to the functional.
 
const std::string name_
 Module unique indexing name.
 
ParametersList params_
 Module parameters.
 

Detailed Description

Definition at line 28 of file FunctionalTinyExpr.cpp.

Constructor & Destructor Documentation

◆ FunctionalTinyExpr()

FunctionalTinyExpr ( const ParametersList params)
explicit

Definition at line 42 of file FunctionalTinyExpr.cpp.

Member Function Documentation

◆ description()

ParametersDescription description ( )
static

Definition at line 60 of file FunctionalTinyExpr.cpp.

◆ eval()

double eval ( ) const
overridevirtual

Implements Functional.

Definition at line 58 of file FunctionalTinyExpr.cpp.

◆ expression()

const std::string & expression ( ) const
inherited

Definition at line 52 of file Functional.h.

◆ fromExpression()

ParametersList fromExpression ( const std::string &  expr,
const std::vector< std::string > &  vars 
)
staticinherited
Parameters
[in]exprMathematical expression to evaluate
[in]varsList of expression variables

Definition at line 53 of file Functional.cpp.

◆ name()

const std::string & name ( ) const
inherited

Definition at line 42 of file NamedModule.h.

◆ operator!=()

template<typename T >
bool operator!= ( const SteeredObject< T > &  oth) const
inherited

Definition at line 51 of file SteeredObject.h.

◆ operator()() [1/2]

double operator() ( const std::vector< double > &  x) const
inherited
Parameters
[in]xVariables values

Definition at line 45 of file Functional.cpp.

◆ operator()() [2/2]

double operator() ( double  x) const
inherited
Parameters
[in]xVariable value

Definition at line 39 of file Functional.cpp.

◆ operator==()

template<typename T >
bool operator== ( const SteeredObject< T > &  oth) const
inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

template<typename T >
const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ setDescribedParameters()

template<typename T >
void setDescribedParameters ( const ParametersList params_orig)
inherited

Definition at line 73 of file SteeredObject.h.

◆ setParameters()

template<typename T >
virtual void setParameters ( const ParametersList params)
overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

◆ steer()

template<typename T >
T steer ( const std::string &  key) const
protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >
U steerAs ( const std::string &  key) const
protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const
protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string &  key) const
protectedinherited

Definition at line 30 of file Steerable.cpp.

◆ variables()

const std::vector< std::string > & variables ( ) const
inherited

Definition at line 50 of file Functional.h.

Member Data Documentation

◆ expression_

std::string expression_
protectedinherited

Definition at line 63 of file Functional.h.

◆ name_

const std::string name_
protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ values_

std::vector<double> values_
mutableprotectedinherited

Definition at line 64 of file Functional.h.

◆ vars_

std::vector<std::string> vars_
protectedinherited

Definition at line 62 of file Functional.h.