#include <CovProportional.hpp>

Inheritance diagram for gstlrn::CovProportional:

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

	CovProportional (const CovProportional &r)

CovProportional &	operator= (const CovProportional &r)

virtual	~CovProportional ()

void	setCor (ACov *cor) override

bool	isValidForSimulation (const ESimuType &simuType) const override
	Interface for the spectral simulation on RN.

MatrixDense	simulateSpectralOmega (Id ns) const override

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

	CovBase (const CovBase &r)

CovBase &	operator= (const CovBase &r)

virtual	~CovBase ()

String	getNFName () const override
	ICloneable Interface.

bool	isFactorized () const override
	Interface for spectral simulation on RN.

SpectrumOnRN *	simulateOnRN (Id ns=1000) const override

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

void	setAic (const MatrixSquare &aic)

void	setAic (Id ivar, Id jvar, double val)

void	computeAic ()
	Calculate the square root of the sill matrix. This decomposition requires the Sill matrix to be definite positive.

void	initializeAic ()

const MatrixSymmetric &	getSill () const

const MatrixSquare &	getAics () const

double	getAic (Id ivar, Id jvar) const

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)

virtual Id	getNFac () const

virtual MatrixDense	getProjection (Id ifac=0) const

virtual double	evalSpectrumOnRN (const 1 &freq, Id ivar=0, Id jvar=0) const

virtual double	evalSpectrumRatio (const 1 &freq, Id ivar, Id jvar, const ACov *cov0=nullptr) const

virtual	evalSpectrumOnSphere (Id n, bool ScaleDistanceByRadius=false, bool flagScale=true) const
	Interface for spectral simulation on the sphere in R3 (S2)

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

	evalCovGrad (const SpacePoint &p1, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr)

void	attachNoStatDb (const Db *db)

ASpaceSharedPtr	getSpace () const

ESpaceType	getSpaceType () 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 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

void	printConcreteClassName () const

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

	ASerializable (const ASerializable &r)=default

ASerializable &	operator= (const ASerializable &r)=default

	ASerializable (ASerializable &&r) noexcept=default

ASerializable &	operator= (ASerializable &&r) noexcept=default

virtual	~ASerializable ()=default

bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT")) const
	Dump the contents of an object into an Output File using a given Output NF Format.

void	setDefaultFormatNF (const EFormatNF &format)

Additional Inherited Members
Static Public Member Functions inherited from gstlrn::CovBase
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})

Static Public Member Functions inherited from gstlrn::ASerializable
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)

static String	getFileIdentity (const String &filename, bool verbose=false)

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getPrefixName ()

Constructor & Destructor Documentation

◆ CovProportional() [1/2]

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

◆ CovProportional() [2/2]

gstlrn::CovProportional::CovProportional ( const CovProportional & r )

◆ ~CovProportional()

gstlrn::CovProportional::~CovProportional ( )

virtual

Member Function Documentation

◆ isValidForSimulation()

bool gstlrn::CovProportional::isValidForSimulation ( const ESimuType & simuType ) const

overridevirtual

Interface for the spectral simulation on RN.

Reimplemented from gstlrn::CovBase.

◆ operator=()

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

◆ setCor()

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

overridevirtual

Reimplemented from gstlrn::CovBase.

◆ simulateSpectralOmega()

MatrixDense gstlrn::CovProportional::simulateSpectralOmega ( Id ns ) const

overridevirtual

Reimplemented from gstlrn::ACov.

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

include/Covariances/CovProportional.hpp
src/Covariances/CovProportional.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ CovProportional() [1/2]

◆ CovProportional() [2/2]

◆ ~CovProportional()

Member Function Documentation

◆ isValidForSimulation()

◆ operator=()

◆ setCor()

◆ simulateSpectralOmega()