This class solve the equation f(x)=0. More...

#include <MATH_Equation.h>

Inheritance diagram for MATH_Equation:

Collaboration diagram for MATH_Equation:

Public Member Functions
virtual void	copy (const MATH_Equation *m)
	copy the parameters of the optimization method More...

virtual void	loadFromUIClass (const UI_Class &mclass)
	how to load the object from a Meta Model class More...

virtual void	saveToUIClass (UI_Class &mclass) const
	how to save the object from a mate model class More...

virtual void	setInterval (const tReal &a, const tReal &b)
	set the interval of searching More...

void	getInterval (tReal &a, tReal &b) const
	get interval of searching More...

void	setMaxIterationsNumber (const int &v)
	set max iterations number More...

int	getMaxIterationsNumber () const
	get the max iteration number More...

tReal	getSolution () const
	get the solution More...

int	getIterationsNumber () const
	get the iterations number to reach the solution More...

tReal	getError () const
	get the error estimated with the solution More...

void	setMaxError (const tReal &err)
	set the wished max error More...

tReal	getMaxError () const
	get the wished max error More...

void	setFunction (SP::MATH_Function f)
	set function More...

const MATH_Function *	getFunction () const
	get the function More...

MATH_Function *	getFunction ()
	get the function More...

virtual tBoolean	hasFunction () const
	return true if the optimized method has function More...

virtual tReal	solve ()=0
	solve the equation More...

virtual tReal	solve (const tReal &x0)=0
	solve the equation with initial point More...

virtual tBoolean	hasSucceeded () const
	return true if the method has succeeded More...

virtual tString	toString () const
	to string More...

void	setHasBeenLoaded (const tBoolean &v)
	set the if the object has completely been loaded More...

tBoolean	hasBeenLoaded () const
	return true if the object has completely been loaded 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 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 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)

Public Attributes
tReal	mMaxError

int	mMaxIterationsNumber

int	mIterationsNumber

tReal	mX

tReal	mError

tReal	mInterval [2]

WP::MATH_Function	mFunction

Static Public Attributes
static const tReal	EPSILON =1.e-12

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

Protected Member Functions
	MATH_Equation (void)
	create a Equation object More...

virtual	~MATH_Equation (void)
	destroy an Equation Object. More...

void	setSolution (const tReal &x)
	set the solution More...

void	setIterationsNumber (const int &n)
	set the iterations number to reach the solution More...

void	setError (const tReal &err)
	set the error estimated with the solution More...

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 solve the equation f(x)=0.

Author: St�phane Despr�aux

Version: 1.0

Constructor & Destructor Documentation

MATH_Equation::MATH_Equation ( void )

protected

create a Equation object

References mError, mInterval, mIterationsNumber, mMaxError, mMaxIterationsNumber, mX, and CORE_Object::setType().

Here is the call graph for this function:

MATH_Equation::~MATH_Equation ( void )

protectedvirtual

destroy an Equation Object.

Member Function Documentation

void MATH_Equation::copy ( const MATH_Equation * m )

virtual

copy the parameters of the optimization method

Reimplemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

References getError(), getIterationsNumber(), getMaxError(), getMaxIterationsNumber(), getSolution(), mError, mIterationsNumber, mMaxError, mMaxIterationsNumber, mX, and null.

Referenced by MATH_ZeroEquation::copy(), MATH_NewtonEquation::copy(), and MATH_TranscendentEquation::copy().

Here is the call graph for this function:

Here is the caller 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:

tReal MATH_Equation::getError ( ) const

inline

get the error estimated with the solution

References mError.

Referenced by copy(), and MATH_NewtonEquation::hasSucceeded().

Here is the caller graph for this function:

const MATH_Function* MATH_Equation::getFunction ( ) const

inline

get the function

Referenced by MATH_NewtonEquation::hasFunction(), and hasFunction().

Here is the caller graph for this function:

MATH_Function* MATH_Equation::getFunction ( )

inline

get the 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:

void MATH_Equation::getInterval	(	tReal &	a,
		tReal &	b
	)		const

inline

get interval of searching

Referenced by MATH_NewtonEquation::solve().

Here is the caller graph for this function:

int MATH_Equation::getIterationsNumber ( ) const

inline

get the iterations number to reach the solution

References mIterationsNumber.

Referenced by copy().

Here is the caller graph for this function:

tReal MATH_Equation::getMaxError ( ) const

inline

get the wished max error

References mMaxError.

Referenced by copy(), MATH_NewtonEquation::hasSucceeded(), and MATH_NewtonEquation::solve().

Here is the caller graph for this function:

int MATH_Equation::getMaxIterationsNumber ( ) const

inline

get the max iteration number

References mMaxIterationsNumber.

Referenced by copy(), and MATH_TranscendentEquation::solve().

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 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

tReal MATH_Equation::getSolution ( ) const

inline

get the solution

References mX.

Referenced by copy(), MATH_ZeroEquation::solve(), and MATH_NewtonEquation::solve().

Here is the caller graph for this function:

template<class T >

static tString CORE_Object::getTypeName ( )

inlinestaticinherited

get type name

References tString.

tBoolean UI_Object::hasBeenLoaded ( ) const

inlineinherited

return true if the object has completely been loaded

Referenced by UI_Class::loadAssociation().

