This class describes an elementary covariance. More...

#include <CovAniso.hpp>

Inheritance diagram for CovAniso:

Detailed Description

This class describes an elementary covariance.

This covariance is described through the following list of parameters:

the covariance type: the list of these types is provided in ECov.hpp
the largest set of parameters for any covariance: range(s), anisotropy angle(s), third parameter. Some of these parameters do not make sense, depending on the covariance type: e.g. the range for nugget effect, the third parameter for a spherical structure, ... All these parameters are processed and stored as a tensor in order to avoid repetitive calculations.
the sill. This comes as a square symmetric matrix whose dimension is equal to the number of variables.

Public Member Functions
	CovAniso (const ECov &type, const CovContext &ctxt)

	CovAniso (const String &symbol, const CovContext &ctxt)

	CovAniso (const ECov &type, double range, double param, double sill, const CovContext &ctxt, bool flagRange=true)

	CovAniso (const CovAniso &r)

CovAniso &	operator= (const CovAniso &r)

virtual	~CovAniso ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable Interface.

virtual double	eval0 (int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override
	ASpaceObject Interface.

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

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

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

virtual double	getIntegralRange (int ndisc, double hmax) const

virtual String	getFormula () const

virtual double	getBallRadius () const

bool	isValidForTurningBand () const

double	simulateTurningBand (double t0, TurningBandOperate &operTB) const

bool	isValidForSpectral () const

MatrixDense	simulateSpectralOmega (int nb) const

void	setParam (double param)

void	setRangeIsotropic (double range)
	Practical range.

void	setRange (int idim, double range)

void	setRanges (const VectorDouble &ranges)

void	setScale (double scale)

void	setScale (int idim, double scale)
	Make the covariance isotropic.

void	setScales (const VectorDouble &scales)

void	setAnisoRotation (const Rotation &rot)

void	setAnisoRotation (const VectorDouble &rot)

void	setAnisoAngles (const VectorDouble &angles)

void	setAnisoAngle (int idim, double angle)

void	setRotationAnglesAndRadius (const VectorDouble &angles=VectorDouble(), const VectorDouble &ranges=VectorDouble(), const VectorDouble &scales=VectorDouble())

const CorAniso *	getCorAniso () const

double	getSlope (int ivar, int jvar) const

VectorDouble	getRanges () const

const Rotation &	getAnisoRotation () const

const VectorDouble &	getScales () const

void	setType (const ECov &type)

double	getRange () const

double	getScale () const

bool	getFlagAniso () const

bool	getFlagRotation () const

double	getRange (int idim) const

double	getScale (int idim) const

VectorDouble	getAnisoAngles () const

const MatrixSquare &	getAnisoRotMat () const

const MatrixSquare &	getAnisoInvMat () const

VectorDouble	getAnisoCoeffs () const

double	getAnisoAngles (int idim) const

double	getAnisoRotMat (int idim, int jdim) const

double	getAnisoCoeffs (int idim) const

const CovContext &	getContext () const

const ECov &	getType () const

double	getParam () const

double	getScadef () const

double	getParMax () const

int	getMaxNDim () const

int	getMinOrder () const

bool	hasInt1D () const

bool	hasInt2D () const

int	hasRange () const

int	hasParam () const

String	getCovName () const

bool	isIsotropic () const

bool	isAsymptotic () const

bool	hasRotation () const

const Tensor &	getAniso () const

void	setAniso (const Tensor &aniso)

const ACovFunc *	getCorFunc () const

int	getNGradParam () const

bool	hasCovDerivative () const

bool	hasCovOnSphere () const

bool	hasSpectrumOnSphere () const

bool	hasMarkovCoeffs () const

bool	hasSpectrumOnRn () const

double	normalizeOnSphere (int n=50) const

bool	isNoStatForParam () const

bool	isNoStatForTensor () const

bool	isNoStatForAnisotropy () const

bool	isNoStatForRotation () const

void	makeRangeNoStatDb (const String &namecol, int idim=0, const Db *db=nullptr)

void	makeScaleNoStatDb (const String &namecol, int idim=0, const Db *db=nullptr)

void	makeAngleNoStatDb (const String &namecol, int idim=0, const Db *db=nullptr)

void	makeTensorNoStatDb (const String &namecol, int idim=0, int jdim=0, const Db *db=nullptr)

void	makeParamNoStatDb (const String &namecol, const Db *db=nullptr)

void	makeRangeNoStatFunctional (const AFunctional *func, int idim=0)

void	makeScaleNoStatFunctional (const AFunctional *func, int idim=0)

void	makeAngleNoStatFunctional (const AFunctional *func, int idim=0)

void	makeTensorNoStatFunctional (const AFunctional *func, int idim=0, int jdim=0)

void	makeParamNoStatFunctional (const AFunctional *func)

void	makeRangeStationary (int idim=0)

void	makeScaleStationary (int idim=0)

void	makeAngleStationary (int idim=0)

void	makeTensorStationary (int idim, int jdim)

void	makeParamStationary ()

VectorDouble	evalCovOnSphereVec (const VectorDouble &alpha, int degree=50, bool flagScaleDistance=false, const CovCalcMode *mode=nullptr) const

Array	evalCovFFT (const VectorDouble &hmax, int N=128, int ivar=0, int jvar=0) const

VectorDouble	getMarkovCoeffs () const

void	setMarkovCoeffs (const VectorDouble &coeffs)

void	setMarkovCoeffsBySquaredPolynomials (const VectorDouble &coeffs1, const VectorDouble &coeffs2, double eps=0)

void	computeMarkovCoeffs ()

double	getCorrec () const

double	getFullCorrec () const

int	getNDim () const

CorAniso *	getCorAniso ()

CovAniso *	createReduce (const VectorInt &validVars) const

void	informDbInForAnisotropy (const Db *dbin) const

void	informDbOutForAnisotropy (const Db *dbout) const

void	informMeshByMeshForAnisotropy (const AMesh *amesh) const

void	informMeshByApexForAnisotropy (const AMesh *amesh) const

bool	_isOptimEnabled () const override

int	getNAngles () const

int	getNRanges () const

int	getNScales () const

void	_computeCorrec ()

double	_getDetTensor () const

double	_getSillValue (int ivar, int jvar, const CovCalcMode *mode) const

virtual double	_eval (const SpacePoint &p1, const SpacePoint &p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override

Public Member Functions inherited from CovProportional
	CovProportional (ACov *cor=nullptr, const MatrixSymmetric &sills=MatrixSymmetric())

	CovProportional (const CovProportional &r)

CovProportional &	operator= (const CovProportional &r)

virtual	~CovProportional ()

void	setCor (ACov *cor) override

Public Member Functions inherited from CovBase
	CovBase (ACov *cor=nullptr, const MatrixSymmetric &sills=MatrixSymmetric())

	CovBase (const CovBase &r)

CovBase &	operator= (const CovBase &r)

virtual	~CovBase ()

ParamInfo	createParamInfoForCholSill (int ivar=0, int jvar=0)

virtual bool	isConsistent (const ASpace *space) const override

virtual int	getNVar () const override
	ACov Interface.

bool	isOptimizationInitialized (const Db *db=nullptr) const

void	loadInfoValues () override

void	setCholSill (int ivar, int jvar, double val) const

virtual void	setSill (double sill) const

virtual void	setSill (const MatrixSymmetric &sill) const
	Only valid when there is only one variable (in the context)

virtual void	setSill (const VectorDouble &sill) const

virtual void	setSill (int ivar, int jvar, double sill) const

void	initSill (double value=0.)

const MatrixSymmetric &	getSill () const

const ACov *	getCor () const

double	getSill (int ivar, int jvar) const

void	makeSillNoStatDb (const String &namecol, int ivar=0, int jvar=0, const Db *db=nullptr)

void	makeSillStationary (int ivar=0, int jvar=0)

void	makeSillsStationary (bool silent=false)

void	makeSillNoStatFunctional (const AFunctional *func, int ivar=0, int jvar=0)

TabNoStatSills *	getTabNoStatSills () const

int	getNSills () const

bool	isNoStatForVariance () const

void	informMeshByMesh (const AMesh *amesh) const

void	informMeshByApex (const AMesh *amesh) const

VectorDouble	informCoords (const VectorVectorDouble &coords, const EConsElem &econs, int iv1=0, int iv2=0) const

void	informDbIn (const Db *dbin) const

void	informDbOut (const Db *dbout) const

void	informMeshByMeshForSills (const AMesh *amesh) const

void	informMeshByApexForSills (const AMesh *amesh) const

void	informDbInForSills (const Db *dbin) const

void	informDbOutForSills (const Db *dbout) const

void	updateCovByPoints (int icas1, int iech1, int icas2, int iech2) const override
	Tell if the use of Optimization is enabled or not.

void	updateCovByMesh (int imesh, bool aniso=true) const override

double	getValue (const EConsElem &econs, int iv1, int iv2) const override

void	nostatUpdate (CovInternal *covint) const

int	addEvalCovVecRHSInPlace (vect vect, const VectorInt &index1, int iech2, const KrigOpt &krigopt, SpacePoint &pin, SpacePoint &pout, VectorDouble &tabwork, double lambda=1.) const override

void	setOptimEnabled (bool flag) const override

int	makeElemNoStat (const EConsElem &econs, int iv1, int iv2, const AFunctional func=nullptr, const Db db=nullptr, const String &namecol=String()) override

Public Member Functions inherited from ACov
	ACov (const CovContext &ctxt=CovContext())

	ACov (const ACov &r)

ACov &	operator= (const ACov &r)

virtual	~ACov ()

virtual bool	isIndexable () const

bool	isNoStat () const

const CovContext &	getContext () const

void	setContext (const CovContext &ctxt)

void	updateFromContext ()

virtual void	copyCovContext (const CovContext &ctxt)

void	initFromContext ()

CovContext	getContextCopy () const

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

void	attachNoStatDb (const Db *db)

virtual bool	isOptimEnabled () const
	Functions linked to Optimization during Covariance calculations.

void	optimizationPreProcess (int mode, const std::vector< SpacePoint > &ps) const

SpacePoint &	optimizationLoadInPlace (int iech, int mode, int rank) const

void	optimizationPostProcess () const

void	optimizationSetTarget (SpacePoint &pt) const

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
	Functions for evaluating Covariances.

MatrixSymmetric	eval0Mat (const CovCalcMode *mode=nullptr) const

MatrixSymmetric	evalCovMat0 (const Db *db, int iech, const KrigOpt &krigopt=KrigOpt()) const
	Functions for evaluating Covariance Matrices either in place or not.

MatrixDense	evalCovMat (const Db db1, const Db db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, bool cleanOptim=true) const

MatrixSymmetric	evalCovMatSym (const Db db1, const VectorInt &nbgh1=VectorInt(), int ivar0=-1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const

MatrixSparse *	evalCovMatSparse (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, bool cleanOptim=true, double eps=EPSILON3) const

int	evalCovMat0InPlace (MatrixSymmetric &mat, const Db *db, int iech, const KrigOpt &krigopt=KrigOpt()) const

int	evalCovMatInPlace (MatrixDense &mat, const Db db1, const Db db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, bool cleanOptim=true) const

int	evalCovMatSymInPlace (MatrixSymmetric &mat, const Db db1, const VectorInt &nbgh1=VectorInt(), int ivar0=-1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const

int	evalCovMatInPlaceFromIdx (MatrixDense &mat, const Db db1, const Db db2, const VectorVectorInt &index1, const VectorVectorInt &index2, const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, bool cleanOptim=true) const

int	evalCovMatSymInPlaceFromIdx (MatrixSymmetric &mat, const Db db1, const VectorVectorInt &index1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const

int	evalCovMatRHSInPlaceFromIdx (MatrixDense &mat, const Db db1, const Db db2, const VectorVectorInt &index1, const int iech2=-1, const KrigOpt &krigopt=KrigOpt(), bool cleanOptim=true) const

int	evalCovVecRHSInPlace (vect vect, const Db *db2, const VectorInt &index1, int iech2, const KrigOpt &krigopt, SpacePoint &pin, SpacePoint &pout, VectorDouble &tabwork, double lambda=1.) const

void	eval0CovMatBiPointInPlace (MatrixSymmetric &mat, const CovCalcMode *mode) 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	evalIvarNlag (const VectorDouble &vec_step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

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

MatrixSquare	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	evalIsoIvarNlag (const VectorDouble &vec_step, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquare	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

MatrixSquare	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

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

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

void	evalPointToDbAsSP (VectorDouble &values, 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

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

double	evaluateOneGeneric (const CovInternal covint, const VectorDouble &d1=VectorDouble(), double weight=1., const CovCalcMode mode=nullptr) const

double	calculateStDev (Db db1, int iech1, Db db2, int iech2, bool verbose=false, double factor=1., const CovCalcMode *mode=nullptr) const

void	evaluateMatInPlace (const CovInternal covint, const VectorDouble &d1, MatrixSquare &covtab, bool flag_init=false, double weight=1., const CovCalcMode mode=nullptr) const

VectorDouble	evaluateFromDb (Db db, int ivar=0, int jvar=0, const CovCalcMode mode=nullptr) const

double	evaluateOneIncr (double hh, const VectorDouble &codir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

VectorDouble	sample (const VectorDouble &h, const VectorDouble &codir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode mode=nullptr, const CovInternal covint=nullptr) const

VectorDouble	sampleUnitary (const VectorDouble &hh, int ivar=0, int jvar=0, VectorDouble codir=VectorDouble(), const CovCalcMode *mode=nullptr) const

VectorDouble	envelop (const VectorDouble &hh, int ivar=0, int jvar=0, int isign=1, VectorDouble codir=VectorDouble(), const CovCalcMode *mode=nullptr) const

int	buildVmapOnDbGrid (DbGrid *dbgrid, const NamingConvention &namconv=NamingConvention("VMAP")) const

double	gofToVario (const Vario *vario, bool verbose=true) const

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

void	load (const SpacePoint &p, bool case1) const

void	makeStationary ()

void	createNoStatTab ()

void	informMeshByMesh (const AMesh *amesh) const

void	informMeshByApex (const AMesh *amesh) const

VectorDouble	informCoords (const VectorVectorDouble &coords, const EConsElem &econs, int iv1=0, int iv2=0) const

void	informDbIn (const Db *dbin) const

void	informDbOut (const Db *dbout) const

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

int	getNDim (int ispace=-1) const

void	optimizationPreProcessForData (const Db *db1=nullptr) const

bool	checkAndManageNoStatDb (const Db *db, const String &namecol)

std::shared_ptr< const Db >	getDbNoStat () const

const Db *	getDbNoStatRaw () const

void	setNoStatDbIfNecessary (const Db *db)

void	setNoStatDbIfNecessary (std::shared_ptr< const Db > &db)

Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpaceSharedPtr &space=ASpaceSharedPtr())

	ASpaceObject (const ASpaceObject &r)

ASpaceObject &	operator= (const ASpaceObject &r)

virtual	~ASpaceObject ()

ASpaceSharedPtr	getSpace () const
	Accessor to the current object space context.

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

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

bool	isConsistent (const ASpaceSharedPtr &space) const
	Indicate if I am consistent with the provided space.

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

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

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

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

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.

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

Static Public Member Functions
static CovAniso *	createFromParam (const ECov &type, double range, double sill, double param, const VectorDouble &ranges, const MatrixSymmetric &sills, const VectorDouble &angles, const ASpaceSharedPtr &space, bool flagRange)

static CovAniso *	createIsotropic (const CovContext &ctxt, const ECov &type, double range, double sill=1., double param=1., bool flagRange=true)

static CovAniso *	createAnisotropic (const CovContext &ctxt, const ECov &type, const VectorDouble &ranges, double sill=1., double param=1., const VectorDouble &angles=VectorDouble(), bool flagRange=true)

static CovAniso *	createIsotropicMulti (const CovContext &ctxt, const ECov &type, double range, const MatrixSymmetric &sills, double param=1., bool flagRange=true)

static CovAniso *	createAnisotropicMulti (const CovContext &ctxt, const ECov &type, const VectorDouble &ranges, const MatrixSymmetric &sills, double param=1., const VectorDouble &angles=VectorDouble(), bool flagRange=true)

Static Public Member Functions inherited from ACov
static void	gofDisplay (double gof, bool byValue=true, const VectorDouble &thresholds={2., 5., 10., 100})

Constructor & Destructor Documentation

◆ CovAniso() [1/4]

CovAniso::CovAniso	(	const ECov &	type,
		const CovContext &	ctxt
	)

◆ CovAniso() [2/4]

CovAniso::CovAniso	(	const String &	symbol,
		const CovContext &	ctxt
	)

◆ CovAniso() [3/4]

CovAniso::CovAniso	(	const ECov &	type,
		double	range,
		double	param,
		double	sill,
		const CovContext &	ctxt,
		bool	flagRange = `true`
	)

◆ CovAniso() [4/4]

CovAniso::CovAniso ( const CovAniso & r )

◆ ~CovAniso()

CovAniso::~CovAniso ( )

virtual

Member Function Documentation

◆ _computeCorrec()

void CovAniso::_computeCorrec ( )

◆ _eval()

double CovAniso::_eval	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

overridevirtual

Reimplemented from CovBase.

◆ _getDetTensor()

double CovAniso::_getDetTensor ( ) const

◆ _getSillValue()

double CovAniso::_getSillValue	(	int	ivar,
		int	jvar,
		const CovCalcMode *	mode
	)		const

◆ _isOptimEnabled()

bool CovAniso::_isOptimEnabled ( ) const

inlineoverridevirtual

Reimplemented from ACov.

◆ computeMarkovCoeffs()

void CovAniso::computeMarkovCoeffs ( )

◆ createAnisotropic()

CovAniso * CovAniso::createAnisotropic	(	const CovContext &	ctxt,
		const ECov &	type,
		const VectorDouble &	ranges,
		double	sill = `1.`,
		double	param = `1.`,
		const VectorDouble &	angles = `VectorDouble()`,
		bool	flagRange = `true`
	)

static

◆ createAnisotropicMulti()

CovAniso * CovAniso::createAnisotropicMulti	(	const CovContext &	ctxt,
		const ECov &	type,
		const VectorDouble &	ranges,
		const MatrixSymmetric &	sills,
		double	param = `1.`,
		const VectorDouble &	angles = `VectorDouble()`,
		bool	flagRange = `true`
	)

static

◆ createFromParam()

CovAniso * CovAniso::createFromParam	(	const ECov &	type,
		double	range,
		double	sill,
		double	param,
		const VectorDouble &	ranges,
		const MatrixSymmetric &	sills,
		const VectorDouble &	angles,
		const ASpaceSharedPtr &	space,
		bool	flagRange
	)

static

◆ createIsotropic()

CovAniso * CovAniso::createIsotropic	(	const CovContext &	ctxt,
		const ECov &	type,
		double	range,
		double	sill = `1.`,
		double	param = `1.`,
		bool	flagRange = `true`
	)

static

◆ createIsotropicMulti()

CovAniso * CovAniso::createIsotropicMulti	(	const CovContext &	ctxt,
		const ECov &	type,
		double	range,
		const MatrixSymmetric &	sills,
		double	param = `1.`,
		bool	flagRange = `true`
	)

static

◆ createReduce()

CovAniso * CovAniso::createReduce ( const VectorInt & validVars ) const

◆ eval0()

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

overridevirtual

ASpaceObject Interface.

ACov Interface

Reimplemented from ACov.

Reimplemented in CovGradientNumerical.

◆ evalCovFFT()

Array CovAniso::evalCovFFT	(	const VectorDouble &	hmax,
		int	N = `128`,
		int	ivar = `0`,
		int	jvar = `0`
	)		const

◆ evalCovOnSphere()

double CovAniso::evalCovOnSphere	(	double	alpha,
		int	degree = `50`,
		bool	flagScaleDistance = `true`,
		const CovCalcMode *	mode = `nullptr`
	)		const

overridevirtual

Reimplemented from ACov.

◆ evalCovOnSphereVec()

VectorDouble CovAniso::evalCovOnSphereVec	(	const VectorDouble &	alpha,
		int	degree = `50`,
		bool	flagScaleDistance = `false`,
		const CovCalcMode *	mode = `nullptr`
	)		const

◆ evalSpectrum()

double CovAniso::evalSpectrum	(	const VectorDouble &	freq,
		int	ivar = `0`,
		int	jvar = `0`
	)		const

overridevirtual

Reimplemented from ACov.

◆ evalSpectrumOnSphere()

VectorDouble CovAniso::evalSpectrumOnSphere	(	int	n,
		bool	flagNormDistance = `false`,
		bool	flagCumul = `false`
	)		const

overridevirtual

Reimplemented from ACov.

◆ getAniso()

const Tensor & CovAniso::getAniso ( ) const

inline

◆ getAnisoAngles() [1/2]

VectorDouble CovAniso::getAnisoAngles ( ) const

inline

◆ getAnisoAngles() [2/2]

double CovAniso::getAnisoAngles ( int idim ) const

inline

◆ getAnisoCoeffs() [1/2]

VectorDouble CovAniso::getAnisoCoeffs ( ) const

◆ getAnisoCoeffs() [2/2]

double CovAniso::getAnisoCoeffs ( int idim ) const

inline

◆ getAnisoInvMat()

const MatrixSquare & CovAniso::getAnisoInvMat ( ) const

inline

◆ getAnisoRotation()

const Rotation & CovAniso::getAnisoRotation ( ) const

inline

◆ getAnisoRotMat() [1/2]

const MatrixSquare & CovAniso::getAnisoRotMat ( ) const

inline

◆ getAnisoRotMat() [2/2]

double CovAniso::getAnisoRotMat	(	int	idim,
		int	jdim
	)		const

inline

◆ getBallRadius()

virtual double CovAniso::getBallRadius ( ) const

inlinevirtual

Reimplemented in CovGradientNumerical.

◆ getContext()

const CovContext & CovAniso::getContext ( ) const

inline

◆ getCorAniso() [1/2]

CorAniso * CovAniso::getCorAniso ( )

◆ getCorAniso() [2/2]

const CorAniso * CovAniso::getCorAniso ( ) const

inline

◆ getCorFunc()

const ACovFunc * CovAniso::getCorFunc ( ) const

inline

◆ getCorrec()

double CovAniso::getCorrec ( ) const

◆ getCovName()

String CovAniso::getCovName ( ) const

inline

◆ getFlagAniso()

bool CovAniso::getFlagAniso ( ) const

inline

◆ getFlagRotation()

bool CovAniso::getFlagRotation ( ) const

inline

◆ getFormula()

virtual String CovAniso::getFormula ( ) const

inlinevirtual

◆ getFullCorrec()

double CovAniso::getFullCorrec ( ) const

◆ getIntegralRange()

double CovAniso::getIntegralRange	(	int	ndisc,
		double	hmax
	)		const

virtual

Calculate the Integral Range in various Space Dimension (1, 2 or 3)

Returns

◆ getMarkovCoeffs()

VectorDouble CovAniso::getMarkovCoeffs ( ) const

◆ getMaxNDim()

int CovAniso::getMaxNDim ( ) const

inline

◆ getMinOrder()

int CovAniso::getMinOrder ( ) const

inline

◆ getNAngles()

int CovAniso::getNAngles ( ) const

inline

◆ getNDim()

int CovAniso::getNDim ( ) const

inline

◆ getNGradParam()

int CovAniso::getNGradParam ( ) const

◆ getNRanges()

int CovAniso::getNRanges ( ) const

inline

◆ getNScales()

int CovAniso::getNScales ( ) const

inline

◆ getParam()

double CovAniso::getParam ( ) const

For compatibility, this function returns 0 if the Covariance has no Third Parameter

Returns: Third parameter

◆ getParMax()

double CovAniso::getParMax ( ) const

inline

◆ getRange() [1/2]

double CovAniso::getRange ( ) const

This function returns the range in the isotropic case In the anisotropic case, it returns the largest range over all directions

Returns

◆ getRange() [2/2]

double CovAniso::getRange ( int idim ) const

inline

◆ getRanges()

VectorDouble CovAniso::getRanges ( ) const

◆ getScadef()

double CovAniso::getScadef ( ) const

inline

◆ getScale() [1/2]

double CovAniso::getScale ( ) const

◆ getScale() [2/2]

double CovAniso::getScale ( int idim ) const

inline

◆ getScales()

const VectorDouble & CovAniso::getScales ( ) const

inline

◆ getSlope()

double CovAniso::getSlope	(	int	ivar,
		int	jvar
	)		const

Return the Slope calculated as the sill / range(idim=0)

Parameters

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

Returns

◆ getType()

const ECov & CovAniso::getType ( ) const

inline

◆ hasCovDerivative()

bool CovAniso::hasCovDerivative ( ) const

inline

◆ hasCovOnSphere()

bool CovAniso::hasCovOnSphere ( ) const

inline

◆ hasInt1D()

bool CovAniso::hasInt1D ( ) const

inline

◆ hasInt2D()

bool CovAniso::hasInt2D ( ) const

inline

◆ hasMarkovCoeffs()

bool CovAniso::hasMarkovCoeffs ( ) const

inline

◆ hasParam()

int CovAniso::hasParam ( ) const

inline

◆ hasRange()

int CovAniso::hasRange ( ) const

inline

◆ hasRotation()

bool CovAniso::hasRotation ( ) const

inline

◆ hasSpectrumOnRn()

bool CovAniso::hasSpectrumOnRn ( ) const

inline

◆ hasSpectrumOnSphere()

bool CovAniso::hasSpectrumOnSphere ( ) const

inline

◆ informDbInForAnisotropy()

void CovAniso::informDbInForAnisotropy ( const Db * dbin ) const

◆ informDbOutForAnisotropy()

void CovAniso::informDbOutForAnisotropy ( const Db * dbout ) const

◆ informMeshByApexForAnisotropy()

void CovAniso::informMeshByApexForAnisotropy ( const AMesh * amesh ) const

◆ informMeshByMeshForAnisotropy()

void CovAniso::informMeshByMeshForAnisotropy ( const AMesh * amesh ) const

◆ isAsymptotic()

bool CovAniso::isAsymptotic ( ) const

inline

◆ isIsotropic()

bool CovAniso::isIsotropic ( ) const

inline

◆ isNoStatForAnisotropy()

bool CovAniso::isNoStatForAnisotropy ( ) const

inline

◆ isNoStatForParam()

bool CovAniso::isNoStatForParam ( ) const

inline

◆ isNoStatForRotation()

bool CovAniso::isNoStatForRotation ( ) const

inline

◆ isNoStatForTensor()

bool CovAniso::isNoStatForTensor ( ) const

inline

◆ isValidForSpectral()

bool CovAniso::isValidForSpectral ( ) const

◆ isValidForTurningBand()

bool CovAniso::isValidForTurningBand ( ) const

◆ makeAngleNoStatDb()

void CovAniso::makeAngleNoStatDb	(	const String &	namecol,
		int	idim = `0`,
		const Db *	db = `nullptr`
	)

◆ makeAngleNoStatFunctional()

void CovAniso::makeAngleNoStatFunctional	(	const AFunctional *	func,
		int	idim = `0`
	)

◆ makeAngleStationary()

void CovAniso::makeAngleStationary ( int idim = 0 )

◆ makeParamNoStatDb()

void CovAniso::makeParamNoStatDb	(	const String &	namecol,
		const Db *	db = `nullptr`
	)

◆ makeParamNoStatFunctional()

void CovAniso::makeParamNoStatFunctional ( const AFunctional * func )

◆ makeParamStationary()

void CovAniso::makeParamStationary ( )

◆ makeRangeNoStatDb()

void CovAniso::makeRangeNoStatDb	(	const String &	namecol,
		int	idim = `0`,
		const Db *	db = `nullptr`
	)

◆ makeRangeNoStatFunctional()

void CovAniso::makeRangeNoStatFunctional	(	const AFunctional *	func,
		int	idim = `0`
	)

◆ makeRangeStationary()

void CovAniso::makeRangeStationary ( int idim = 0 )

◆ makeScaleNoStatDb()

void CovAniso::makeScaleNoStatDb	(	const String &	namecol,
		int	idim = `0`,
		const Db *	db = `nullptr`
	)

◆ makeScaleNoStatFunctional()

void CovAniso::makeScaleNoStatFunctional	(	const AFunctional *	func,
		int	idim = `0`
	)

◆ makeScaleStationary()

void CovAniso::makeScaleStationary ( int idim = 0 )

◆ makeTensorNoStatDb()

void CovAniso::makeTensorNoStatDb	(	const String &	namecol,
		int	idim = `0`,
		int	jdim = `0`,
		const Db *	db = `nullptr`
	)

◆ makeTensorNoStatFunctional()

void CovAniso::makeTensorNoStatFunctional	(	const AFunctional *	func,
		int	idim = `0`,
		int	jdim = `0`
	)

◆ makeTensorStationary()

void CovAniso::makeTensorStationary	(	int	idim,
		int	jdim
	)

◆ normalizeOnSphere()

double CovAniso::normalizeOnSphere ( int n = 50 ) const

◆ operator=()

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

◆ setAniso()

void CovAniso::setAniso ( const Tensor & aniso )

inline

◆ setAnisoAngle()

void CovAniso::setAnisoAngle	(	int	idim,
		double	angle
	)

◆ setAnisoAngles()

void CovAniso::setAnisoAngles ( const VectorDouble & angles )

◆ setAnisoRotation() [1/2]

void CovAniso::setAnisoRotation ( const Rotation & rot )

◆ setAnisoRotation() [2/2]

void CovAniso::setAnisoRotation ( const VectorDouble & rot )

◆ setMarkovCoeffs()

void CovAniso::setMarkovCoeffs ( const VectorDouble & coeffs )

◆ setMarkovCoeffsBySquaredPolynomials()

void CovAniso::setMarkovCoeffsBySquaredPolynomials	(	const VectorDouble &	coeffs1,
		const VectorDouble &	coeffs2,
		double	eps = `0`
	)

◆ setParam()

void CovAniso::setParam ( double param )

◆ setRange()

void CovAniso::setRange	(	int	idim,
		double	range
	)

◆ setRangeIsotropic()

void CovAniso::setRangeIsotropic ( double range )

Practical range.

◆ setRanges()

void CovAniso::setRanges ( const VectorDouble & ranges )

◆ setRotationAnglesAndRadius()

void CovAniso::setRotationAnglesAndRadius	(	const VectorDouble &	angles = `VectorDouble()`,
		const VectorDouble &	ranges = `VectorDouble()`,
		const VectorDouble &	scales = `VectorDouble()`
	)

◆ setScale() [1/2]

void CovAniso::setScale ( double scale )

◆ setScale() [2/2]

void CovAniso::setScale	(	int	idim,
		double	scale
	)

Make the covariance isotropic.

◆ setScales()

void CovAniso::setScales ( const VectorDouble & scales )

◆ setType()

void CovAniso::setType ( const ECov & type )

◆ simulateSpectralOmega()

MatrixDense CovAniso::simulateSpectralOmega ( int nb ) const

◆ simulateTurningBand()

double CovAniso::simulateTurningBand	(	double	t0,
		TurningBandOperate &	operTB
	)		const

◆ toString()

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

overridevirtual

ICloneable Interface.

AStringable Interface

Reimplemented from ASpaceObject.

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

include/Covariances/CovAniso.hpp
src/Covariances/CovAniso.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ CovAniso() [1/4]

◆ CovAniso() [2/4]

◆ CovAniso() [3/4]

◆ CovAniso() [4/4]

◆ ~CovAniso()

Member Function Documentation

◆ _computeCorrec()

◆ _eval()

◆ _getDetTensor()

◆ _getSillValue()

◆ _isOptimEnabled()

◆ computeMarkovCoeffs()

◆ createAnisotropic()

◆ createAnisotropicMulti()

◆ createFromParam()

◆ createIsotropic()

◆ createIsotropicMulti()

◆ createReduce()

◆ eval0()

◆ evalCovFFT()

◆ evalCovOnSphere()

◆ evalCovOnSphereVec()

◆ evalSpectrum()

◆ evalSpectrumOnSphere()

◆ getAniso()

◆ getAnisoAngles() [1/2]

◆ getAnisoAngles() [2/2]

◆ getAnisoCoeffs() [1/2]

◆ getAnisoCoeffs() [2/2]

◆ getAnisoInvMat()

◆ getAnisoRotation()

◆ getAnisoRotMat() [1/2]

◆ getAnisoRotMat() [2/2]

◆ getBallRadius()

◆ getContext()

◆ getCorAniso() [1/2]

◆ getCorAniso() [2/2]

◆ getCorFunc()

◆ getCorrec()

◆ getCovName()

◆ getFlagAniso()

◆ getFlagRotation()

◆ getFormula()

◆ getFullCorrec()

◆ getIntegralRange()

◆ getMarkovCoeffs()

◆ getMaxNDim()

◆ getMinOrder()

◆ getNAngles()

◆ getNDim()

◆ getNGradParam()

◆ getNRanges()

◆ getNScales()

◆ getParam()

◆ getParMax()

◆ getRange() [1/2]

◆ getRange() [2/2]

◆ getRanges()

◆ getScadef()

◆ getScale() [1/2]

◆ getScale() [2/2]

◆ getScales()

◆ getSlope()

◆ getType()

◆ hasCovDerivative()

◆ hasCovOnSphere()

◆ hasInt1D()

◆ hasInt2D()

◆ hasMarkovCoeffs()

◆ hasParam()

◆ hasRange()

◆ hasRotation()

◆ hasSpectrumOnRn()

◆ hasSpectrumOnSphere()

◆ informDbInForAnisotropy()

◆ informDbOutForAnisotropy()