CombinedPhaseSpace Class Reference

#include <CombinedPhaseSpace.hh>

Inheritance diagram for CombinedPhaseSpace:

Public Member Functions
	CombinedPhaseSpace (const char *phaseSpaceName, std::vector< AbsPhaseSpace * > &phspList)
	Constructor from the vector of component phase spaces. More...
	CombinedPhaseSpace (const char *phaseSpaceName, AbsPhaseSpace *phaseSpace1, AbsPhaseSpace *phaseSpace2, AbsPhaseSpace *phaseSpace3=0, AbsPhaseSpace *phaseSpace4=0)
	Constructor for combined phase space of up to four components. More...
virtual	~CombinedPhaseSpace ()
	Destructor. More...
UInt_t	dimensionality ()
	Get dimensionality of phase space. More...
Bool_t	withinLimits (std::vector< Double_t > &x)
	Check if the point is within phase space limits. More...
Double_t	lowerLimit (UInt_t var)
	Return lower allowed limit of the variable. More...
Double_t	upperLimit (UInt_t var)
	Return upper allowed limit of the variable. More...
Bool_t	limits (UInt_t var, std::vector< Double_t > &x, Double_t *lower, Double_t *upper)
	Return limits (lower and upper) for the variable at the certain point of the phase space. More...
Public Member Functions inherited from AbsPhaseSpace
	AbsPhaseSpace (const char *phaseSpaceName)
	Constructor. More...
virtual	~AbsPhaseSpace ()
	Destructor. More...
const char *	name (void)
	Return the name of the phase space. More...

Private Member Functions
void	init (std::vector< AbsPhaseSpace * > &phspList)
	Common initialise function for all constructors. More...

Private Attributes
UInt_t	m_dim
	Cached dimensionality of the combined phase space. More...
std::vector< AbsPhaseSpace * >	m_phspList
	vector of component phase spaces More...
std::vector< Double_t >	m_lowerLimit
	Vector of cached lower limits in each variable. More...
std::vector< Double_t >	m_upperLimit
	Vector of cached upper limits in each variable. More...

Additional Inherited Members
Protected Attributes inherited from AbsPhaseSpace
char	m_name [256]
	Phase space name. More...

Detailed Description

Class that defines the phase space which is a combination (direct product) of several phase spaces. The dimensionality of the resulting phase space is a sum of dimensionalities of the component phase spaces.

Definition at line 14 of file CombinedPhaseSpace.hh.

Constructor & Destructor Documentation

CombinedPhaseSpace::CombinedPhaseSpace	(	const char *	phaseSpaceName,
		std::vector< AbsPhaseSpace * > &	phspList
	)

Constructor from the vector of component phase spaces.

Parameters

[in]	phaseSpaceName	name of the phase space
[in]	phspList	vector of component phase spaces.

Definition at line 10 of file CombinedPhaseSpace.cpp.

CombinedPhaseSpace::CombinedPhaseSpace	(	const char *	phaseSpaceName,
		AbsPhaseSpace *	phaseSpace1,
		AbsPhaseSpace *	phaseSpace2,
		AbsPhaseSpace *	phaseSpace3 = 0,
		AbsPhaseSpace *	phaseSpace4 = 0
	)

Constructor for combined phase space of up to four components.

Parameters

[in]	phaseSpaceName	name of the phase space
[in]	phaseSpace1	1st phase space
[in]	phaseSpace2	2nd phase space
[in]	phaseSpace3	3rd phase space
[in]	phaseSpace4	4th phase space

Definition at line 15 of file CombinedPhaseSpace.cpp.

CombinedPhaseSpace::~CombinedPhaseSpace ( )

virtual

Destructor.

Definition at line 35 of file CombinedPhaseSpace.cpp.

Member Function Documentation

UInt_t CombinedPhaseSpace::dimensionality ( )

virtual

Get dimensionality of phase space.

Returns

dimensionality of the phase space

Implements AbsPhaseSpace.

Definition at line 73 of file CombinedPhaseSpace.cpp.

void CombinedPhaseSpace::init ( std::vector< AbsPhaseSpace * > &  phspList )

private

Common initialise function for all constructors.

Definition at line 39 of file CombinedPhaseSpace.cpp.

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

virtual

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

Parameters

[in]	var	number of the variable
[in]	x	point in the phase space
[out]	lower	lower limit
[out]	upper	upper limit

Implements AbsPhaseSpace.

Definition at line 122 of file CombinedPhaseSpace.cpp.

Double_t CombinedPhaseSpace::lowerLimit ( UInt_t  var )

virtual

Return lower allowed limit of the variable.

Parameters

[in]

var

number of the variable

Returns

lower allowed limit

Implements AbsPhaseSpace.

Definition at line 100 of file CombinedPhaseSpace.cpp.

Double_t CombinedPhaseSpace::upperLimit ( UInt_t  var )

virtual

Return upper allowed limit of the variable.

Parameters

[in]

var

number of the variable

Returns

upper allowed limit

Implements AbsPhaseSpace.

Definition at line 111 of file CombinedPhaseSpace.cpp.

Bool_t CombinedPhaseSpace::withinLimits ( std::vector< Double_t > &  x )

virtual

Check if the point is within phase space limits.

Parameters

[in]

x

point vector

Returns

true if the point is within phase space limits, false otherwise

Implements AbsPhaseSpace.

Definition at line 77 of file CombinedPhaseSpace.cpp.

Member Data Documentation

UInt_t CombinedPhaseSpace::m_dim

private

Cached dimensionality of the combined phase space.

Definition at line 88 of file CombinedPhaseSpace.hh.

std::vector<Double_t> CombinedPhaseSpace::m_lowerLimit

private

Vector of cached lower limits in each variable.

Definition at line 94 of file CombinedPhaseSpace.hh.

std::vector<AbsPhaseSpace*> CombinedPhaseSpace::m_phspList

private

vector of component phase spaces

Definition at line 91 of file CombinedPhaseSpace.hh.

std::vector<Double_t> CombinedPhaseSpace::m_upperLimit

private

Vector of cached upper limits in each variable.

Definition at line 97 of file CombinedPhaseSpace.hh.

---

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

• inc/CombinedPhaseSpace.hh
• src/CombinedPhaseSpace.cpp