Class containing the Model Information describing the formal Spatial (or Temporal) Characteristics of the (set of) random variable(s) under study. More...

#include <Model.hpp>

Inheritance diagram for gstlrn::Model:

Detailed Description

Class containing the Model Information describing the formal Spatial (or Temporal) Characteristics of the (set of) random variable(s) under study.

The Model is essentially a container with two main contents:

the covariance part: see ACov.hpp for more information
the drift part: see DriftList.hpp for more information

The additional member CovContext only serves in carrying the following information:

the number of variables: if more than 1, the Model becomes multivariate
the field extension: this information is needed to get a stationary version to any covariance
the experimental mean vector and the variance-covariance matrix (used to calibrate the Model)

Public Member Functions
	Model (const CovContext &ctxt=CovContext())

	Model (Id nvar, Id ndim=2)

	Model (const Model &m)

Model &	operator= (const Model &m)

virtual	~Model ()

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

const CovAnisoList *	castInCovAnisoListConst (Id icov=-1) const

const CovLMCTapering *	castInCovLMCTaperingConst () const

const CovLMGradient *	castInCovLMGradientConst () const

const CovLMCAnamorphosis *	castInCovLMCAnamorphosisConst () const

CovAnisoList *	_castInCovAnisoList (Id icov=-1)

CovLMCTapering *	_castInCovLMCTapering ()

CovLMGradient *	_castInCovLMGradient ()

CovLMCAnamorphosis *	_castInCovLMCAnamorphosis ()

Id	resetFromDb (const Db *db)

void	setCovAnisoList (const CovAnisoList *covalist)

void	addCovAniso (const CovAniso &cov)

void	addCovFromParam (const ECov &type, double range=EPSILON6, double sill=1., double param=1., const 1 &ranges=1(), const MatrixSymmetric &sills=MatrixSymmetric(), const 1 &angles=1(), bool flagRange=true)

void	addCovFromParamOldStyle (const ECov &type, double range=EPSILON6, double sill=1., double param=1., const 1 &ranges=1(), const 1 &sills=1(), const 1 &angles=1(), bool flagRange=true)

Id	setAnam (const AAnam *anam, const 1 &strcnt=1())

Id	unsetAnam ()

bool	isFlagGradient () const

bool	isFlagGradientNumerical () const

bool	isFlagGradientFunctional () const

void	switchToGradient ()

const CovAnisoList *	getCovAnisoList () const
	TODO : to be removed (encapsulation of CovAnisoList)

CovAnisoList *	getCovAnisoListModify ()

double	evalCovFromIncr (const 1 &incr, Id icov=0, const ECalcMember &member=ECalcMember::fromKey("LHS")) const

Model *	duplicate () const

Model *	createReduce (const 1 &validVars) const

Id	getNVar () const

Id	fitFromCovIndices (Vario *vario, const VectorECov &types=ECov::fromKeys({"EXPONENTIAL"}), const Constraints &constraints=Constraints(), const Option_VarioFit &optvar=Option_VarioFit(), const Option_AutoFit &mauto=Option_AutoFit(), bool verbose=false)

Id	fit (Vario *vario, const VectorECov &types=ECov::fromKeys({"SPHERICAL"}), const Constraints &constraints=Constraints(), const Option_VarioFit &optvar=Option_VarioFit(), const Option_AutoFit &mauto=Option_AutoFit(), bool verbose=false)

Id	fitFromVMap (DbGrid *dbmap, const VectorECov &types=ECov::fromKeys({"SPHERICAL"}), const Constraints &constraints=Constraints(), const Option_VarioFit &optvar=Option_VarioFit(), const Option_AutoFit &mauto=Option_AutoFit(), bool verbose=false)

Id	stabilize (double percent, bool verbose=false)

Id	standardize (bool verbose=false)

bool	isValid () const

virtual Id	getActiveFactor () const
	Call the method CovAnisoList::getActiveFactor of the object CovAnisoList.

const CovAniso *	getCovAniso (Id icov) const
	Call the method CovAnisoList::getCovAniso of the object CovAnisoList.

Id	getNCov (bool skipNugget=false) const
	Call the method CovAnisoList::getNCov of the object CovAnisoList.

const ECov &	getCovType (Id icov) const override
	Call the method CovAnisoList::getCovType of the object CovAnisoList.

double	getRange (Id icov) const
	Call the method CovAnisoList::getRange of the object CovAnisoList.

	getRanges (Id icov) const
	Call the method CovAnisoList::getRanges of the object CovAnisoList.

	getAngles (Id icov) const
	Call the method CovAnisoList::getAngles of the object CovAnisoList.

virtual const AAnam *	getAnam () const
	Call the method CovAnisoList::getAnam of the object CovAnisoList.

double	getParam (Id icov) const
	Call the method CovAnisoList::getParam of the object CovAnisoList.

String	getCovName (Id icov) const override
	Call the method CovAnisoList::getCovName of the object CovAnisoList.

CovAniso	extractCova (Id icov) const
	Call the method CovAnisoList::extractCova of the object CovAnisoList.

Id	getNGradParam (Id icov) const
	Call the method CovAnisoList::getNGradParam of the object CovAnisoList.

double	getMaximumDistance () const
	Call the method CovAnisoList::getMaximumDistance of the object CovAnisoList.

Id	getCovMinIRFOrder () const
	Call the method CovAnisoList::getCovMinIRFOrder of the object CovAnisoList.

virtual Id	getAnamNClass () const
	Call the method CovAnisoList::getAnamNClass of the object CovAnisoList.

virtual bool	hasAnam () const
	Call the method CovAnisoList::hasAnam of the object CovAnisoList.

bool	hasNugget () const
	Call the method CovAnisoList::hasNugget of the object CovAnisoList.

Id	getRankNugget () const
	Call the method CovAnisoList::getRankNugget of the object CovAnisoList.

double	getBallRadius () const
	Call the method CovAnisoList::getBallRadius of the object CovAnisoList.

Id	hasExternalCov () const
	Call the method CovAnisoList::hasExternalCov of the object CovAnisoList.

bool	isChangeSupportDefined () const
	Call the method CovAnisoList::isChangeSupportDefined of the object CovAnisoList.

const AnamHermite *	getAnamHermite () const
	Call the method CovAnisoList::getAnamHermite of the object CovAnisoList.