Here is the caller graph for this function:

virtual tBoolean MATH_Equation::hasFunction ( ) const

inlinevirtual

return true if the optimized method has function

Reimplemented in MATH_NewtonEquation.

References getFunction(), and null.

Referenced by MATH_ZeroEquation::solve(), and MATH_TranscendentEquation::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual tBoolean MATH_Equation::hasSucceeded ( ) const

inlinevirtual

return true if the method has succeeded

Reimplemented in MATH_NewtonEquation.

Referenced by MATH_NewtonEquation::hasSucceeded().

Here is the caller graph for this function:

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.

void MATH_Equation::loadFromUIClass ( const UI_Class & mclass )

virtual

how to load the object from a Meta Model class

Reimplemented from UI_Object.

Reimplemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

References UI_Class::loadField(), UI_Object::loadFromUIClass(), mError, mInterval, mIterationsNumber, mMaxError, mMaxIterationsNumber, and mX.

Referenced by MATH_ZeroEquation::loadFromUIClass(), MATH_NewtonEquation::loadFromUIClass(), and MATH_TranscendentEquation::loadFromUIClass().

Here is the call graph for this function:

Here is the caller 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:

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:

void MATH_Equation::saveToUIClass ( UI_Class & mclass ) const

virtual

how to save the object from a mate model class

Reimplemented from UI_Object.

Reimplemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

References mError, mInterval, mIterationsNumber, mMaxError, mMaxIterationsNumber, mX, UI_Class::saveField(), and UI_Object::saveToUIClass().

Referenced by MATH_ZeroEquation::saveToUIClass(), MATH_NewtonEquation::saveToUIClass(), and MATH_TranscendentEquation::saveToUIClass().

Here is the call graph for this function:

Here is the caller graph for this function:

void MATH_Equation::setError ( const tReal & err )

inlineprotected

set the error estimated with the solution

Referenced by MATH_NewtonEquation::solve(), and MATH_TranscendentEquation::solve().

Here is the caller graph for this function:

void MATH_Equation::setFunction ( SP::MATH_Function f )

inline

set function

void UI_Object::setHasBeenLoaded ( const tBoolean & v )

inlineinherited

set the if the object has completely been loaded

Referenced by UI_Class::loadAssociation().

Here is the caller graph for this function:

virtual void MATH_Equation::setInterval	(	const tReal &	a,
		const tReal &	b
	)

inlinevirtual

set the interval of searching

Reimplemented in MATH_NewtonEquation.

Referenced by MATH_NewtonEquation::setInterval().

Here is the caller graph for this function:

void MATH_Equation::setIterationsNumber ( const int & n )

inlineprotected

set the iterations number to reach the solution

Referenced by MATH_NewtonEquation::solve(), and MATH_TranscendentEquation::solve().

Here is the caller graph for this function:

void MATH_Equation::setMaxError ( const tReal & err )

inline

set the wished max error

void MATH_Equation::setMaxIterationsNumber ( const int & v )

inline

set max iterations number

static void CORE_Object::setOutput ( ostream & out )

inlinestaticinherited

set output

void MATH_Equation::setSolution ( const tReal & x )

inlineprotected

set the solution

Referenced by MATH_ZeroEquation::solve(), MATH_NewtonEquation::solve(), and MATH_TranscendentEquation::solve().

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_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_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:

virtual tReal MATH_Equation::solve ( )

pure virtual

solve the equation

Implemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

Referenced by MMSD_ConstraintGaussianCluster::updateFreedomDegrees(), and MMSD_GaussianCluster::updateFreedomDegrees().

Here is the caller graph for this function:

virtual tReal MATH_Equation::solve ( const tReal & x0 )

pure virtual

solve the equation with initial point

Implemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

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 MATH_Equation::toString ( ) const

virtual

to string

Reimplemented from CORE_Object.

Reimplemented in MATH_TranscendentEquation, MATH_NewtonEquation, and MATH_ZeroEquation.

References mError, mIterationsNumber, mMaxIterationsNumber, mX, CORE_Real::toString(), CORE_Integer::toString(), and tString.

Referenced by MATH_ZeroEquation::toString(), MATH_NewtonEquation::toString(), and MATH_TranscendentEquation::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const tReal MATH_Equation::EPSILON =1.e-12

static

tReal MATH_Equation::mError

Referenced by copy(), getError(), loadFromUIClass(), MATH_Equation(), saveToUIClass(), and toString().

WP::MATH_Function MATH_Equation::mFunction

tReal MATH_Equation::mInterval[2]

Referenced by loadFromUIClass(), MATH_Equation(), and saveToUIClass().

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().

int MATH_Equation::mIterationsNumber

Referenced by copy(), getIterationsNumber(), loadFromUIClass(), MATH_Equation(), saveToUIClass(), and toString().

tReal MATH_Equation::mMaxError

Referenced by copy(), getMaxError(), loadFromUIClass(), MATH_Equation(), and saveToUIClass().

int MATH_Equation::mMaxIterationsNumber

Referenced by copy(), getMaxIterationsNumber(), loadFromUIClass(), MATH_Equation(), saveToUIClass(), and toString().

tReal MATH_Equation::mX

Referenced by copy(), getSolution(), loadFromUIClass(), MATH_Equation(), saveToUIClass(), and toString().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation