gstlrn::ADrift Class Reference

This class describes one basic Drift Function. More...

#include <ADrift.hpp>

Inheritance diagram for gstlrn::ADrift:

Detailed Description

This class describes one basic Drift Function.

It is the uppermost class of the Drift Tree and is conceived as simple as possible on purpose (in order to let the user defined its own version if necessary): it must simply be able to return its value at the location of one sample from a Db.

This returned value depends on the implementation of this basic drift function and mainly depends upon:

• the space dimension
• the coordinates of the target

If NDIM represents the space dimension, each basic drift function belongs to one of the following categories:

• an internal drift function (DRIFTM) characterized by a vector of coefficients P (of dimension NDIM): it returns the numerical expression elaborated starting from the coordinates (X) of one sample such as:

  X_1**P_1 * X_2**P_2 * ... * X_NDIM**P_NDIM

• an external drift function (DRIFTF) identified by its rank (corresponding locator ELoc::F) for one sample.

Public Member Functions
	ADrift ()
	ADrift (const ADrift &r)
ADrift &	operator= (const ADrift &r)
virtual	~ADrift ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
virtual	getPowers () const
	Interface for daughter classes.
virtual Id	getRankFex () const
virtual String	getDriftName () const =0
virtual Id	getOrderIRF () const =0
virtual Id	getOrderIRFIdim (Id idim) const =0
virtual double	eval (const Db *db, Id iech) const =0
virtual Id	getDriftNDimMax () const
virtual bool	isDriftExternal () const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final
Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0
std::shared_ptr< ICloneable >	cloneShared () const
std::unique_ptr< ICloneable >	cloneUnique () const

Constructor & Destructor Documentation

ADrift() [1/2]

gstlrn::ADrift::ADrift

(

)

ADrift() [2/2]

gstlrn::ADrift::ADrift

(

const ADrift &

r

)

~ADrift()

gstlrn::ADrift::~ADrift ( )

virtual

Member Function Documentation

eval()

virtual double gstlrn::ADrift::eval ( const Db *  db, Id  iech  ) const

pure virtual

Implemented in gstlrn::DriftF, and gstlrn::DriftM.

getDriftName()

virtual String gstlrn::ADrift::getDriftName ( ) const

pure virtual

Implemented in gstlrn::DriftF, and gstlrn::DriftM.

getDriftNDimMax()

virtual Id gstlrn::ADrift::getDriftNDimMax ( ) const

inlinevirtual

Reimplemented in gstlrn::DriftM.

getOrderIRF()

virtual Id gstlrn::ADrift::getOrderIRF ( ) const

pure virtual

Implemented in gstlrn::DriftF, and gstlrn::DriftM.

getOrderIRFIdim()

virtual Id gstlrn::ADrift::getOrderIRFIdim ( Id  idim ) const

pure virtual

Implemented in gstlrn::DriftF, and gstlrn::DriftM.

getPowers()

virtual gstlrn::ADrift::getPowers ( ) const

inlinevirtual

Interface for daughter classes.

Reimplemented in gstlrn::DriftM.

getRankFex()

virtual Id gstlrn::ADrift::getRankFex ( ) const

inlinevirtual

Reimplemented in gstlrn::DriftF.

isDriftExternal()

virtual bool gstlrn::ADrift::isDriftExternal ( ) const

inlinevirtual

Reimplemented in gstlrn::DriftF.

operator=()

ADrift & gstlrn::ADrift::operator=

(

const ADrift &

r

)

toString()

String gstlrn::ADrift::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

---

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

• include/Drifts/ADrift.hpp
• src/Drifts/ADrift.cpp