ACovAnisoList Class Reference

This class describes the Covariance as a list of elementary covariances (see CovAniso.hpp for more details) where the calculation rule is simple: the returned value is the sum of each elementary (active) covariance function. More...

#include <ACovAnisoList.hpp>

Inheritance diagram for ACovAnisoList:

Detailed Description

This class describes the Covariance as a list of elementary covariances (see CovAniso.hpp for more details) where the calculation rule is simple: the returned value is the sum of each elementary (active) covariance function.

This class also carry two other important informations:

• a vector giving the status of each elementary covariance item: it may be active or filtered
• a complex structure allowing each parameter (range, sill, anisotropy angle, ...) of each of the elementary covariances to be non-stationary (to have a value which depends on the location). For more details, see ANoStat.hpp.

Public Member Functions
	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	eval0MatInPlace (MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
virtual void	evalMatInPlace (const SpacePoint &p1, const SpacePoint &p2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
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 void	addCov (const CovAniso *cov)
	ACovAnisoList 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 bool	isOptimEnabled () const
	Tell if the use of Optimization is enabled or not. More...
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

ACovAnisoList() [1/2]

ACovAnisoList::ACovAnisoList

(

const ASpace *

space = nullptr

)

ACovAnisoList() [2/2]

ACovAnisoList::ACovAnisoList

(

const ACovAnisoList &

r

)

~ACovAnisoList()

ACovAnisoList::~ACovAnisoList ( )

virtual

Member Function Documentation

addCov()

void ACovAnisoList::addCov ( const CovAniso *  cov )

virtual

ACovAnisoList Interface.

Reimplemented in CovLMGradient, and CovLMCAnamorphosis.

addCovList()

void ACovAnisoList::addCovList

(

const ACovAnisoList *

covs

)

copyCovContext()

void ACovAnisoList::copyCovContext

(

const CovContext &

ctxt

)

createReduce()

const ACovAnisoList * ACovAnisoList::createReduce

(

const VectorInt &

validVars

)

const

delAllCov()

void ACovAnisoList::delAllCov

(

)

delCov()

void ACovAnisoList::delCov

(

int

icov

)

eval()

double ACovAnisoList::eval ( const SpacePoint &  p1, const SpacePoint &  p2, int  ivar = 0, int  jvar = 0, const CovCalcMode *  mode = nullptr  ) const

overridevirtual

Calculate the covariance between two variables and two points (general case)

Implements ACov.

Reimplemented in CovLMCConvolution, CovLMCAnamorphosis, and CovLMCTapering.

eval0()

double ACovAnisoList::eval0 ( int  ivar = 0, int  jvar = 0, const CovCalcMode *  mode = nullptr  ) const

overridevirtual

Calculate the covariance between two variables for 0-distance (stationary case)

Implements ACov.

Reimplemented in CovLMCTapering, CovLMCConvolution, and CovLMCAnamorphosis.

eval0MatInPlace()

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

overridevirtual

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

Reimplemented in CovLMGradient, CovLMCTapering, CovLMCConvolution, and CovLMCAnamorphosis.

evalCovMatrixOptim()

MatrixRectangular ACovAnisoList::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

Evaluate the covariance rectangular matrix between samples of input 'db1' and 'db2'

Parameters

db1	Input Db
db2	Output db
ivar0	Rank of the first variable (-1 for all variables)
jvar0	Rank of the second variable (-1 for all variables)
nbgh1	Vector of indices of active samples in db1 (optional)
nbgh2	Vector of indices of active samples in db2 (optional)
mode	CovCalcMode structure

Returns

evalCovMatrixSymmetricOptim()

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

Evaluate the covariance matrix between samples of input 'db1'

Parameters

db1	Input Db
ivar0	Rank of the first variable (-1 for all variables)
nbgh1	Vector of indices of active samples in db1 (optional)
mode	CovCalcMode structure

Returns

evalMatInPlace()

void ACovAnisoList::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 ACov.

Reimplemented in CovLMGradient, CovLMCTapering, CovLMCConvolution, and CovLMCAnamorphosis.

evalMatOptimInPlace()

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

overridevirtual

Calculate the Matrix of covariance between two elements of two Dbs (defined beforehand)

Parameters

icas1	Origin of the Db containing the first point
iech1	Rank of the first point
icas2	Origin of the Db containing the second point
iech2	Rank of the second point
mat	Covariance matrix (Dimension: nvar * nvar)
mode	Calculation Options

Remarks

: Matrix 'mat' should be dimensioned and initialized beforehand

Implements ACov.

extractCova()

CovAniso ACovAnisoList::extractCova

(

int

icov

)

const

getActiveCovList()

VectorInt ACovAnisoList::getActiveCovList

(

)

const

getActiveFactor()

virtual int ACovAnisoList::getActiveFactor ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getAllActiveCovList()

VectorInt ACovAnisoList::getAllActiveCovList

(

)

const

getAnam()

virtual const AAnam* ACovAnisoList::getAnam ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getAnamNClass()

virtual int ACovAnisoList::getAnamNClass ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getCova() [1/2]

CovAniso * ACovAnisoList::getCova

(

int

icov

)

getCova() [2/2]

const CovAniso * ACovAnisoList::getCova

(

int

icov

)

const

TODO : to be removed (encapsulation)

getCovaMinIRFOrder()

int ACovAnisoList::getCovaMinIRFOrder

(

)

const

Returns

The Minimum IRF-order induced by the covariances

getCovaNumber()

int ACovAnisoList::getCovaNumber

(

bool

skipNugget = false

)

const

getCovName()

String ACovAnisoList::getCovName

(

int

icov

)

const

getGradParamNumber()

int ACovAnisoList::getGradParamNumber

(

int

icov

)

const

getMaximumDistance()

double ACovAnisoList::getMaximumDistance

(

)

const

Returns the largest range (in any direction in the heterotopic case)

Returns

getNVariables()

int ACovAnisoList::getNVariables ( ) const

overridevirtual

Interface for ACov.

Implements ACov.

getParam()

double ACovAnisoList::getParam

(

int

icov

)

const

getRange()

double ACovAnisoList::getRange

(

int

icov

)

const

getRanges()

VectorDouble ACovAnisoList::getRanges

(

int

icov

)

const

getRankNugget()

int ACovAnisoList::getRankNugget

(

)

const

getSill() [1/2]

const MatrixSquareSymmetric & ACovAnisoList::getSill

(

int

icov

)

const

getSill() [2/2]

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

getTotalSill() [1/2]

MatrixSquareSymmetric ACovAnisoList::getTotalSill

(

)

const

getTotalSill() [2/2]

double ACovAnisoList::getTotalSill	(	int	ivar,
		int	jvar
	)		const

Calculate the total sill of the model for given pair of variables Returns TEST as soon as one structure has no sill

Parameters

ivar	Rank of the first variable
jvar	Rank of the second variable

getType()

const ECov & ACovAnisoList::getType

(

int

icov

)

const

hasAnam()

virtual bool ACovAnisoList::hasAnam ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

hasNugget()

bool ACovAnisoList::hasNugget

(

)

const

hasRange()

bool ACovAnisoList::hasRange

(

)

const

isAllActiveCovList()

bool ACovAnisoList::isAllActiveCovList

(

)

const

isConsistent()

bool ACovAnisoList::isConsistent ( const ASpace *  space ) const

overridevirtual

ICloneable interface.

Interface for ASpaceObject

TODO : ACovAnisoList::isConsistent

Implements ASpaceObject.

isFiltered()

bool ACovAnisoList::isFiltered

(

int

icov

)

const

isIndexable()

virtual bool ACovAnisoList::isIndexable ( ) const

inlineoverridevirtual

Reimplemented from ACov.

isNoStat()

bool ACovAnisoList::isNoStat ( ) const

overridevirtual

Reimplemented from ACov.

isOptimizationInitialized()

bool ACovAnisoList::isOptimizationInitialized

(

const Db *

db = nullptr

)

const

isStationary()

bool ACovAnisoList::isStationary

(

)

const

normalize()

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

operator=()

ACovAnisoList & ACovAnisoList::operator=

(

const ACovAnisoList &

r

)

optimizationPostProcess()

void ACovAnisoList::optimizationPostProcess

(

)

const

optimizationPreProcess()

void ACovAnisoList::optimizationPreProcess

(

const Db *

db

)

const

optimizationSetTarget() [1/2]

void ACovAnisoList::optimizationSetTarget

(

const SpacePoint &

pt

)

const

optimizationSetTarget() [2/2]

void ACovAnisoList::optimizationSetTarget

(

int

iech

)

const

setActiveFactor()

virtual void ACovAnisoList::setActiveFactor ( int  )

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

setCova()

void ACovAnisoList::setCova	(	int	icov,
		CovAniso *	covs
	)

setFiltered()

void ACovAnisoList::setFiltered	(	int	icov,
		bool	filtered
	)

setMarkovCoeffs()

void ACovAnisoList::setMarkovCoeffs	(	int	icov,
		VectorDouble	coeffs
	)

setParam()

void ACovAnisoList::setParam	(	int	icov,
		double	value
	)

setRangeIsotropic()

void ACovAnisoList::setRangeIsotropic	(	int	icov,
		double	range
	)

setSill()

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

setType()

void ACovAnisoList::setType	(	int	icov,
		const ECov &	type
	)

toString()

String ACovAnisoList::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface for AStringable Interface.

Reimplemented from ASpaceObject.

Reimplemented in CovLMCTapering, CovLMCConvolution, and CovLMCAnamorphosis.

updateCovByPoints()

void ACovAnisoList::updateCovByPoints ( int  icas1, int  iech1, int  icas2, int  iech2  )

overridevirtual

Update the Model according to the Non-stationary parameters

Parameters

icas1	Type of first Db: 1 for Input; 2 for Output
iech1	Rank of the target within Db1 (or -1)
icas2	Type of first Db: 1 for Input; 2 for Output
iech2	Rank of the target within Dbout (or -2)

Reimplemented from ACov.

---

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

• include/Covariances/ACovAnisoList.hpp
• src/Covariances/ACovAnisoList.cpp