Meerkat is hosted by Hepforge, IPPP Durham
Meerkat  v1r3
Multidimensional kernel density estimation package
AbsPhaseSpace Class Referenceabstract

Abstract class which defines phase space interface. More...

#include <AbsPhaseSpace.hh>

Inheritance diagram for AbsPhaseSpace:
CombinedPhaseSpace DalitzPhaseSpace ExtendedDalitzPhaseSpace IntersectionPhaseSpace OneDimPhaseSpace ParametricPhaseSpace

Public Member Functions

 AbsPhaseSpace (const char *phaseSpaceName)
 Constructor. More...
 
virtual ~AbsPhaseSpace ()
 Destructor. More...
 
virtual UInt_t dimensionality ()=0
 Get dimensionality of phase space. More...
 
virtual Bool_t withinLimits (std::vector< Double_t > &x)=0
 Check if the point is within phase space limits. More...
 
virtual Double_t lowerLimit (UInt_t var)=0
 Return lower allowed limit of the variable. More...
 
virtual Double_t upperLimit (UInt_t var)=0
 Return upper allowed limit of the variable. More...
 
virtual Bool_t limits (UInt_t var, std::vector< Double_t > &x, Double_t *lower, Double_t *upper)=0
 Return limits (lower and upper) for the variable at a certain point of the phase space. More...
 
const char * name (void)
 Return the name of the phase space. More...
 

Protected Attributes

char m_name [256]
 Phase space name. More...
 

Detailed Description

Abstract class which defines phase space interface.

Definition at line 10 of file AbsPhaseSpace.hh.

Constructor & Destructor Documentation

AbsPhaseSpace::AbsPhaseSpace ( const char *  phaseSpaceName)

Constructor.

Parameters
[in]phaseSpaceNamename of the phase space

Definition at line 6 of file AbsPhaseSpace.cpp.

AbsPhaseSpace::~AbsPhaseSpace ( )
virtual

Destructor.

Definition at line 11 of file AbsPhaseSpace.cpp.

Member Function Documentation

virtual UInt_t AbsPhaseSpace::dimensionality ( )
pure virtual

Get dimensionality of phase space.

Returns
dimensionality of the phase space

Implemented in CombinedPhaseSpace, IntersectionPhaseSpace, ExtendedDalitzPhaseSpace, ParametricPhaseSpace, DalitzPhaseSpace, and OneDimPhaseSpace.

virtual Bool_t AbsPhaseSpace::limits ( UInt_t  var,
std::vector< Double_t > &  x,
Double_t *  lower,
Double_t *  upper 
)
pure virtual

Return limits (lower and upper) for the variable at a certain point of the phase space.

Parameters
[in]varnumber of the variable
[in]xpoint in the phase space
[out]lowerlower limit
[out]upperupper limit

Implemented in CombinedPhaseSpace, IntersectionPhaseSpace, ExtendedDalitzPhaseSpace, DalitzPhaseSpace, ParametricPhaseSpace, and OneDimPhaseSpace.

virtual Double_t AbsPhaseSpace::lowerLimit ( UInt_t  var)
pure virtual

Return lower allowed limit of the variable.

Parameters
[in]varnumber of the variable
Returns
lower allowed limit

Implemented in CombinedPhaseSpace, IntersectionPhaseSpace, ExtendedDalitzPhaseSpace, DalitzPhaseSpace, ParametricPhaseSpace, and OneDimPhaseSpace.

const char* AbsPhaseSpace::name ( void  )
inline

Return the name of the phase space.

Returns
Name of the phase space

Definition at line 63 of file AbsPhaseSpace.hh.

virtual Double_t AbsPhaseSpace::upperLimit ( UInt_t  var)
pure virtual

Return upper allowed limit of the variable.

Parameters
[in]varnumber of the variable
Returns
upper allowed limit

Implemented in CombinedPhaseSpace, IntersectionPhaseSpace, ExtendedDalitzPhaseSpace, DalitzPhaseSpace, ParametricPhaseSpace, and OneDimPhaseSpace.

virtual Bool_t AbsPhaseSpace::withinLimits ( std::vector< Double_t > &  x)
pure virtual

Check if the point is within phase space limits.

Parameters
[in]xpoint vector
Returns
true if the point is within phase space limits, false otherwise

Implemented in CombinedPhaseSpace, IntersectionPhaseSpace, ExtendedDalitzPhaseSpace, DalitzPhaseSpace, ParametricPhaseSpace, and OneDimPhaseSpace.

Member Data Documentation

char AbsPhaseSpace::m_name[256]
protected

Phase space name.

Definition at line 68 of file AbsPhaseSpace.hh.


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