const EModelProperty &	getCovMode () const
	Call the method CovAnisoList::getCovMode of the object CovAnisoList.

void	evalZAndGradients (const SpacePoint &p1, const SpacePoint &p2, double &covVal, 1 &covGp, 1 &covGG, const CovCalcMode *mode=nullptr, bool flagGrad=false) const
	Call the method CovLMGradient::evalZAndGradients of the object CovLMGradient.

virtual void	setActiveFactor (Id)
	Call the method CovAnisoList::setActiveFactor of the object CovAnisoList.

const CovAniso *	getCovAniso (Id icov) const
	Call the method CovAnisoList::getCovAniso of the object CovAnisoList.

void	setRangeIsotropic (Id icov, double range)
	Call the method CovAnisoList::setRangeIsotropic of the object CovAnisoList.

void	setMarkovCoeffs (Id icov, const 1 &coeffs)
	Call the method CovAnisoList::setMarkovCoeffs of the object CovAnisoList.

void	makeRangeNoStatDb (Id icov, const String &namecol, Id idim=0)
	Call the method CovAnisoList::makeRangeNoStatDb of the object CovAnisoList.

void	makeScaleNoStatDb (Id icov, const String &namecol, Id idim=0)
	Call the method CovAnisoList::makeScaleNoStatDb of the object CovAnisoList.

void	makeAngleNoStatDb (Id icov, const String &namecol, Id idim=0)
	Call the method CovAnisoList::makeAngleNoStatDb of the object CovAnisoList.

void	makeTensorNoStatDb (Id icov, const String &namecol, Id idim=0, Id jdim=0)
	Call the method CovAnisoList::makeTensorNoStatDb of the object CovAnisoList.

void	makeParamNoStatDb (Id icov, const String &namecol)
	Call the method CovAnisoList::makeParamNoStatDb of the object CovAnisoList.

void	makeRangeNoStatFunctional (Id icov, const AFunctional *func, Id idim=0)
	Call the method CovAnisoList::makeRangeNoStatFunctional of the object CovAnisoList.

void	makeScaleNoStatFunctional (Id icov, const AFunctional *func, Id idim=0)
	Call the method CovAnisoList::makeScaleNoStatFunctional of the object CovAnisoList.

void	makeAngleNoStatFunctional (Id icov, const AFunctional *func, Id idim=0)
	Call the method CovAnisoList::makeAngleNoStatFunctional of the object CovAnisoList.

void	makeTensorNoStatFunctional (Id icov, const AFunctional *func, Id idim=0, Id jdim=0)
	Call the method CovAnisoList::makeTensorNoStatFunctional of the object CovAnisoList.

void	makeParamNoStatFunctional (Id icov, const AFunctional *func)
	Call the method CovAnisoList::makeParamNoStatFunctional of the object CovAnisoList.

void	makeRangeStationary (Id icov, Id idim=0)
	Call the method CovAnisoList::makeRangeStationary of the object CovAnisoList.

void	makeScaleStationary (Id icov, Id idim=0)
	Call the method CovAnisoList::makeScaleStationary of the object CovAnisoList.

void	makeAngleStationary (Id icov, Id idim=0)
	Call the method CovAnisoList::makeAngleStationary of the object CovAnisoList.

void	makeTensorStationary (Id icov, Id idim, Id jdim)
	Call the method CovAnisoList::makeTensorStationary of the object CovAnisoList.

void	makeParamStationary (Id icov)
	Call the method CovAnisoList::makeParamStationary of the object CovAnisoList.

void	setTapeRange (double range)
	Call the method CovLMCTapering::setTapeRange of the object CovLMCTapering.

Public Member Functions inherited from gstlrn::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 (Id level) const final

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

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

	ASerializable (ASerializable &&r) noexcept

ASerializable &	operator= (ASerializable &&r) noexcept

virtual	~ASerializable ()

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

void	setDefaultFormatNF (const EFormatNF &format)

Public Member Functions inherited from gstlrn::ModelCovList
	ModelCovList (const CovContext &ctxt=CovContext())

	ModelCovList (const ModelCovList &m)

ModelCovList &	operator= (const ModelCovList &m)

virtual	~ModelCovList ()

const CovList *	getCovList () const

CovList *	getCovListModify () const

void	setCovList (const CovList *covs)

virtual void	addCov (const CovBase &cov)

CovBase *	getCovBase (Id icov) const

void	fitSills (Vario vario=nullptr, const DbGrid dbmap=nullptr, Constraints *constraints=nullptr, const ModelOptimParam &mop=ModelOptimParam(), bool verbose=false, bool trace=false)

void	setFitSills (AModelFitSills *amopts) const
	Call the method CovList::setFitSills of the object CovList.

void	deleteFitSills () const
	Call the method CovList::deleteFitSills of the object CovList.

Id	getNCov () const
	Call the method CovList::getNCov of the object CovList.

const MatrixSymmetric &	getSills (Id icov) const
	Call the method CovList::getSills of the object CovList.

double	getSill (Id icov, Id ivar, Id jvar) const
	Call the method CovList::getSill of the object CovList.

virtual double	getTotalSill (Id ivar=0, Id jvar=0) const
	Call the method CovList::getTotalSill of the object CovList.

MatrixSymmetric	getTotalSills () const
	Call the method CovList::getTotalSills of the object CovList.

bool	isAllActiveCovList () const
	Call the method CovList::isAllActiveCovList of the object CovList.

AModelFitSills *	getFitSills () const
	Call the method CovList::getFitSills of the object CovList.

void	delCov (Id icov)
	Call the method CovList::delCov of the object CovList.

void	delAllCov ()
	Call the method CovList::delAllCov of the object CovList.

void	setCovFiltered (Id icov, bool filtered)
	Call the method CovList::setCovFiltered of the object CovList.

void	makeSillNoStatDb (Id icov, const String &namecol, Id ivar=0, Id jvar=0)
	Call the method CovList::makeSillNoStatDb of the object CovList.

void	makeSillStationary (Id icov, Id ivar=0, Id jvar=0)
	Call the method CovList::makeSillStationary of the object CovList.

void	makeSillsStationary (Id icov, bool silent=false)
	Call the method CovList::makeSillsStationary of the object CovList.

void	makeSillNoStatFunctional (Id icov, const AFunctional *func, Id ivar=0, Id jvar=0)
	Call the method CovList::makeSillNoStatFunctional of the object CovList.

