#include <CovLMGradient.hpp>

Inheritance diagram for CovLMGradient:

Public Member Functions
	CovLMGradient (const ASpace *space=nullptr)

	CovLMGradient (const CovLMGradient &r)

	CovLMGradient (const ACovAnisoList &r)

CovLMGradient &	operator= (const CovLMGradient &r)

virtual	~CovLMGradient ()

virtual void	addCov (const CovAniso *cov) override
	ICloneable interface. More...

virtual void	eval0MatInPlace (MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
	ACov interface. More...

virtual void	evalMatInPlace (const SpacePoint &p1, const SpacePoint &p2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override

virtual bool	isOptimEnabled () const override
	Tell if the use of Optimization is enabled or not. More...

void	evalZAndGradients (const SpacePoint &p1, const SpacePoint &p2, double &covVal, VectorDouble &covGp, VectorDouble &covGG, const CovCalcMode *mode=nullptr, bool flagGrad=false) const

void	evalZAndGradients (const VectorDouble &vec, double &covVal, VectorDouble &covGp, VectorDouble &covGG, const CovCalcMode *mode=nullptr, bool flagGrad=false) const

Public Member Functions inherited from ACovAnisoList
	ACovAnisoList (const ASpace *space=nullptr)

	ACovAnisoList (const ACovAnisoList &r)

ACovAnisoList &	operator= (const ACovAnisoList &r)

virtual	~ACovAnisoList ()

virtual bool	isConsistent (const ASpace *space) const override
	ICloneable interface. More...

virtual int	getNVariables () const override
	Interface for ACov. More...

virtual bool	isIndexable () const override

virtual double	eval0 (int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override
	Calculate the covariance between two variables for 0-distance (stationary case) More...

virtual double	eval (const SpacePoint &p1, const SpacePoint &p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override
	Calculate the covariance between two variables and two points (general case) More...

virtual void	evalMatOptimInPlace (int icas1, int iech1, int icas2, int iech2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override

virtual void	updateCovByPoints (int icas1, int iech1, int icas2, int iech2) override

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface for AStringable Interface. More...

virtual bool	hasAnam () const

virtual const AAnam *	getAnam () const

virtual void	setActiveFactor (int)

virtual int	getActiveFactor () const

virtual int	getAnamNClass () const

void	addCovList (const ACovAnisoList *covs)

void	delCov (int icov)

void	delAllCov ()

void	setFiltered (int icov, bool filtered)

int	getCovaNumber (bool skipNugget=false) const

bool	isFiltered (int icov) const

bool	hasRange () const

bool	isStationary () const

double	getMaximumDistance () const

double	getTotalSill (int ivar, int jvar) const

MatrixSquareSymmetric	getTotalSill () const

void	normalize (double sill=1., int ivar=0, int jvar=0)

VectorInt	getActiveCovList () const

VectorInt	getAllActiveCovList () const

bool	isAllActiveCovList () const

bool	isNoStat () const override

const CovAniso *	getCova (int icov) const
	TODO : to be removed (encapsulation) More...

CovAniso *	getCova (int icov)

void	setCova (int icov, CovAniso *covs)

const ECov &	getType (int icov) const

String	getCovName (int icov) const

void	setRangeIsotropic (int icov, double range)

void	setType (int icov, const ECov &type)

void	setParam (int icov, double value)

void	setSill (int icov, int ivar, int jvar, double value)

void	setMarkovCoeffs (int icov, VectorDouble coeffs)

double	getParam (int icov) const

double	getRange (int icov) const

VectorDouble	getRanges (int icov) const

const MatrixSquareSymmetric &	getSill (int icov) const

double	getSill (int icov, int ivar, int jvar) const

int	getGradParamNumber (int icov) const

CovAniso	extractCova (int icov) const

int	getCovaMinIRFOrder () const

bool	isOptimizationInitialized (const Db *db=nullptr) const

void	optimizationPreProcess (const Db *db) const

void	optimizationPostProcess () const

void	optimizationSetTarget (const SpacePoint &pt) const

void	optimizationSetTarget (int iech) const

MatrixRectangular	evalCovMatrixOptim (const Db db1, const Db db2, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr) const

MatrixSquareSymmetric	evalCovMatrixSymmetricOptim (const Db db1, int ivar0=-1, const VectorInt &nbgh1=VectorInt(), const CovCalcMode mode=nullptr) const

void	copyCovContext (const CovContext &ctxt)

bool	hasNugget () const

int	getRankNugget () const

const ACovAnisoList *	createReduce (const VectorInt &validVars) const

Public Member Functions inherited from ACov
	ACov (const ASpace *space=nullptr)

	ACov (const ACov &r)

ACov &	operator= (const ACov &r)

virtual	~ACov ()

virtual double	evalCovOnSphere (double alpha, int degree=50, bool flagScaleDistance=false, const CovCalcMode *mode=nullptr) const

virtual VectorDouble	evalSpectrumOnSphere (int n, bool flagNormDistance=false, bool flagCumul=false) const

virtual double	evalSpectrum (const VectorDouble &freq, int ivar, int jvar) const

void	setOptimEnabled (bool isOptimEnabled)

VectorDouble	eval (const std::vector< SpacePoint > &vec_p1, const std::vector< SpacePoint > &vec_p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	eval0Mat (const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalMat (const SpacePoint &p1, const SpacePoint &p2, const CovCalcMode *mode=nullptr) const

double	evalIvarIpas (double step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalIvarIpasIncr (const VectorDouble &dincr, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

VectorDouble	evalIvarNpas (const VectorDouble &vec_step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalNvarIpas (double step, const VectorDouble &dir=VectorDouble(), const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalNvarIpasIncr (const VectorDouble &dincr, const CovCalcMode *mode=nullptr) const

double	evalIsoIvarIpas (double step, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

VectorDouble	evalIsoIvarNpas (const VectorDouble &vec_step, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalIsoNvarIpas (double step, const CovCalcMode *mode=nullptr) const

double	evalCvv (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalCvvShift (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &shift, const VectorDouble &angles=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalCvvM (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const CovCalcMode *mode=nullptr) const

double	evalCxv (const SpacePoint &p1, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalCxv (const Db db, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode mode=nullptr) const

MatrixSquareGeneral	evalCxvM (const SpacePoint &p1, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), const CovCalcMode *mode=nullptr) const

VectorDouble	evalPointToDb (const SpacePoint &p1, const Db db2, int ivar=0, int jvar=0, bool useSel=true, const VectorInt &nbgh2=VectorInt(), const CovCalcMode mode=nullptr) const

VectorDouble	evalPointToDbAsSP (const std::vector< SpacePoint > &p1s, const SpacePoint &p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalAverageDbToDb (const Db db1, const Db db2, int ivar=0, int jvar=0, double eps=0., int seed=434132, const CovCalcMode *mode=nullptr) const

double	evalAverageIncrToIncr (const VectorVectorDouble &d1, const VectorVectorDouble &d2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalAveragePointToDb (const SpacePoint &p1, const Db db2, int ivar=0, int jvar=0, const CovCalcMode mode=nullptr) const

MatrixRectangular	evalCovMatrix (const Db db1_arg, const Db db2_arg=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr)

MatrixSquareSymmetric	evalCovMatrixSymmetric (const Db db1, int ivar0, const VectorInt &nbgh1, const CovCalcMode mode)

MatrixSparse *	evalCovMatrixSparse (const Db db1_arg, const Db db2_arg=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, double eps=EPSILON3)

double	extensionVariance (const Db *db, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0) const

double	samplingDensityVariance (const Db *db, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0) const

double	specificVolume (const Db *db, double mean, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0) const

double	coefficientOfVariation (const Db *db, double volume, double mean, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0) const

double	specificVolumeFromCoV (Db *db, double cov, double mean, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0) const

void	manage (const Db db1, const Db db2) const

Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)

	ASpaceObject (const ASpace &space)

	ASpaceObject (const ASpaceObject &r)

ASpaceObject &	operator= (const ASpaceObject &r)

virtual	~ASpaceObject ()

const ASpace *	getSpace () const
	Accessor to the current object space context. More...

bool	isConsistent () const
	Indicate if I am consistent with my current space context. More...

VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context. More...

unsigned int	getNDim (int ispace=-1) const
	Shortcuts to ASpace methods. More...

const VectorDouble &	getOrigin (int ispace=-1) const
	Return the current space context origin coordinates. More...

double	getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the distance between two space points for the current space context. More...

VectorDouble	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context. More...

double	getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim) const
	Return the distance along one direction between two space points. More...

VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the increment vector between two space points for the current space context. More...

Public Member Functions inherited from 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 (int level) const final

Public Member Functions inherited from ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

Constructor & Destructor Documentation

◆ CovLMGradient() [1/3]

CovLMGradient::CovLMGradient ( const ASpace * space = nullptr )

◆ CovLMGradient() [2/3]

CovLMGradient::CovLMGradient ( const CovLMGradient & r )

◆ CovLMGradient() [3/3]

CovLMGradient::CovLMGradient ( const ACovAnisoList & r )

◆ ~CovLMGradient()

CovLMGradient::~CovLMGradient ( )

virtual

TODO : Delete pointers ?

Member Function Documentation

◆ addCov()

void CovLMGradient::addCov ( const CovAniso * cov )

overridevirtual

ICloneable interface.

Reimplemented from ACovAnisoList.

◆ eval0MatInPlace()

void CovLMGradient::eval0MatInPlace	(	MatrixSquareGeneral &	mat,
		const CovCalcMode *	mode = `nullptr`
	)		const

overridevirtual

ACov interface.

Calculate the Matrix of covariance for zero distance

Parameters

mat	Covariance matrix (Dimension: nvar * nvar)
mode	Calculation Options

Remarks: : Matrix 'mat' should be dimensioned and initialized beforehand

Reimplemented from ACovAnisoList.

◆ evalMatInPlace()

void CovLMGradient::evalMatInPlace	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		MatrixSquareGeneral &	mat,
		const CovCalcMode *	mode = `nullptr`
	)		const

overridevirtual

Calculate the Matrix of covariance between two space points

Parameters

p1	Reference of the first space point
p2	Reference of the second space point
mat	Covariance matrix (Dimension: nvar * nvar)
mode	Calculation Options

Remarks: : Matrix 'mat' should be dimensioned and initialized beforehand

Reimplemented from ACovAnisoList.

◆ evalZAndGradients() [1/2]

void CovLMGradient::evalZAndGradients	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		double &	covVal,
		VectorDouble &	covGp,
		VectorDouble &	covGG,
		const CovCalcMode *	mode = `nullptr`,
		bool	flagGrad = `false`
	)		const

◆ evalZAndGradients() [2/2]

void CovLMGradient::evalZAndGradients	(	const VectorDouble &	vec,
		double &	covVal,
		VectorDouble &	covGp,
		VectorDouble &	covGG,
		const CovCalcMode *	mode = `nullptr`,
		bool	flagGrad = `false`
	)		const

TODO : Not true whatever the space

◆ isOptimEnabled()

virtual bool CovLMGradient::isOptimEnabled ( ) const

inlineoverridevirtual

Tell if the use of Optimization is enabled or not.

Reimplemented from ACov.

◆ operator=()

CovLMGradient & CovLMGradient::operator= ( const CovLMGradient & r )

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

include/Covariances/CovLMGradient.hpp
src/Covariances/CovLMGradient.cpp

Public Member Functions

Constructor & Destructor Documentation

◆ CovLMGradient() [1/3]

◆ CovLMGradient() [2/3]

◆ CovLMGradient() [3/3]

◆ ~CovLMGradient()

Member Function Documentation

◆ addCov()

◆ eval0MatInPlace()

◆ evalMatInPlace()

◆ evalZAndGradients() [1/2]

◆ evalZAndGradients() [2/2]

◆ isOptimEnabled()

◆ operator=()