ACovAnisoList Class Reference

#include <ACovAnisoList.hpp>

Inheritance diagram for ACovAnisoList:

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 double	eval0 (int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const override
virtual double	eval (const SpacePoint &p1, const SpacePoint &p2, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const 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 (unsigned int i)
void	delAllCov ()
void	setFiltered (unsigned int i, bool filtered)
void	setAllFiltered (bool status)
int	getCovNumber () const
bool	isFiltered (unsigned int i) const
bool	hasRange () const
bool	isStationary () const
double	getMaximumDistance () const
double	getTotalSill (int ivar, int jvar) const
MatrixSquareGeneral	getTotalSill () const
void	normalize (double sill)
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
double	getParam (unsigned int icov) const
const MatrixSquareSymmetric &	getSill (unsigned int icov) const
double	getSill (unsigned int icov, int ivar, int jvar) const
int	getGradParamNumber (unsigned int icov) const
void	setSill (unsigned int icov, int ivar, int jvar, double value)
void	setType (unsigned int icov, const ECov &type)
CovAniso	extractCova (int icov) const
int	getMinOrder () const
void	copyCovContext (const CovContext &ctxt)
bool	hasNugget () const
const ACovAnisoList *	reduce (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, int, bool) const
virtual double	evalSpectrum (const VectorDouble &, int, int) const
MatrixSquareGeneral	eval0Nvar (const CovCalcMode &mode=CovCalcMode()) const
VectorDouble	eval (const std::vector< SpacePoint > &vec_p1, const std::vector< SpacePoint > &vec_p2, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
MatrixSquareGeneral	evalMat (const SpacePoint &p1, const SpacePoint &p2, const CovCalcMode &mode=CovCalcMode()) const
double	evalIvarIpas (double step, const VectorDouble &dir, int ivar=0, int jvar=0, const VectorDouble &center=VectorDouble(), const CovCalcMode &mode=CovCalcMode()) const
double	evalIvarIpasIncr (const VectorDouble &dincr, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
VectorDouble	evalIvarNpas (const VectorDouble &vec_step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, const VectorDouble &center=VectorDouble(), const CovCalcMode &mode=CovCalcMode()) const
MatrixSquareGeneral	evalNvarIpas (double step, const VectorDouble &dir, const VectorDouble &center=VectorDouble(), const CovCalcMode &mode=CovCalcMode()) const
MatrixSquareGeneral	evalNvarIpasIncr (const VectorDouble &dincr, const CovCalcMode &mode) const
double	evalIsoIvarIpas (double step, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
VectorDouble	evalIsoIvarNpas (const VectorDouble &vec_step, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
MatrixSquareGeneral	evalIsoNvarIpas (double step, const CovCalcMode &mode=CovCalcMode()) const
double	evalCvv (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) 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=CovCalcMode()) const
MatrixSquareGeneral	evalCvvM (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const CovCalcMode &mode=CovCalcMode()) 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=CovCalcMode()) 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=CovCalcMode()) const
MatrixSquareGeneral	evalCxvM (const SpacePoint &p1, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), const CovCalcMode &mode=CovCalcMode()) const
VectorDouble	evalPointToDb (const SpacePoint &p1, const Db *db2, int ivar=0, int jvar=0, bool useSel=true, const CovCalcMode &mode=CovCalcMode()) const
double	evalAverageDbToDb (const Db *db1, const Db *db2, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
double	evalAveragePointToDb (const SpacePoint &p1, const Db *db2, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
MatrixRectangular	evalCovMatrix (const Db *db1, const Db *db2=nullptr, int ivar=0, int jvar=0, const CovCalcMode &mode=CovCalcMode()) const
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
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 () const
	Shortcuts to ASpace methods. More...
const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2) const
	Return the distance between two space points for the current space context. More...
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) 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

Protected Member Functions
bool	_isCovarianceIndexValid (unsigned int i) const
double	_getNormalizationFactor (int ivar, int jvar, const CovCalcMode &mode) const
Protected Member Functions inherited from ASpaceObject
void	setNDim (int ndim)
	Modify the Space dimension of an already created item (To be used only during creation ... in particular when reading NF) More...

Protected Attributes
std::vector< CovAniso * >	_covs
VectorBool	_filtered
	Vector of elementary covariances. More...
Protected Attributes inherited from ASpaceObject
const ASpace *	_space
	Current space context of the object. More...

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

_getNormalizationFactor()

double ACovAnisoList::_getNormalizationFactor ( int  ivar, int  jvar, const CovCalcMode &  mode  ) const

protected

_isCovarianceIndexValid()

bool ACovAnisoList::_isCovarianceIndexValid ( unsigned int  i ) const

protected

addCov()

void ACovAnisoList::addCov ( const CovAniso *  cov )

virtual

ACovAnisoList Interface.

Reimplemented in CovLMCAnamorphosis, and CovLMGradient.

addCovList()

void ACovAnisoList::addCovList

(

const ACovAnisoList *

covs

)

copyCovContext()

void ACovAnisoList::copyCovContext

(

const CovContext &

ctxt

)

delAllCov()

void ACovAnisoList::delAllCov

(

)

delCov()

void ACovAnisoList::delCov

(

unsigned int

i

)

eval()

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

overridevirtual

Implements ACov.

Reimplemented in CovLMCConvolution, CovLMCTapering, and CovLMCAnamorphosis.

eval0()

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

overridevirtual

Implements ACov.

Reimplemented in CovLMCConvolution, CovLMCTapering, and CovLMCAnamorphosis.

extractCova()

CovAniso ACovAnisoList::extractCova

(

int

icov

)

const

getActiveFactor()

virtual int ACovAnisoList::getActiveFactor ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getAnam()

virtual const AAnam* ACovAnisoList::getAnam ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getAnamNClass()

virtual int ACovAnisoList::getAnamNClass ( ) const

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

getCova() [1/2]

const CovAniso * ACovAnisoList::getCova

(

int

icov

)

const

TODO : to be removed (encapsulation)

getCova() [2/2]

CovAniso * ACovAnisoList::getCova

(

int

icov

)

getCovName()

String ACovAnisoList::getCovName

(

int

icov

)

const

getCovNumber()

int ACovAnisoList::getCovNumber ( ) const

inline

getGradParamNumber()

int ACovAnisoList::getGradParamNumber

(

unsigned int

icov

)

const

getMaximumDistance()

double ACovAnisoList::getMaximumDistance

(

)

const

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

Returns

getMinOrder()

int ACovAnisoList::getMinOrder

(

)

const

getNVariables()

int ACovAnisoList::getNVariables ( ) const

overridevirtual

Interface for ACov.

Implements ACov.

getParam()

double ACovAnisoList::getParam

(

unsigned int

icov

)

const

getSill() [1/2]

const MatrixSquareSymmetric & ACovAnisoList::getSill

(

unsigned int

icov

)

const

getSill() [2/2]

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

getTotalSill() [1/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

getTotalSill() [2/2]

MatrixSquareGeneral ACovAnisoList::getTotalSill

(

)

const

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

isConsistent()

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

overridevirtual

ICloneable interface.

Interface for ASpaceObject

TODO : ACovAnisoList::isConsistent

Implements ASpaceObject.

isFiltered()

bool ACovAnisoList::isFiltered

(

unsigned int

i

)

const

isStationary()

bool ACovAnisoList::isStationary

(

)

const

normalize()

void ACovAnisoList::normalize

(

double

sill

)

operator=()

ACovAnisoList & ACovAnisoList::operator=

(

const ACovAnisoList &

r

)

reduce()

const ACovAnisoList * ACovAnisoList::reduce

(

const VectorInt &

validVars

)

const

setActiveFactor()

virtual void ACovAnisoList::setActiveFactor ( int  )

inlinevirtual

Reimplemented in CovLMCAnamorphosis.

setAllFiltered()

void ACovAnisoList::setAllFiltered

(

bool

status

)

setCova()

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

setFiltered()

void ACovAnisoList::setFiltered	(	unsigned int	i,
		bool	filtered
	)

setSill()

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

setType()

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

toString()

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

overridevirtual

Interface for AStringable Interface.

Reimplemented from ASpaceObject.

Reimplemented in CovLMCConvolution, CovLMCTapering, and CovLMCAnamorphosis.

Member Data Documentation

_covs

std::vector<CovAniso*> ACovAnisoList::_covs

protected

_filtered

VectorBool ACovAnisoList::_filtered

protected

Vector of elementary covariances.

---

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

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