void	setSill (Id icov, Id ivar, Id jvar, double value)
	Call the method CovList::setSill of the object CovList.

void	setSills (Id icov, const MatrixSymmetric &sills)
	Call the method CovList::setSills of the object CovList.

void	normalize (double sill=1., Id ivar=0, Id jvar=0)
	Call the method CovList::normalize of the object CovList.

Public Member Functions inherited from gstlrn::ModelGeneric
	ModelGeneric (const CovContext &ctxt=CovContext())

	ModelGeneric (const ModelGeneric &r)

ModelGeneric &	operator= (const ModelGeneric &r)

virtual	~ModelGeneric ()

const ACov *	getCov () const

const CovContext *	getContext () const

const DriftList *	getDriftList () const

ACov *	_getCovModify ()
	ICloneable interface.

CovContext *	_getContextModify ()

DriftList *	_getDriftListModify ()

std::vector< covmaptype > &	getGradients ()

void	setField (double field)

bool	isValid () const

void	setCov (const ACov *cova)

void	setDriftList (const DriftList *driftlist)

void	setDriftIRF (Id order=0, Id nfex=0)

void	addDrift (const ADrift *drift)

void	setDrifts (const VectorString &driftSymbols)

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

std::shared_ptr< ListParams >	generateListParams () const

void	updateModel ()

double	computeLogLikelihood (const Db *db, bool verbose=false)

void	fitNew (const Db db=nullptr, Vario vario=nullptr, const DbGrid dbmap=nullptr, Constraints constraints=nullptr, const ModelOptimParam &mop=ModelOptimParam(), Id nb_neighVecchia=30, bool verbose=false, bool trace=false, bool reml=false)

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
	Call the method ACov::evalCovMat of the object ACov.

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
	Call the method ACov::evalCovMatInPlace of the object ACov.

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
	Call the method ACov::evalCovMatInPlaceFromIdx of the object ACov.

