This class is the class to describes Gamma distribution. More...

#include <STAT_GammaDistribution.h>

Inheritance diagram for STAT_GammaDistribution:

Collaboration diagram for STAT_GammaDistribution:

Public Member Functions
virtual SP::STAT_Distribution	NewInstance () const
	create a new instance of the distribution More...

virtual void	copy (const STAT_Distribution &d)
	copy the distribution More...

void	setProperties (const tReal &shape, const tReal &scale)

void	getProperties (tReal &shape, tReal &scale) const

virtual tReal	pdf (const tReal &x) const
	compute the probability density function at x point More...

virtual tReal	cdf (const tReal &x) const
	compute the cumulative distribution function at x point More...

virtual tReal	cdfc (const tReal &x) const
	compute the cumulative distribution complement function at x point More...

virtual void	range (tReal &xmin, tReal &xmax) const
	compute the range of the distribution More...

virtual tReal	mean () const
	compute the mean More...

virtual tReal	variance () const
	compute the variance More...

virtual tReal	standardDeviation () const
	compute the standard deviation More...

virtual tReal	random () const
	random return a random numbers in range More...

virtual void	computeSample (const int &n, CORE_RealArray &sample) const
	compute a sample of size n More...

virtual void	computeSample (const int &n, double *samples) const
	compute a sample of size n (sample must be allocaed of size N More...

SP::STAT_Distribution	NewCopyInstance () const
	create a copy of the distribution More...

RNGType &	getRNGenerator ()
	get the generator More...

virtual tReal	computeGrowthRate ()
	return the growth rate of the distribution such that Esperance(E(exp(-z*X)))=0.5 More...

virtual tReal	computeGrowthRate (const tReal &rho, const tReal &death)
	return the growth rate of the distribution such that Esperance(E(exp(-z*X)))=0.5 More...

virtual tReal	adjustGrowthRate (const tReal &rho, const tReal &death)
	adjuste the parameters of the distribution such that growth rate is rho More...

void	getSharedPointer (SP::CORE_Object &p)
	get the shared pointer of this class into p More...

void	getSharedPointer (SPC::CORE_Object &p) const
	get the shared pointer of this class into p More...

tString	getClassName () const
	return the class name of the object More...

tString	getIdentityString () const
	return the identity string of the object of the form className_at_address More...

tString	getPointerAddress () const
	return the identity string of the object More...

template<class T >
tBoolean	isInstanceOf () const
	return true if the object is an instance of T More...

virtual tString	toString () const
	return the string representation of the object node More...

virtual void	print ()
	print the class More...

virtual ostream &	print (ostream &out) const
	print the class More...

virtual void	print (const tString &message)
	print the class More...

virtual void	print (const tInteger &str)
	print More...

virtual void	print (const tRelativeInteger &str)
	print More...

virtual void	print (const tReal &str)
	print More...

virtual void	print (const int &str)
	print More...

Static Public Member Functions
static SP::STAT_GammaDistribution	New (const tReal &shape, const tReal &scale)
	create a Gamma distibution More...

static SP::STAT_GammaDistribution	New ()
	create a Gamma distibution More...

static void	initSeed ()
	init the seed More...

static void	initSeed (const long double &v)
	init the seed More...

template<typename T >
static tReal	quantile (const T *d, const int &size, const tReal &q)
	compute a quantile of the distribution More...

template<typename T >
static tReal	quantile (T *d, const int &size, const tReal &q)
	compute a quantile of the distribution More...

template<typename T >
static tReal	quantile (const CORE_Array< T > &a, const tReal &q)
	compute a quantile of the distribution More...

static tString	getClassName (const tString &identityString)
	return the class name of the object using only the identity string More...

template<class T >
static tString	getTypeName ()
	get type name More...

static tBoolean	is64Architecture ()
	return true if the machine is a 64 bits machine More...

static tBoolean	is32Architecture ()
	return true if the machine is a 32 bits machine More...

static tString	pointer2String (const void *obj)
	return the string represantation of a pointer More...

static void	setOutput (ostream &out)
	set output More...

static ostream &	getOutput ()
	get output More...

static void	printObjectsInMemory ()
	print object in memory More...

static ostream &	print (ostream &out, const tString &message)
	print the class More...

static void	outputPrint (const tString &message)

Static Public Attributes
static tBoolean	mIsMemoryTesting =false
	indicator to store all classes created and deleted only for debuging version More...

Protected Member Functions
	STAT_GammaDistribution ()
	create an object More...

virtual	~STAT_GammaDistribution (void)
	destroy an object. More...

virtual tReal	computeGrowthRate (const tReal &v, const tBoolean &adjust, const tReal &rho)

void	setThis (SP::CORE_Object p)
	set this weak shared pointer called toDoAfterThis setting method More...

virtual void	setType (tString type)
	set the type of the object More...

virtual void	toDoAfterThisSetting ()
	method called after setThis() method this method can oly be called once. More...

Detailed Description

This class is the class to describes Gamma distribution.

Author: St�phane Despr�aux

Version: 1.0

Constructor & Destructor Documentation

STAT_GammaDistribution::STAT_GammaDistribution ( )

protected

create an object

References null, and CORE_Object::setType().

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

STAT_GammaDistribution::~STAT_GammaDistribution ( void )

protectedvirtual

destroy an object.

References null.

Member Function Documentation

virtual tReal STAT_Distribution::adjustGrowthRate	(	const tReal &	rho,
		const tReal &	death
	)

inlinevirtualinherited

adjuste the parameters of the distribution such that growth rate is rho

References STAT_Distribution::computeGrowthRate().

Referenced by testGrowthRate().

Here is the call graph for this function:

Here is the caller graph for this function:

tReal STAT_GammaDistribution::cdf ( const tReal & x ) const

virtual

compute the cumulative distribution function at x point

Implements STAT_Distribution.

References null.

tReal STAT_GammaDistribution::cdfc ( const tReal & x ) const

virtual

compute the cumulative distribution complement function at x point

Implements STAT_Distribution.

References null.

virtual tReal STAT_Distribution::computeGrowthRate ( )

inlinevirtualinherited

return the growth rate of the distribution such that Esperance(E(exp(-z*X)))=0.5

Reimplemented in STAT_NormalDistribution.

Referenced by STAT_Distribution::adjustGrowthRate(), and STAT_Distribution::computeGrowthRate().

Here is the caller graph for this function:

virtual tReal STAT_Distribution::computeGrowthRate	(	const tReal &	rho,
		const tReal &	death
	)

inlinevirtualinherited

return the growth rate of the distribution such that Esperance(E(exp(-z*X)))=0.5

References STAT_Distribution::computeGrowthRate().

Here is the call graph for this function:

tReal STAT_GammaDistribution::computeGrowthRate	(	const tReal &	v,
		const tBoolean &	adjust,
		const tReal &	rho
	)

protectedvirtual

Implements STAT_Distribution.

References null, setProperties(), and tReal.

Here is the call graph for this function:

void STAT_GammaDistribution::computeSample	(	const int &	n,
		CORE_RealArray &	sample
	)		const

virtual

compute a sample of size n

Implements STAT_Distribution.

References null, and CORE_Array< T >::setSize().

Here is the call graph for this function:

void STAT_GammaDistribution::computeSample	(	const int &	n,
		double *	samples
	)		const

virtual

compute a sample of size n (sample must be allocaed of size N

References null.

virtual void STAT_GammaDistribution::copy ( const STAT_Distribution & d )

inlinevirtual

copy the distribution

Implements STAT_Distribution.

References STAT_Distribution::mean(), setProperties(), tReal, and STAT_Distribution::variance().

Here is the call graph for this function:

static tString CORE_Object::getClassName ( const tString & identityString )

inlinestaticinherited

return the class name of the object using only the identity string

Referenced by UI_Class::createVector2D(), LAP_DoublePackedUpperMatrix::matrixProduct(), LAP_DoubleBandedUpperMatrix::matrixProduct(), LAP_DoubleFullUpperMatrix::matrixProduct(), and CORE_Object::printObjectsInMemory().

Here is the caller graph for this function:

tString CORE_Object::getClassName ( ) const

inherited

return the class name of the object

Returns: the class name of the object

References tString.

Referenced by CORE_Object::getIdentityString().

Here is the caller graph for this function:

tString CORE_Object::getIdentityString ( ) const

inlineinherited

return the identity string of the object of the form className_at_address

Returns: the identity string of the object

References CORE_Object::getClassName(), CORE_Object::pointer2String(), and tString.

Referenced by UI_Class::createPrimitiveMap(), UI_Class::saveAssociation(), UI_Class::saveClass(), UI_ClassFactory::saveIntoClass(), MATH_StiefelFunction::toString(), LAP_2DView::toString(), CORE_Object::toString(), MATH_StiefelOptimizer::toString(), and MM_Class::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

static ostream& CORE_Object::getOutput ( )

inlinestaticinherited

get output

tString CORE_Object::getPointerAddress ( ) const

inlineinherited

return the identity string of the object

Returns: the identity string of the object

References CORE_Object::pointer2String().

Here is the call graph for this function:

void STAT_GammaDistribution::getProperties	(	tReal &	shape,
		tReal &	scale
	)		const

inline

RNGType& STAT_Distribution::getRNGenerator ( )

inlineinherited

get the generator

Referenced by STAT_PoissonDistribution::setProperties(), STAT_ExponentialDistribution::setProperties(), STAT_NormalDistribution::setProperties(), STAT_BernoulliDistribution::setProperties(), STAT_GeometricDistribution::setProperties(), setProperties(), STAT_BinomialDistribution::setProperties(), and STAT_UniformDistribution::setProperties().

Here is the caller graph for this function:

void CORE_Object::getSharedPointer ( SP::CORE_Object & p )

inlineinherited

get the shared pointer of this class into p

Referenced by CORE_Map< Key, Value >::getSharedPointer(), CORE_Array< tFlag >::getSharedPointer(), LAP_ConstVector< lapack_real >::getSharedPointer(), STAT_Combinatorial< T >::getSharedPointer(), LAP_Vector< lapack_int >::getSharedPointer(), CORE_Vector< T >::getSharedPointer(), CORE_Matrix< T >::getSharedPointer(), and CORE_Object::printObjectsInMemory().

Here is the caller graph for this function:

void CORE_Object::getSharedPointer ( SPC::CORE_Object & p ) const

inlineinherited

get the shared pointer of this class into p

template<class T >

static tString CORE_Object::getTypeName ( )

inlinestaticinherited

get type name

References tString.

void STAT_Distribution::initSeed ( )

staticinherited

init the seed

Referenced by MMSD_Object::initSeed(), and STAT_Distribution::STAT_Distribution().

Here is the caller graph for this function:

void STAT_Distribution::initSeed ( const long double & v )

staticinherited

init the seed

static tBoolean CORE_Object::is32Architecture ( )

inlinestaticinherited

return true if the machine is a 32 bits machine

References CORE_Object::is64Architecture().

Here is the call graph for this function:

tBoolean CORE_Object::is64Architecture ( )

staticinherited

return true if the machine is a 64 bits machine

Referenced by CORE_Object::is32Architecture().

Here is the caller graph for this function:

template<class T >

tBoolean CORE_Object::isInstanceOf ( ) const

inlineinherited

return true if the object is an instance of T

References null.

tReal STAT_GammaDistribution::mean ( ) const

virtual

compute the mean

Implements STAT_Distribution.

References null.

static SP::STAT_GammaDistribution STAT_GammaDistribution::New	(	const tReal &	shape,
		const tReal &	scale
	)

inlinestatic

create a Gamma distibution

References STAT_GammaDistribution().

Here is the call graph for this function:

static SP::STAT_GammaDistribution STAT_GammaDistribution::New ( )

inlinestatic

create a Gamma distibution

Referenced by MMSD_Cluster::initialize(), NewInstance(), testGammaDistribution(), and testGrowthRate().

Here is the caller graph for this function:

SP::STAT_Distribution STAT_Distribution::NewCopyInstance ( ) const

inlineinherited

create a copy of the distribution

References STAT_Distribution::NewInstance().

Here is the call graph for this function:

virtual SP::STAT_Distribution STAT_GammaDistribution::NewInstance ( ) const

inlinevirtual

create a new instance of the distribution

Implements STAT_Distribution.

References New().

Here is the call graph for this function:

void CORE_Object::outputPrint ( const tString & message )

staticinherited

print on output

References null, and CORE_Object::print().

Referenced by CORE_Exception::CORE_Exception().

Here is the call graph for this function:

Here is the caller graph for this function:

tReal STAT_GammaDistribution::pdf ( const tReal & x ) const

virtual

compute the probability density function at x point

Implements STAT_Distribution.

References null.

tString CORE_Object::pointer2String ( const void * obj )

staticinherited

return the string represantation of a pointer

References tString.

Referenced by CORE_Object::CORE_Object(), CORE_Object::getIdentityString(), CORE_Object::getPointerAddress(), and CORE_Object::~CORE_Object().

Here is the caller graph for this function:

virtual void CORE_Object::print ( )

inlinevirtualinherited

print the class

References CORE_Object::toString().

Referenced by CORE_Object::outputPrint(), CORE_Out::print(), CORE_Object::print(), CORE_Out::printInt(), CORE_Out::println(), CORE_Out::printReal(), CORE_Out::printString(), and CORE_Out::setAction().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual ostream& CORE_Object::print ( ostream & out ) const

inlinevirtualinherited

print the class

References CORE_Object::print(), and CORE_Object::toString().

Here is the call graph for this function:

void CORE_Object::print ( const tString & message )

virtualinherited

print the class

Reimplemented in CORE_Out.

References null, and CORE_Object::print().

Here is the call graph for this function:

void CORE_Object::print ( const tInteger & str )

virtualinherited

print

References null.

void CORE_Object::print ( const tRelativeInteger & str )

virtualinherited

print

References null.

void CORE_Object::print ( const tReal & str )

virtualinherited

print

References null.

void CORE_Object::print ( const int & str )

virtualinherited

print

References null.

static ostream& CORE_Object::print	(	ostream &	out,
		const tString &	message
	)

inlinestaticinherited

print the class

void CORE_Object::printObjectsInMemory ( )

staticinherited

print object in memory

References CORE_Object::getClassName(), CORE_Object::getSharedPointer(), and CORE_Object::mIsMemoryTesting.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

static tReal STAT_Object::quantile	(	const T *	d,
		const int &	size,
		const tReal &	q
	)

inlinestaticinherited

compute a quantile of the distribution

References tReal.

Referenced by STAT_Object::quantile(), and testFunctions().

Here is the caller graph for this function:

template<typename T >

static tReal STAT_Object::quantile	(	T *	d,
		const int &	size,
		const tReal &	q
	)

inlinestaticinherited

compute a quantile of the distribution

References tReal.

template<typename T >

static tReal STAT_Object::quantile	(	const CORE_Array< T > &	a,
		const tReal &	q
	)

inlinestaticinherited

compute a quantile of the distribution

References CORE_Array< T >::getSize(), CORE_Array< T >::getValues(), and STAT_Object::quantile().

Here is the call graph for this function:

tReal STAT_GammaDistribution::random ( ) const

virtual

random return a random numbers in range

Implements STAT_Distribution.

References null, and tReal.

void STAT_GammaDistribution::range	(	tReal &	xmin,
		tReal &	xmax
	)		const

virtual

compute the range of the distribution

References null.

static void CORE_Object::setOutput ( ostream & out )

inlinestaticinherited

set output

void STAT_GammaDistribution::setProperties	(	const tReal &	shape,
		const tReal &	scale
	)

References STAT_Distribution::getRNGenerator(), and null.

Referenced by computeGrowthRate(), and copy().

Here is the call graph for this function:

Here is the caller graph for this function:

void CORE_Object::setThis ( SP::CORE_Object p )

inlineprotectedinherited

set this weak shared pointer called toDoAfterThis setting method

References CORE_Object::toDoAfterThisSetting().

Here is the call graph for this function:

virtual void CORE_Object::setType ( tString type )

inlineprotectedvirtualinherited

set the type of the object

Referenced by LAP_IntegerVector::LAP_IntegerVector(), MATH_BetaFunction::MATH_BetaFunction(), MATH_C1Function::MATH_C1Function(), MATH_DigammaFunction::MATH_DigammaFunction(), MATH_EigenFunction::MATH_EigenFunction(), MATH_Equation::MATH_Equation(), MATH_Function::MATH_Function(), MATH_GammaFunction::MATH_GammaFunction(), MATH_KeplerFunction::MATH_KeplerFunction(), MATH_LogGammaFunction::MATH_LogGammaFunction(), MATH_NewtonEquation::MATH_NewtonEquation(), MATH_StiefelFunction::MATH_StiefelFunction(), MATH_StiefelOptimizer::MATH_StiefelOptimizer(), MATH_TranscendentEquation::MATH_TranscendentEquation(), MATH_TrigammaFunction::MATH_TrigammaFunction(), MATH_ZeroEquation::MATH_ZeroEquation(), MATH_ZKeplerFunction::MATH_ZKeplerFunction(), MM_Attribute::MM_Attribute(), MM_Class::MM_Class(), MM_ClassFactory::MM_ClassFactory(), MM_Data::MM_Data(), MM_Structure::MM_Structure(), MMSD_ClassFactory::MMSD_ClassFactory(), MMSD_Cluster::MMSD_Cluster(), MMSD_ConstDoubleVector::MMSD_ConstDoubleVector(), MMSD_ConstraintGaussianCluster::MMSD_ConstraintGaussianCluster(), MMSD_ConstraintGaussianModel::MMSD_ConstraintGaussianModel(), MMSD_DataSet::MMSD_DataSet(), MMSD_DataSetClassFactory::MMSD_DataSetClassFactory(), MMSD_DoubleFullMatrix::MMSD_DoubleFullMatrix(), MMSD_DoubleSymmetricMatrix::MMSD_DoubleSymmetricMatrix(), MMSD_DoubleVector::MMSD_DoubleVector(), MMSD_FluryGautschiGaussianLaw::MMSD_FluryGautschiGaussianLaw(), MMSD_GaussianCluster::MMSD_GaussianCluster(), MMSD_GaussianFDFunction::MMSD_GaussianFDFunction(), MMSD_GaussianLaw::MMSD_GaussianLaw(), MMSD_GaussianModel::MMSD_GaussianModel(), MMSD_Law::MMSD_Law(), MMSD_Model::MMSD_Model(), MMSD_ModelClassFactory::MMSD_ModelClassFactory(), MMSD_Object::MMSD_Object(), MMSD_StiefelFunction::MMSD_StiefelFunction(), MMSD_StiefelGaussianLaw::MMSD_StiefelGaussianLaw(), STAT_BernoulliDistribution::STAT_BernoulliDistribution(), STAT_BinomialDistribution::STAT_BinomialDistribution(), STAT_Combinatorial< T >::STAT_Combinatorial(), STAT_DiracDistribution::STAT_DiracDistribution(), STAT_Distribution::STAT_Distribution(), STAT_ExponentialDistribution::STAT_ExponentialDistribution(), STAT_GammaDistribution(), STAT_GeometricDistribution::STAT_GeometricDistribution(), STAT_InverseNormalDistribution::STAT_InverseNormalDistribution(), STAT_NormalDistribution::STAT_NormalDistribution(), STAT_Object::STAT_Object(), STAT_PoissonDistribution::STAT_PoissonDistribution(), STAT_UniformDistribution::STAT_UniformDistribution(), and STAT_UniformLaplaceTransform::STAT_UniformLaplaceTransform().

Here is the caller graph for this function:

tReal STAT_GammaDistribution::standardDeviation ( ) const

virtual

compute the standard deviation

Implements STAT_Distribution.

References null.

virtual void CORE_Object::toDoAfterThisSetting ( )

inlineprotectedvirtualinherited

method called after setThis() method this method can oly be called once.

Reimplemented in STAT_UniformLaplaceTransform.

Referenced by CORE_Object::setThis(), and STAT_UniformLaplaceTransform::toDoAfterThisSetting().

Here is the caller graph for this function:

tString CORE_Object::toString ( ) const

virtualinherited

return the string representation of the object node

Returns: the string representation of the object node

Reimplemented in MM_Attribute, MM_Structure, MMSD_DoubleSymmetricMatrix, CORE_Time, CORE_Vector< T >, CORE_Array< T >, CORE_Array< tString >, CORE_Array< int >, CORE_Array< tFlag >, MM_Class, MMSD_Model, LAP_DoubleMatrix, LAP_DoubleVector, CORE_Array2D< T >, MMSD_Cluster, MMSD_FluryGautschiGaussianLaw, CORE_Color, CORE_Matrix< T >, MMSD_DataSet, CORE_SharedPointersVMap< Key, Value >, CORE_SharedPointersVMap< tString, const CORE_Object >, CORE_SharedPointersVMap< tString, CORE_Object >, MATH_StiefelOptimizer, MMSD_Law, CORE_SharedPointersListVMap< Key, Value >, MATH_Equation, CORE_SharedPointersKVMap< Key, Value >, MATH_TranscendentEquation, MMSD_GaussianLaw, MMSD_GaussianCluster, MMSD_StiefelGaussianLaw, MATH_NewtonEquation, CORE_String, LAP_View, CORE_Integer, LAP_2DView, MMSD_StiefelFunction, CORE_Array3D< T >, MATH_CubicPolynom, MATH_QuadraticPolynom, MATH_ZeroEquation, MMSD_ConstraintGaussianCluster, CORE_Complex, CORE_Real, MATH_EigenFunction, and MATH_StiefelFunction.

References CORE_Object::getIdentityString().

Referenced by CORE_Object::print(), MM_ClassFactory::saveIntoFile(), CORE_SharedPointersKVMap< Key, Value >::toString(), CORE_SharedPointersListVMap< Key, Value >::toString(), MMSD_Law::toString(), CORE_SharedPointersVMap< Key, Value >::toString(), MMSD_Cluster::toString(), and MMSD_Model::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

tReal STAT_GammaDistribution::variance ( ) const

virtual

compute the variance

Implements STAT_Distribution.

References null.

Member Data Documentation

tBoolean CORE_Object::mIsMemoryTesting =false

staticinherited

indicator to store all classes created and deleted only for debuging version

Referenced by CORE_Object::CORE_Object(), main(), CORE_Object::printObjectsInMemory(), and CORE_Object::~CORE_Object().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation