lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum Class Reference

DiscreteProbabilityData class. More...

Public Member Functions
	DiscreteProbabilityDatum (const float x, const float densityDatum, const float cumulativeDatum, const float width)
	Constructor. More...
float	GetX () const
	Get the x value for the datum. More...
float	GetDensityDatum () const
	Get the probability density for the datum. More...
float	GetCumulativeDatum () const
	Get the cumulative probability for the datum. More...
float	GetWidth () const
	Get the width of the datum. More...

Private Attributes
float	m_x
	The x coordinate. More...
float	m_densityDatum
	The probability density value. More...
float	m_cumulativeDatum
	The cumulative probability value. More...
float	m_width
	The width of the probability bin. More...

Detailed Description

DiscreteProbabilityData class.

Definition at line 140 of file LArDiscreteProbabilityVector.h.

Constructor & Destructor Documentation

lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::DiscreteProbabilityDatum ( const float  x, const float  densityDatum, const float  cumulativeDatum, const float  width  )

inline

Constructor.

Parameters

x	the x value
densityDatum	the probability density for the corresponding x
cumulativeDatum	the cumulative probability for the corresponding x
width	the width of the bin

Definition at line 329 of file LArDiscreteProbabilityVector.h.

                                                                                             :
    m_x(x),
    m_densityDatum(densityDatum),
    m_cumulativeDatum(cumulativeDatum),
    m_width(width)
{
}

Member Function Documentation

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::GetCumulativeDatum ( ) const

inline

Get the cumulative probability for the datum.

Returns

the cumulative probability

Definition at line 354 of file LArDiscreteProbabilityVector.h.

References m_cumulativeDatum.

{
    return m_cumulativeDatum;
}

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::GetDensityDatum ( ) const

inline

Get the probability density for the datum.

Returns

the probability density

Definition at line 347 of file LArDiscreteProbabilityVector.h.

References m_densityDatum.

{
    return m_densityDatum;
}

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::GetWidth ( ) const

inline

Get the width of the datum.

Returns

the width

Definition at line 361 of file LArDiscreteProbabilityVector.h.

References m_width.

{
    return m_width;
}

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::GetX ( ) const

inline

Get the x value for the datum.

Returns

the x value

Definition at line 340 of file LArDiscreteProbabilityVector.h.

References m_x.

Referenced by lar_content::DiscreteProbabilityVector::GetAllAtIndex().

{
    return m_x;
}

Member Data Documentation

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::m_cumulativeDatum

private

The cumulative probability value.

Definition at line 184 of file LArDiscreteProbabilityVector.h.

Referenced by GetCumulativeDatum().

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::m_densityDatum

private

The probability density value.

Definition at line 183 of file LArDiscreteProbabilityVector.h.

Referenced by GetDensityDatum().

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::m_width

private

The width of the probability bin.

Definition at line 185 of file LArDiscreteProbabilityVector.h.

Referenced by GetWidth().

float lar_content::DiscreteProbabilityVector::DiscreteProbabilityDatum::m_x

private

The x coordinate.

Definition at line 182 of file LArDiscreteProbabilityVector.h.

Referenced by GetX().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArDiscreteProbabilityVector.h