#include <CovBase.hpp>

Inheritance diagram for gstlrn::CovBase:

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

	CovBase (const CovBase &r)

CovBase &	operator= (const CovBase &r)

virtual	~CovBase ()

bool	isConsistent (const ASpace *space) const override

Id	getNVar () const override
	ACov Interface.

bool	isOptimizationInitialized (const Db *db=nullptr) const

void	setCholSill (Id ivar, Id 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 1 &sill) const

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

void	initSill (double value=0.)

const MatrixSymmetric &	getSill () const

virtual void	setCor (ACov *cor)

const ACov *	getCor () const

ACov *	getCorModify ()

double	getSill (Id ivar, Id jvar) const

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

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

void	makeSillsStationary (bool silent=false)

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

TabNoStatSills *	getTabNoStatSills () const

Id	getNSills () const

bool	isNoStatForVariance () const

void	informMeshByMesh (const AMesh *amesh) const

void	informMeshByApex (const AMesh *amesh) const

	informCoords (const 1 &coords, const EConsElem &econs, Id iv1=0, Id 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 (Id icas1, Id iech1, Id icas2, Id iech2) const override
	Tell if the use of Optimization is enabled or not.

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

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

void	nostatUpdate (CovInternal *covint) const

Id	addEvalCovVecRHSInPlace (vect vect, const 1 &index1, Id iech2, const KrigOpt &krigopt, SpacePoint &pin, SpacePoint &pout, 1 &tabwork, double lambda=1., const ECalcMember &calcMember=ECalcMember::RHS) const override

void	setOptimEnabled (bool flag) const override

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

void	appendParams (ListParams &listParams, std::vector< covmaptype > *gradFuncs=nullptr) override

void	updateCov () override

void	initParams (const MatrixSymmetric &vars, double href=1.) override

ParamInfo &	getParamInfoCholSills (Id ivar, Id jvar)

Public Member Functions inherited from gstlrn::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

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

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

std::vector< double >	evalCovGrad (const SpacePoint &p1, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr)

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

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

virtual double	evalSpectrum (const 1 &freq, Id ivar, Id jvar) const

void	attachNoStatDb (const Db *db)

ASpaceSharedPtr	getSpace () const

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

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

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

void	optimizationPostProcess () const

void	optimizationSetTarget (SpacePoint &pt) const

	eval (const std::vector< SpacePoint > &vec_p1, const std::vector< SpacePoint > &vec_p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Functions for evaluating Covariances.

MatrixSymmetric	eval0Mat (const CovCalcMode *mode=nullptr) const

MatrixSymmetric	evalCovMat0 (const Db *db, Id 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, Id ivar0=-1, Id jvar0=-1, const 1 &nbgh1=1(), const 1 &nbgh2=1(), const CovCalcMode *mode=nullptr, bool cleanOptim=true) const

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

MatrixSparse *	evalCovMatSparse (const Db db1_arg, const Db db2_arg=nullptr, Id ivar0=-1, Id jvar0=-1, const 1 &nbgh1=1(), const 1 &nbgh2=1(), const CovCalcMode *mode=nullptr, bool cleanOptim=true, double eps=EPSILON3) const

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

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

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

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

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

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

Id	evalCovVecRHSInPlace (vect vect, const RankHandler &rank, Id iech2, const KrigOpt &krigopt, SpacePoint &pin, SpacePoint &pout, 1 &tabwork, double lambda=1., const ECalcMember &calcMember=ECalcMember::RHS) const

Id	evalCovMatOptimInPlace (MatrixDense &mat, const Db *dbin, const RankHandler &rankhandler, const KrigOpt &krigopt, const ECalcMember &calcMember, 1 &tabwork, double lambda=1.) const

void	eval0CovMatBiPointInPlace (MatrixSymmetric &mat, const CovCalcMode *mode) const

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

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

	evalIvarNlag (const 1 &vec_step, const 1 &dir=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const

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

MatrixSquare	evalNvarIpasIncr (const 1 &dincr, const CovCalcMode *mode=nullptr) const

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

	evalIsoIvarNlag (const 1 &vec_step, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const

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

double	evalCvv (const 1 &ext, const 1 &ndisc, const 1 &angles=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const

double	evalCvvShift (const 1 &ext, const 1 &ndisc, const 1 &shift, const 1 &angles=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const

MatrixSquare	evalCvvM (const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const CovCalcMode *mode=nullptr) const

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

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

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

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

void	evalPointToDbAsSP (1 &values, const std::vector< SpacePoint > &p1s, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const

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

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

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

double	extensionVariance (const Db *db, const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const 1 &x0=1(), Id ivar=0, Id jvar=0) const

double	samplingDensityVariance (const Db *db, const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const 1 &x0=1(), Id ivar=0, Id jvar=0) const

double	specificVolume (const Db *db, double mean, const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const 1 &x0=1(), Id ivar=0, Id jvar=0) const

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

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

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

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

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

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

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

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

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

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

Id	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

	informCoords (const 1 &coords, const EConsElem &econs, Id iv1=0, Id iv2=0) const

void	informDbIn (const Db *dbin) const

void	informDbOut (const Db *dbout) const

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

Id	getNDim (Id 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 gstlrn::ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

std::shared_ptr< ICloneable >	cloneShared () const

std::unique_ptr< ICloneable >	cloneUnique () const

Public Member Functions inherited from gstlrn::AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (const AStringable &r)

virtual	~AStringable ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const

virtual void	display (const AStringFormat *strfmt=nullptr) const final

virtual void	display (Id level) const final

Static Public Member Functions
static ParamInfo	createParamInfoForCholSill ()

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

Constructor & Destructor Documentation

◆ CovBase() [1/2]

gstlrn::CovBase::CovBase	(	ACov *	cor = `nullptr`,
		const MatrixSymmetric &	sills = `MatrixSymmetric()`
	)

◆ CovBase() [2/2]

gstlrn::CovBase::CovBase ( const CovBase & r )

◆ ~CovBase()

gstlrn::CovBase::~CovBase ( )

virtual

Member Function Documentation

◆ addEvalCovVecRHSInPlace()

Id gstlrn::CovBase::addEvalCovVecRHSInPlace	(	vect	vect,
		const 1 &	index1,
		Id	iech2,
		const KrigOpt &	krigopt,
		SpacePoint &	pin,
		SpacePoint &	pout,
		1 &	tabwork,
		double	lambda = `1.`,
		const ECalcMember &	calcMember = `ECalcMember::RHS`
	)		const

overridevirtual

Reimplemented from gstlrn::ACov.

◆ appendParams()

void gstlrn::CovBase::appendParams	(	ListParams &	listParams,
		std::vector< covmaptype > *	gradFuncs = `nullptr`
	)

overridevirtual

Reimplemented from gstlrn::ACov.

◆ createParamInfoForCholSill()

ParamInfo gstlrn::CovBase::createParamInfoForCholSill ( )

static

◆ getCor()

const ACov * gstlrn::CovBase::getCor ( ) const

inline

◆ getCorModify()

ACov * gstlrn::CovBase::getCorModify ( )

inline

◆ getNSills()

Id gstlrn::CovBase::getNSills ( ) const

◆ getNVar()

Id gstlrn::CovBase::getNVar ( ) const

inlineoverridevirtual

ACov Interface.

Reimplemented from gstlrn::ACov.

◆ getParamInfoCholSills()

ParamInfo & gstlrn::CovBase::getParamInfoCholSills	(	Id	ivar,
		Id	jvar
	)

inline

◆ getSill() [1/2]

const MatrixSymmetric & gstlrn::CovBase::getSill ( ) const

inline

◆ getSill() [2/2]

double gstlrn::CovBase::getSill	(	Id	ivar,
		Id	jvar
	)		const

◆ getTabNoStatSills()

TabNoStatSills * gstlrn::CovBase::getTabNoStatSills ( ) const

inline

◆ getValue()

double gstlrn::CovBase::getValue	(	const EConsElem &	econs,
		Id	iv1,
		Id	iv2
	)		const

overridevirtual

Reimplemented from gstlrn::ACov.

◆ informCoords()

gstlrn::CovBase::informCoords	(	const 1 &	coords,
		const EConsElem &	econs,
		Id	iv1 = `0`,
		Id	iv2 = `0`
	)		const

◆ informDbIn()

void gstlrn::CovBase::informDbIn ( const Db * dbin ) const

◆ informDbInForSills()

void gstlrn::CovBase::informDbInForSills ( const Db * dbin ) const

◆ informDbOut()

void gstlrn::CovBase::informDbOut ( const Db * dbout ) const

◆ informDbOutForSills()

void gstlrn::CovBase::informDbOutForSills ( const Db * dbout ) const

◆ informMeshByApex()

void gstlrn::CovBase::informMeshByApex ( const AMesh * amesh ) const

◆ informMeshByApexForSills()

void gstlrn::CovBase::informMeshByApexForSills ( const AMesh * amesh ) const

◆ informMeshByMesh()

void gstlrn::CovBase::informMeshByMesh ( const AMesh * amesh ) const

◆ informMeshByMeshForSills()

void gstlrn::CovBase::informMeshByMeshForSills ( const AMesh * amesh ) const

◆ initParams()

void gstlrn::CovBase::initParams	(	const MatrixSymmetric &	vars,
		double	href = `1.`
	)

overridevirtual

Reimplemented from gstlrn::ACov.

◆ initSill()

void gstlrn::CovBase::initSill ( double value = 0. )

◆ isConsistent()

bool gstlrn::CovBase::isConsistent ( const ASpace * space ) const

overridevirtual

Reimplemented from gstlrn::ACov.

◆ isNoStatForVariance()

bool gstlrn::CovBase::isNoStatForVariance ( ) const

◆ isOptimizationInitialized()

bool gstlrn::CovBase::isOptimizationInitialized ( const Db * db = nullptr ) const

Checks that the Optimization has already been initiated, by:

checking that the storage (for Sample Points projected in the Covariance rotation system) is already allocated
checking that the dimension of this storage is correct (only if 'db' is provided): in particular, this check is not necessary when freeing this storage.

◆ makeElemNoStat()

Id gstlrn::CovBase::makeElemNoStat	(	const EConsElem &	econs,
		Id	iv1,
		Id	iv2,
		const AFunctional *	func = `nullptr`,
		const Db *	db = `nullptr`,
		const String &	namecol = `String()`
	)

overridevirtual

Reimplemented from gstlrn::ACov.

◆ makeSillNoStatDb()

void gstlrn::CovBase::makeSillNoStatDb	(	const String &	namecol,
		Id	ivar = `0`,
		Id	jvar = `0`,
		const Db *	db = `nullptr`
	)

◆ makeSillNoStatFunctional()

void gstlrn::CovBase::makeSillNoStatFunctional	(	const AFunctional *	func,
		Id	ivar = `0`,
		Id	jvar = `0`
	)

◆ makeSillsStationary()

void gstlrn::CovBase::makeSillsStationary ( bool silent = false )

◆ makeSillStationary()

void gstlrn::CovBase::makeSillStationary	(	Id	ivar = `0`,
		Id	jvar = `0`
	)

◆ nostatUpdate()

void gstlrn::CovBase::nostatUpdate ( CovInternal * covint ) const

Update the Model in the case of Non-stationary parameters This requires the knowledge of the two end-points

Parameters

[in] covint Internal structure for non-stationarity or NULL (for stationary case)

◆ operator=()

CovBase & gstlrn::CovBase::operator= ( const CovBase & r )

◆ setCholSill()

void gstlrn::CovBase::setCholSill	(	Id	ivar,
		Id	jvar,
		double	val
	)		const

◆ setCor()

void gstlrn::CovBase::setCor ( ACov * cor )

virtual

Reimplemented in gstlrn::CovProportional.

◆ setOptimEnabled()

void gstlrn::CovBase::setOptimEnabled ( bool flag ) const

inlineoverridevirtual

Reimplemented from gstlrn::ACov.

◆ setSill() [1/4]

void gstlrn::CovBase::setSill ( const 1 & sill ) const

virtual

◆ setSill() [2/4]

void gstlrn::CovBase::setSill ( const MatrixSymmetric & sill ) const

virtual

Only valid when there is only one variable (in the context)

◆ setSill() [3/4]

void gstlrn::CovBase::setSill ( double sill ) const

virtual

◆ setSill() [4/4]

void gstlrn::CovBase::setSill	(	Id	ivar,
		Id	jvar,
		double	sill
	)		const

virtual

TODO : Test if sill matrix is positive definite (if not, generate a warning)

◆ updateCov()

void gstlrn::CovBase::updateCov ( )

overridevirtual

Reimplemented from gstlrn::ACov.

◆ updateCovByMesh()

void gstlrn::CovBase::updateCovByMesh	(	Id	imesh,
		bool	aniso = `true`
	)		const

overridevirtual

Reimplemented from gstlrn::ACov.

◆ updateCovByPoints()

void gstlrn::CovBase::updateCovByPoints	(	Id	icas1,
		Id	iech1,
		Id	icas2,
		Id	iech2
	)		const

overridevirtual

Tell if the use of Optimization is enabled or not.

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

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

include/Covariances/CovBase.hpp
src/Covariances/CovBase.cpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ CovBase() [1/2]

◆ CovBase() [2/2]

◆ ~CovBase()

Member Function Documentation

◆ addEvalCovVecRHSInPlace()

◆ appendParams()

◆ createParamInfoForCholSill()

◆ getCor()

◆ getCorModify()

◆ getNSills()

◆ getNVar()

◆ getParamInfoCholSills()

◆ getSill() [1/2]

◆ getSill() [2/2]

◆ getTabNoStatSills()

◆ getValue()

◆ informCoords()

◆ informDbIn()

◆ informDbInForSills()

◆ informDbOut()

◆ informDbOutForSills()

◆ informMeshByApex()

◆ informMeshByApexForSills()

◆ informMeshByMesh()

◆ informMeshByMeshForSills()

◆ initParams()

◆ initSill()

◆ isConsistent()

◆ isNoStatForVariance()

◆ isOptimizationInitialized()

◆ makeElemNoStat()

◆ makeSillNoStatDb()

◆ makeSillNoStatFunctional()

◆ makeSillsStationary()

◆ makeSillStationary()

◆ nostatUpdate()

◆ operator=()

◆ setCholSill()

◆ setCor()

◆ setOptimEnabled()

◆ setSill() [1/4]

◆ setSill() [2/4]

◆ setSill() [3/4]

◆ setSill() [4/4]

◆ updateCov()

◆ updateCovByMesh()

◆ updateCovByPoints()