MatrixSymmetric	evalCovMatSym (const Db db1, const 1 &nbgh1=1(), Id ivar0=-1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const
	Call the method ACov::evalCovMatSym of the object ACov.

Id	evalCovMatSymInPlace (MatrixSymmetric &mat, const Db db1, const 1 &nbgh1=1(), Id ivar0=-1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const
	Call the method ACov::evalCovMatSymInPlace of the object ACov.

Id	evalCovMatSymInPlaceFromIdx (MatrixSymmetric &mat, const Db db1, const 1 &index1, const CovCalcMode mode=nullptr, bool cleanOptim=true) const
	Call the method ACov::evalCovMatSymInPlaceFromIdx of the object ACov.

MatrixSymmetric	eval0Mat (const CovCalcMode *mode=nullptr) const
	Call the method ACov::eval0Mat of the object ACov.

MatrixSymmetric	evalCovMat0 (const Db *db, Id iech, const KrigOpt &krigopt=KrigOpt()) const
	Call the method ACov::evalCovMat0 of the object ACov.

Id	evalCovMat0InPlace (MatrixSymmetric &mat, const Db *db, Id iech, const KrigOpt &krigopt=KrigOpt()) const
	Call the method ACov::evalCovMat0InPlace of the object ACov.

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
	Call the method ACov::evalCovVecRHSInPlace of the object ACov.

Id	evalCovMatOptimInPlace (MatrixDense &mat, const Db *dbin, const RankHandler &rankhandler, const KrigOpt &krigopt, const ECalcMember &calcMember, 1 &tabwork, double lambda=1.) const
	Call the method ACov::evalCovMatOptimInPlace of the object ACov.

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
	Call the method ACov::evalCovMatRHSInPlaceFromIdx of the object ACov.

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
	Call the method ACov::evalCovMatSparse of the object ACov.

virtual double	eval0 (Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::eval0 of the object ACov.

double	evalCov (const SpacePoint &p1, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalCov of the object ACov.

MatrixSquare	evalNvarIpas (double step, const 1 &dir=1(), const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalNvarIpas of the object ACov.

MatrixSquare	evalNvarIpasIncr (const 1 &dincr, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalNvarIpasIncr of the object ACov.

	evalIvarNlag (const 1 &vec_step, const 1 &dir=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalIvarNlag of the object ACov.

double	evalIvarIpas (double step, const 1 &dir=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalIvarIpas of the object ACov.

double	evalCvv (const 1 &ext, const 1 &ndisc, const 1 &angles=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalCvv of the object ACov.

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
	Call the method ACov::evalCvvShift of the object ACov.

MatrixSquare	evalCvvM (const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalCvvM of the object ACov.

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
	Call the method ACov::evalCxv of the object ACov.

MatrixSquare	evalCxvM (const SpacePoint &p1, const 1 &ext, const 1 &ndisc, const 1 &angles=1(), const 1 &x0=1(), const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalCxvM of the object ACov.

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
	Call the method ACov::evalPointToDb of the object ACov.

void	evalPointToDbAsSP (1 &values, const std::vector< SpacePoint > &p1s, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalPointToDbAsSP of the object ACov.

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
	Call the method ACov::evalAverageDbToDb of the object ACov.

double	evalAverageIncrToIncr (const 1 &d1, const 1 &d2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evalAverageIncrToIncr of the object ACov.

double	evalAveragePointToDb (const SpacePoint &p1, const Db db2, Id ivar=0, Id jvar=0, const CovCalcMode mode=nullptr) const
	Call the method ACov::evalAveragePointToDb of the object ACov.

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
	Call the method ACov::samplingDensityVariance of the object ACov.

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
	Call the method ACov::specificVolume of the object ACov.

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
	Call the method ACov::coefficientOfVariation of the object ACov.

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
	Call the method ACov::specificVolumeFromCoV of the object ACov.

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
	Call the method ACov::extensionVariance of the object ACov.

double	calculateStDev (Db db1, Id iech1, Db db2, Id iech2, bool verbose=false, double factor=1., const CovCalcMode *mode=nullptr) const
	Call the method ACov::calculateStDev of the object ACov.

void	evaluateMatInPlace (const CovInternal covint, const 1 &d1, MatrixSquare &covtab, bool flag_init=false, double weight=1., const CovCalcMode mode=nullptr) const
	Call the method ACov::evaluateMatInPlace of the object ACov.

double	evaluateOneGeneric (const CovInternal covint, const 1 &d1=1(), double weight=1., const CovCalcMode mode=nullptr) const
	Call the method ACov::evaluateOneGeneric of the object ACov.

double	evaluateOneIncr (double hh, const 1 &codir=1(), Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr) const
	Call the method ACov::evaluateOneIncr of the object ACov.

Id	buildVmapOnDbGrid (DbGrid *dbgrid, const NamingConvention &namconv=NamingConvention("VMAP")) const
	Call the method ACov::buildVmapOnDbGrid of the object ACov.

	sample (const 1 &h, const 1 &codir=1(), Id ivar=0, Id jvar=0, const CovCalcMode mode=nullptr, const CovInternal covint=nullptr) const
	Call the method ACov::sample of the object ACov.

	sampleUnitary (const 1 &hh, Id ivar=0, Id jvar=0, 1 codir=1(), const CovCalcMode *mode=nullptr) const
	Call the method ACov::sampleUnitary of the object ACov.

	envelop (const 1 &hh, Id ivar=0, Id jvar=0, Id isign=1, 1 codir=1(), const CovCalcMode *mode=nullptr) const
	Call the method ACov::envelop of the object ACov.

double	gofToVario (const Vario *vario, bool verbose=true) const
	Call the method ACov::gofToVario of the object ACov.

bool	isNoStat () const
	Call the method ACov::isNoStat of the object ACov.

void	manage (const Db db1, const Db db2) const
	Call the method ACov::manage of the object ACov.

void	optimizationPreProcessForData (const Db *db1=nullptr) const
	Call the method ACov::optimizationPreProcessForData of the object ACov.

void	optimizationPostProcess () const
	Call the method ACov::optimizationPostProcess of the object ACov.

const ADrift *	getDrift (Id il) const
	Call the method DriftList::getDrift of the object DriftList.

double	computeDrift (const Db *db, Id ib, Id iech) const
	Call the method DriftList::computeDrift of the object DriftList.

double	evalDriftValue (const Db *db, Id iech, Id ivar, Id ib, const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftValue of the object DriftList.

MatrixDense	evalDriftMat (const Db *db, const 1 &nbgh=1(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftMat of the object DriftList.

Id	evalDriftMatInPlace (MatrixDense &mat, const Db *db, const 1 &nbgh=1(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftMatInPlace of the object DriftList.

MatrixDense	evalDriftMatByRanks (const Db *db, const 1 &sampleRanks=1(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftMatByRanks of the object DriftList.

	evalMeanVecByRanks (const Db *db, const 1 &sampleRanks=1()) const
	Call the method DriftList::evalMeanVecByRanks of the object DriftList.

Id	evalDriftMatByRanksInPlace (MatrixDense &mat, const Db *db, const 1 &sampleranks=1(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftMatByRanksInPlace of the object DriftList.

Id	evalDriftMatByTargetInPlace (MatrixDense &mat, const Db *db, Id iech2, const KrigOpt &krigopt=KrigOpt()) const
	Call the method DriftList::evalDriftMatByTargetInPlace of the object DriftList.

Id	getNDrift () const
	Call the method DriftList::getNDrift of the object DriftList.

Id	getNDriftEquation () const
	Call the method DriftList::getNDriftEquation of the object DriftList.

Id	getNExtDrift () const
	Call the method DriftList::getNExtDrift of the object DriftList.

bool	isFlagLinked () const
	Call the method DriftList::isFlagLinked of the object DriftList.

Id	getDriftMaxIRFOrder () const
	Call the method DriftList::getDriftMaxIRFOrder of the object DriftList.

Id	getRankFex (Id il) const
	Call the method DriftList::getRankFex of the object DriftList.

bool	isDriftSampleDefined (const Db *db, Id ib, Id nech, const 1 &nbgh, const ELoc &loctype) const
	Call the method DriftList::isDriftSampleDefined of the object DriftList.

bool	isDriftFiltered (Id i) const
	Call the method DriftList::isDriftFiltered of the object DriftList.

bool	isDriftDefined (const 1 &powers, Id rank_fex=0) const
	Call the method DriftList::isDriftDefined of the object DriftList.

bool	isDriftDifferentDefined (const 1 &powers, Id rank_fex=-1) const
	Call the method DriftList::isDriftDifferentDefined of the object DriftList.

	getDrifts (const Db *db, bool useSel=true) const
	Call the method DriftList::getDrifts of the object DriftList.

double	evalDrift (const Db *db, Id iech, Id il, const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDrift of the object DriftList.

	evalDriftBySample (const Db *db, Id iech, const ECalcMember &member=ECalcMember::fromKey("LHS")) const
	Call the method DriftList::evalDriftBySample of the object DriftList.

void	evalDriftBySampleInPlace (const Db *db, Id iech, const ECalcMember &member, 1 &drftab) const
	Call the method DriftList::evalDriftBySampleInPlace of the object DriftList.

double	evalDriftCoef (const Db *db, Id iech, const 1 &coeffs) const
	Call the method DriftList::evalDriftCoef of the object DriftList.

bool	hasDrift () const
	Call the method DriftList::hasDrift of the object DriftList.

double	getMean (Id ivar) const
	Call the method DriftList::getMean of the object DriftList.

const &	getMeans () const
	Call the method DriftList::getMeans of the object DriftList.

double	evalDriftVarCoef (const Db *db, Id iech, Id ivar, const 1 &coeffs) const
	Call the method DriftList::evalDriftVarCoef of the object DriftList.

	evalDriftVarCoefs (const Db *db, const 1 &coeffs, bool useSel=false) const
	Call the method DriftList::evalDriftVarCoefs of the object DriftList.

Id	getNVar () const
	Call the method CovContext::getNVar of the object CovContext.

size_t	getNDim (Id ispace=-1) const
	Call the method CovContext::getNDim of the object CovContext.

ASpaceSharedPtr	getSpace () const
	Call the method CovContext::getSpace of the object CovContext.

const &	getCovar0 () const
	Call the method CovContext::getCovar0 of the object CovContext.

double	getField () const
	Call the method CovContext::getField of the object CovContext.

virtual void	setOptimEnabled (bool enabled) const
	Call the method ACov::setOptimEnabled of the object ACov.

void	attachNoStatDb (const Db *db)
	Call the method ACov::attachNoStatDb of the object ACov.

void	makeStationary ()
	Call the method ACov::makeStationary of the object ACov.

void	setContext (const CovContext &ctxt)
	Call the method ACov::setContext of the object ACov.

std::vector< double >	evalCovGrad (const SpacePoint &p1, const SpacePoint &p2, Id ivar=0, Id jvar=0, const CovCalcMode *mode=nullptr)
	Call the method ACov::evalCovGrad of the object ACov.

void	setFlagLinked (bool flagLinked)
	Call the method DriftList::setFlagLinked of the object DriftList.

void	setBetaHat (const 1 &betaHat)
	Call the method DriftList::setBetaHat of the object DriftList.

void	setFiltered (const VectorBool &filtered)
	Call the method DriftList::setFiltered of the object DriftList.

void	delDrift (size_t rank)
	Call the method DriftList::delDrift of the object DriftList.

void	delAllDrifts ()
	Call the method DriftList::delAllDrifts of the object DriftList.

void	copyCovContext (const CovContext &ctxt)
	Call the method DriftList::copyCovContext of the object DriftList.

void	setMeans (const 1 &mean)
	Call the method DriftList::setMeans of the object DriftList.

void	setMean (const double mean, Id ivar=0)
	Call the method DriftList::setMean of the object DriftList.

void	setField (double field)
	Call the method CovContext::setField of the object CovContext.

void	setCovar0s (const 1 &covar0)
	Call the method CovContext::setCovar0s of the object CovContext.

void	setCovar0 (Id ivar, Id jvar, double covar0)
	Call the method CovContext::setCovar0 of the object CovContext.

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

Static Public Member Functions
static Model *	create (const CovContext &ctxt=CovContext())

static Model *	createFromEnvironment (Id nvar, Id ndim=2)

static Model *	createNugget (Id nvar, Id ndim=2, double sill=1.)

static Model *	createFromParam (const ECov &type=ECov::fromKey("NUGGET"), double range=1., double sill=1., double param=1., const 1 &ranges=1(), const MatrixSymmetric &sills=MatrixSymmetric(), const 1 &angles=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr(), bool flagRange=true)

static Model *	createFromParamOldStyle (const ECov &type=ECov::fromKey("NUGGET"), double range=1., double sill=1., double param=1., const 1 &ranges=1(), const 1 &sills=1(), const 1 &angles=1(), const ASpaceSharedPtr &space=ASpaceSharedPtr(), bool flagRange=true)

static Model *	createFromDb (const Db *db)

static Model *	createFromNF (const String &NFFilename, bool verbose=true)

static Model *	createFromVario (Vario *vario, const VectorECov &types=ECov::fromKeys({"SPHERICAL"}), const Constraints &constraints=Constraints(), const Option_VarioFit &optvar=Option_VarioFit(), const Option_AutoFit &mauto=Option_AutoFit(), bool verbose=false)

static Model *	createFillRandom (Id ndim, Id nvar, const std::vector< ECov > &types=ECov::fromKeys({"SPHERICAL"}), double hmax=1, Id order=-1, Id nfex=0, Id seed=13242)

static void	gofDisplay (double gof, bool byValue=true, const 1 &thresholds={2., 5., 10., 100})

static VectorECov	initCovList (const 1 &covranks)

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

Static Public Member Functions inherited from gstlrn::ModelGeneric
static ListParams *	createListParams (std::shared_ptr< ListParams > &lp)

Constructor & Destructor Documentation

◆ Model() [1/3]

gstlrn::Model::Model ( const CovContext & ctxt = CovContext() )

◆ Model() [2/3]

gstlrn::Model::Model	(	Id	nvar,
		Id	ndim = `2`
	)

◆ Model() [3/3]

gstlrn::Model::Model ( const Model & m )

◆ ~Model()

gstlrn::Model::~Model ( )

virtual

Member Function Documentation

◆ _castInCovAnisoList()

CovAnisoList * gstlrn::Model::_castInCovAnisoList ( Id icov = -1 )

◆ _castInCovLMCAnamorphosis()

CovLMCAnamorphosis * gstlrn::Model::_castInCovLMCAnamorphosis ( )

◆ _castInCovLMCTapering()

CovLMCTapering * gstlrn::Model::_castInCovLMCTapering ( )

◆ _castInCovLMGradient()

CovLMGradient * gstlrn::Model::_castInCovLMGradient ( )

◆ addCovAniso()

void gstlrn::Model::addCovAniso ( const CovAniso & cov )

◆ addCovFromParam()

void gstlrn::Model::addCovFromParam	(	const ECov &	type,
		double	range = `EPSILON6`,
		double	sill = `1.`,
		double	param = `1.`,
		const 1 &	ranges = `1()`,
		const MatrixSymmetric &	sills = `MatrixSymmetric()`,
		const 1 &	angles = `1()`,
		bool	flagRange = `true`
	)

◆ addCovFromParamOldStyle()

void gstlrn::Model::addCovFromParamOldStyle	(	const ECov &	type,
		double	range = `EPSILON6`,
		double	sill = `1.`,
		double	param = `1.`,
		const 1 &	ranges = `1()`,
		const 1 &	sills = `1()`,
		const 1 &	angles = `1()`,
		bool	flagRange = `true`
	)

◆ castInCovAnisoListConst()

const CovAnisoList * gstlrn::Model::castInCovAnisoListConst ( Id icov = -1 ) const

This internal function tries to cast the member '_cova' into a pointer to CovAnisoList and checks the validity of the argument 'icov' which gives the rank within this list

Parameters

icov	Rank of the CovAniso (to be checked if >= 0)

Returns: 'nullptr' if not valid cast (the error message is printed internally)

◆ castInCovLMCAnamorphosisConst()

const CovLMCAnamorphosis * gstlrn::Model::castInCovLMCAnamorphosisConst ( ) const

◆ castInCovLMCTaperingConst()

const CovLMCTapering * gstlrn::Model::castInCovLMCTaperingConst ( ) const

◆ castInCovLMGradientConst()

const CovLMGradient * gstlrn::Model::castInCovLMGradientConst ( ) const

◆ create()

Model * gstlrn::Model::create ( const CovContext & ctxt = CovContext() )

static

◆ createFillRandom()

Model * gstlrn::Model::createFillRandom	(	Id	ndim,
		Id	nvar,
		const std::vector< ECov > &	types = `ECov::fromKeys({"SPHERICAL"})`,
		double	hmax = `1`,
		Id	order = `-1`,
		Id	nfex = `0`,
		Id	seed = `13242`
	)

static

◆ createFromDb()

Model * gstlrn::Model::createFromDb ( const Db * db )

static

◆ createFromEnvironment()

Model * gstlrn::Model::createFromEnvironment	(	Id	nvar,
		Id	ndim = `2`
	)

static

◆ createFromNF()

Model * gstlrn::Model::createFromNF	(	const String &	NFFilename,
		bool	verbose = `true`
	)

static

◆ createFromParam()

Model * gstlrn::Model::createFromParam	(	const ECov &	type = `ECov::fromKey("NUGGET")`,
		double	range = `1.`,
		double	sill = `1.`,
		double	param = `1.`,
		const 1 &	ranges = `1()`,
		const MatrixSymmetric &	sills = `MatrixSymmetric()`,
		const 1 &	angles = `1()`,
		const ASpaceSharedPtr &	space = `ASpaceSharedPtr()`,
		bool	flagRange = `true`
	)

static

◆ createFromParamOldStyle()

Model * gstlrn::Model::createFromParamOldStyle	(	const ECov &	type = `ECov::fromKey("NUGGET")`,
		double	range = `1.`,
		double	sill = `1.`,
		double	param = `1.`,
		const 1 &	ranges = `1()`,
		const 1 &	sills = `1()`,
		const 1 &	angles = `1()`,
		const ASpaceSharedPtr &	space = `ASpaceSharedPtr()`,
		bool	flagRange = `true`
	)

static

◆ createFromVario()

Model * gstlrn::Model::createFromVario	(	Vario *	vario,
		const VectorECov &	types = `ECov::fromKeys({"SPHERICAL"})`,
		const Constraints &	constraints = `Constraints()`,
		const Option_VarioFit &	optvar = `Option_VarioFit()`,
		const Option_AutoFit &	mauto = `Option_AutoFit()`,
		bool	verbose = `false`
	)

static

◆ createNugget()

Model * gstlrn::Model::createNugget	(	Id	nvar,
		Id	ndim = `2`,
		double	sill = `1.`
	)

static

◆ createReduce()

Model * gstlrn::Model::createReduce ( const 1 & validVars ) const

◆ duplicate()

Model * gstlrn::Model::duplicate ( ) const

◆ evalCovFromIncr()

double gstlrn::Model::evalCovFromIncr	(	const 1 &	incr,
		Id	icov = `0`,
		const ECalcMember &	member = `ECalcMember::fromKey("LHS")`
	)		const

◆ evalZAndGradients()

void gstlrn::Model::evalZAndGradients	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		double &	covVal,
		1 &	covGp,
		1 &	covGG,
		const CovCalcMode *	mode = `nullptr`,
		bool	flagGrad = `false`
	)		const

Call the method CovLMGradient::evalZAndGradients of the object CovLMGradient.

◆ extractCova()

CovAniso gstlrn::Model::extractCova ( Id icov ) const

Call the method CovAnisoList::extractCova of the object CovAnisoList.

◆ fit()

Id gstlrn::Model::fit	(	Vario *	vario,
		const VectorECov &	types = `ECov::fromKeys({"SPHERICAL"})`,
		const Constraints &	constraints = `Constraints()`,
		const Option_VarioFit &	optvar = `Option_VarioFit()`,
		const Option_AutoFit &	mauto = `Option_AutoFit()`,
		bool	verbose = `false`
	)

Automatic Fitting procedure from an experimental Variogram

Parameters

vario	Experimental variogram to be fitted
types	Vector of ECov (see remarks)
constraints	Set of Constraints
optvar	Set of options
mauto	Special parameters for Automatic fitting procedure (instance of Option_AutoFit), for exemple wmode (type of weighting function)
verbose	Verbose option

Remarks: If no list of specific basic structure is specified, the automatic fitting is performed using a single spherical structure by default.

Returns: 0 if no error, 1 otherwise

TODO : What to do with that ?

◆ fitFromCovIndices()

Id gstlrn::Model::fitFromCovIndices	(	Vario *	vario,
		const VectorECov &	types = `ECov::fromKeys({"EXPONENTIAL"})`,
		const Constraints &	constraints = `Constraints()`,
		const Option_VarioFit &	optvar = `Option_VarioFit()`,
		const Option_AutoFit &	mauto = `Option_AutoFit()`,
		bool	verbose = `false`
	)

Automatic Fitting procedure

Parameters

vario	Experimental variogram to be fitted
types	Vector of ECov integer values
constraints	Set of Constraints
optvar	Set of options
mauto	Special parameters for Automatic fitting procedure
verbose	Verbose option

Returns: 0 if no error, 1 otherwise

TODO : What to do with that ?

◆ fitFromVMap()

Id gstlrn::Model::fitFromVMap	(	DbGrid *	dbmap,
		const VectorECov &	types = `ECov::fromKeys({"SPHERICAL"})`,
		const Constraints &	constraints = `Constraints()`,
		const Option_VarioFit &	optvar = `Option_VarioFit()`,
		const Option_AutoFit &	mauto = `Option_AutoFit()`,
		bool	verbose = `false`
	)

Automatic Fitting procedure from A Variogram Map stored on a DbGrid

Parameters

dbmap	DbGrid containing the Variogram Map
types	Vector of ECov
constraints	Set of Constraints
optvar	Set of options
mauto	Special parameters for Automatic fitting procedure (instance of Option_AutoFit), for exemple wmode (type of weighting function)
verbose	Verbose option

Returns: 0 if no error, 1 otherwise

◆ getActiveFactor()

virtual Id gstlrn::Model::getActiveFactor ( ) const

virtual

Call the method CovAnisoList::getActiveFactor of the object CovAnisoList.

◆ getAnam()

virtual const AAnam * gstlrn::Model::getAnam ( ) const

virtual

Call the method CovAnisoList::getAnam of the object CovAnisoList.

◆ getAnamHermite()

const AnamHermite * gstlrn::Model::getAnamHermite ( ) const

Call the method CovAnisoList::getAnamHermite of the object CovAnisoList.

◆ getAnamNClass()

virtual Id gstlrn::Model::getAnamNClass ( ) const

virtual

Call the method CovAnisoList::getAnamNClass of the object CovAnisoList.

◆ getAngles()

gstlrn::Model::getAngles ( Id icov ) const

Call the method CovAnisoList::getAngles of the object CovAnisoList.

◆ getBallRadius()

double gstlrn::Model::getBallRadius ( ) const

Call the method CovAnisoList::getBallRadius of the object CovAnisoList.

◆ getCovAniso() [1/2]

const CovAniso * gstlrn::Model::getCovAniso ( Id icov ) const

Call the method CovAnisoList::getCovAniso of the object CovAnisoList.

◆ getCovAniso() [2/2]

const CovAniso * gstlrn::Model::getCovAniso ( Id icov ) const

Call the method CovAnisoList::getCovAniso of the object CovAnisoList.

◆ getCovAnisoList()

const CovAnisoList * gstlrn::Model::getCovAnisoList ( ) const

TODO : to be removed (encapsulation of CovAnisoList)

◆ getCovAnisoListModify()

CovAnisoList * gstlrn::Model::getCovAnisoListModify ( )

◆ getCovMinIRFOrder()

Id gstlrn::Model::getCovMinIRFOrder ( ) const

Call the method CovAnisoList::getCovMinIRFOrder of the object CovAnisoList.

◆ getCovMode()

const EModelProperty & gstlrn::Model::getCovMode ( ) const

Call the method CovAnisoList::getCovMode of the object CovAnisoList.

◆ getCovName()

String gstlrn::Model::getCovName ( Id icov ) const

override

Call the method CovAnisoList::getCovName of the object CovAnisoList.

◆ getCovType()

const ECov & gstlrn::Model::getCovType ( Id icov ) const

override

Call the method CovAnisoList::getCovType of the object CovAnisoList.

◆ getMaximumDistance()

double gstlrn::Model::getMaximumDistance ( ) const

Call the method CovAnisoList::getMaximumDistance of the object CovAnisoList.

◆ getNCov()

Id gstlrn::Model::getNCov ( bool skipNugget = false ) const

Call the method CovAnisoList::getNCov of the object CovAnisoList.

◆ getNGradParam()

Id gstlrn::Model::getNGradParam ( Id icov ) const

Call the method CovAnisoList::getNGradParam of the object CovAnisoList.

◆ getNVar()

Id gstlrn::Model::getNVar ( ) const

◆ getParam()

double gstlrn::Model::getParam ( Id icov ) const

Call the method CovAnisoList::getParam of the object CovAnisoList.

◆ getRange()

double gstlrn::Model::getRange ( Id icov ) const

Call the method CovAnisoList::getRange of the object CovAnisoList.

◆ getRanges()

gstlrn::Model::getRanges ( Id icov ) const

Call the method CovAnisoList::getRanges of the object CovAnisoList.

◆ getRankNugget()

Id gstlrn::Model::getRankNugget ( ) const

Call the method CovAnisoList::getRankNugget of the object CovAnisoList.

◆ gofDisplay()

void gstlrn::Model::gofDisplay	(	double	gof,
		bool	byValue = `true`,
		const 1 &	thresholds = `{2., 5., 10., 100}`
	)

static

◆ hasAnam()

virtual bool gstlrn::Model::hasAnam ( ) const

virtual

Call the method CovAnisoList::hasAnam of the object CovAnisoList.

◆ hasExternalCov()

Id gstlrn::Model::hasExternalCov ( ) const

Call the method CovAnisoList::hasExternalCov of the object CovAnisoList.

◆ hasNugget()

bool gstlrn::Model::hasNugget ( ) const

Call the method CovAnisoList::hasNugget of the object CovAnisoList.

◆ initCovList()

VectorECov gstlrn::Model::initCovList ( const 1 & covranks )

static

◆ isChangeSupportDefined()

bool gstlrn::Model::isChangeSupportDefined ( ) const

Call the method CovAnisoList::isChangeSupportDefined of the object CovAnisoList.

◆ isFlagGradient()

bool gstlrn::Model::isFlagGradient ( ) const

◆ isFlagGradientFunctional()

bool gstlrn::Model::isFlagGradientFunctional ( ) const

◆ isFlagGradientNumerical()

bool gstlrn::Model::isFlagGradientNumerical ( ) const

◆ isValid()

bool gstlrn::Model::isValid ( ) const

◆ makeAngleNoStatDb()

void gstlrn::Model::makeAngleNoStatDb	(	Id	icov,
		const String &	namecol,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeAngleNoStatDb of the object CovAnisoList.

◆ makeAngleNoStatFunctional()

void gstlrn::Model::makeAngleNoStatFunctional	(	Id	icov,
		const AFunctional *	func,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeAngleNoStatFunctional of the object CovAnisoList.

◆ makeAngleStationary()

void gstlrn::Model::makeAngleStationary	(	Id	icov,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeAngleStationary of the object CovAnisoList.

◆ makeParamNoStatDb()

void gstlrn::Model::makeParamNoStatDb	(	Id	icov,
		const String &	namecol
	)

Call the method CovAnisoList::makeParamNoStatDb of the object CovAnisoList.

◆ makeParamNoStatFunctional()

void gstlrn::Model::makeParamNoStatFunctional	(	Id	icov,
		const AFunctional *	func
	)

Call the method CovAnisoList::makeParamNoStatFunctional of the object CovAnisoList.

◆ makeParamStationary()

void gstlrn::Model::makeParamStationary ( Id icov )

Call the method CovAnisoList::makeParamStationary of the object CovAnisoList.

◆ makeRangeNoStatDb()

void gstlrn::Model::makeRangeNoStatDb	(	Id	icov,
		const String &	namecol,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeRangeNoStatDb of the object CovAnisoList.

◆ makeRangeNoStatFunctional()

void gstlrn::Model::makeRangeNoStatFunctional	(	Id	icov,
		const AFunctional *	func,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeRangeNoStatFunctional of the object CovAnisoList.

◆ makeRangeStationary()

void gstlrn::Model::makeRangeStationary	(	Id	icov,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeRangeStationary of the object CovAnisoList.

◆ makeScaleNoStatDb()

void gstlrn::Model::makeScaleNoStatDb	(	Id	icov,
		const String &	namecol,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeScaleNoStatDb of the object CovAnisoList.

◆ makeScaleNoStatFunctional()

void gstlrn::Model::makeScaleNoStatFunctional	(	Id	icov,
		const AFunctional *	func,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeScaleNoStatFunctional of the object CovAnisoList.

◆ makeScaleStationary()

void gstlrn::Model::makeScaleStationary	(	Id	icov,
		Id	idim = `0`
	)

Call the method CovAnisoList::makeScaleStationary of the object CovAnisoList.

◆ makeTensorNoStatDb()

void gstlrn::Model::makeTensorNoStatDb	(	Id	icov,
		const String &	namecol,
		Id	idim = `0`,
		Id	jdim = `0`
	)

Call the method CovAnisoList::makeTensorNoStatDb of the object CovAnisoList.

◆ makeTensorNoStatFunctional()

void gstlrn::Model::makeTensorNoStatFunctional	(	Id	icov,
		const AFunctional *	func,
		Id	idim = `0`,
		Id	jdim = `0`
	)

Call the method CovAnisoList::makeTensorNoStatFunctional of the object CovAnisoList.

◆ makeTensorStationary()

void gstlrn::Model::makeTensorStationary	(	Id	icov,
		Id	idim,
		Id	jdim
	)

Call the method CovAnisoList::makeTensorStationary of the object CovAnisoList.

◆ operator=()

Model & gstlrn::Model::operator= ( const Model & m )

◆ resetFromDb()

Id gstlrn::Model::resetFromDb ( const Db * db )

◆ setActiveFactor()

virtual void gstlrn::Model::setActiveFactor ( Id )

virtual

Call the method CovAnisoList::setActiveFactor of the object CovAnisoList.

◆ setAnam()

Id gstlrn::Model::setAnam	(	const AAnam *	anam,
		const 1 &	strcnt = `1()`
	)

Defining an Anamorphosis information for the Model (in fact, this is added to CovAnisoList part and transforms it from CovAnisoList to CovLMCAnamorphosis

Parameters

anam	Pointer to the anamorphosis
strcnt	Array of covariance description used for IR case

Returns

◆ setCovAnisoList()

void gstlrn::Model::setCovAnisoList ( const CovAnisoList * covalist )

Add a list of Covariances. This operation cleans any previously stored covariance

Parameters

covalist List of Covariances to be added

◆ setMarkovCoeffs()

void gstlrn::Model::setMarkovCoeffs	(	Id	icov,
		const 1 &	coeffs
	)

Call the method CovAnisoList::setMarkovCoeffs of the object CovAnisoList.

◆ setRangeIsotropic()

void gstlrn::Model::setRangeIsotropic	(	Id	icov,
		double	range
	)

Call the method CovAnisoList::setRangeIsotropic of the object CovAnisoList.

◆ setTapeRange()

void gstlrn::Model::setTapeRange ( double range )

Call the method CovLMCTapering::setTapeRange of the object CovLMCTapering.

◆ stabilize()

Id gstlrn::Model::stabilize	(	double	percent,
		bool	verbose = `false`
	)

Stabilize the model (in the monovariate case)

Returns: Error returned code

Parameters

[in]	percent	Percentage of nugget effect added
[in]	verbose	true for a verbose output

Remarks: If the model only contains GAUSSIAN structures, add; a NUGGET EFFECT structure with a sill equal to a percentage; of the total sill of the GAUSSIAN component(s); This function does not do anything in the multivariate case

◆ standardize()

Id gstlrn::Model::standardize ( bool verbose = false )

Normalize the model

Parameters

[in] verbose true for a verbose output

◆ switchToGradient()

void gstlrn::Model::switchToGradient ( )

Switch to a Model dedicated to Gradients (transforms it from CovAnisoList to CovLMGradient)

◆ toString()

String gstlrn::Model::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from gstlrn::AStringable.

◆ unsetAnam()

Id gstlrn::Model::unsetAnam ( )

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

include/Model/Model.hpp
build/doxygen/generated_hpp/Model.hpp
src/Model/Model.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ Model() [1/3]

◆ Model() [2/3]

◆ Model() [3/3]

◆ ~Model()

Member Function Documentation

◆ _castInCovAnisoList()

◆ _castInCovLMCAnamorphosis()

◆ _castInCovLMCTapering()

◆ _castInCovLMGradient()

◆ addCovAniso()

◆ addCovFromParam()

◆ addCovFromParamOldStyle()

◆ castInCovAnisoListConst()

◆ castInCovLMCAnamorphosisConst()

◆ castInCovLMCTaperingConst()

◆ castInCovLMGradientConst()

◆ create()

◆ createFillRandom()

◆ createFromDb()

◆ createFromEnvironment()

◆ createFromNF()

◆ createFromParam()

◆ createFromParamOldStyle()

◆ createFromVario()

◆ createNugget()

◆ createReduce()

◆ duplicate()

◆ evalCovFromIncr()

◆ evalZAndGradients()

◆ extractCova()

◆ fit()

◆ fitFromCovIndices()

◆ fitFromVMap()

◆ getActiveFactor()

◆ getAnam()

◆ getAnamHermite()

◆ getAnamNClass()

◆ getAngles()

◆ getBallRadius()

◆ getCovAniso() [1/2]

◆ getCovAniso() [2/2]

◆ getCovAnisoList()

◆ getCovAnisoListModify()

◆ getCovMinIRFOrder()

◆ getCovMode()

◆ getCovName()

◆ getCovType()

◆ getMaximumDistance()

◆ getNCov()

◆ getNGradParam()

◆ getNVar()

◆ getParam()

◆ getRange()

◆ getRanges()

◆ getRankNugget()

◆ gofDisplay()

◆ hasAnam()

◆ hasExternalCov()

◆ hasNugget()

◆ initCovList()

◆ isChangeSupportDefined()

◆ isFlagGradient()

◆ isFlagGradientFunctional()

◆ isFlagGradientNumerical()

◆ isValid()

◆ makeAngleNoStatDb()

◆ makeAngleNoStatFunctional()

◆ makeAngleStationary()

◆ makeParamNoStatDb()

◆ makeParamNoStatFunctional()

◆ makeParamStationary()

◆ makeRangeNoStatDb()

◆ makeRangeNoStatFunctional()

◆ makeRangeStationary()

◆ makeScaleNoStatDb()

◆ makeScaleNoStatFunctional()