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 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 (int nvar, int ndim=2)

	Model (const Model &m)

Model &	operator= (const Model &m)

virtual	~Model ()

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

int	resetFromDb (const Db *db)

void	setCovList (const ACovAnisoList *covalist)

void	addCov (const CovAniso *cov)

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

void	delCova (int icov)

void	delAllCovas ()

void	setDriftList (const DriftList *driftlist)

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

void	setFlagLinked (bool flagLinked)

void	addDrift (const ADrift *drift)

void	setDrifts (const VectorString &driftSymbols)

void	delDrift (int rank)

void	delAllDrifts ()

int	setAnam (const AAnam *anam, const VectorInt &strcnt=VectorInt())

int	unsetAnam ()

bool	isFlagGradient () const

bool	isFlagGradientNumerical () const

bool	isFlagGradientFunctional () const

bool	isFlagLinked () const

CovAniso	extractCova (int icov) const

void	switchToGradient ()

bool	hasDrift () const

const ACovAnisoList *	getCovAnisoList () const
	TODO : to be removed (encapsulation of ACovAnisoList) More...

ACovAnisoList *	getCovAnisoListModify ()

const CovAniso *	getCova (int icov) const

CovAniso *	getCova (int icov)

int	getCovaNumber (bool skipNugget=false) const

const ECov &	getCovaType (int icov) const

const MatrixSquareSymmetric &	getSillValues (int icov) const

double	getSill (int icov, int ivar, int jvar) const

double	getRange (int icov) const

VectorDouble	getRanges (int icov) const

double	getParam (int icov) const

String	getCovName (int icov) const

int	getGradParamNumber (int icov) const

double	getTotalSill (int ivar=0, int jvar=0) const

MatrixSquareSymmetric	getTotalSills () const

double	getBallRadius () const

const AnamHermite *	getAnamHermite () const

double	getMaximumDistance () const

int	getCovaMinIRFOrder () const

bool	hasAnam () const

const AAnam *	getAnam () const

bool	isChangeSupportDefined () const

void	normalize (double sill)

bool	hasNugget () const

int	getRankNugget () const

VectorInt	getActiveCovList () const

VectorInt	getAllActiveCovList () const

bool	isAllActiveCovList () const

void	setTapeRange (double range)

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

MatrixSquareGeneral	eval0Nvar (const CovCalcMode *mode=nullptr) const

void	eval0MatInPlace (MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const

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

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

MatrixSquareGeneral	evalMat (const SpacePoint &p1, const SpacePoint &p2, const CovCalcMode *mode=nullptr) const

void	evalMatInPlace (const SpacePoint &p1, const SpacePoint &p2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const

MatrixSquareGeneral	evalNvarIpasIncr (const VectorDouble &dincr, const CovCalcMode *mode=nullptr) const

VectorDouble	evalIvarNpas (const VectorDouble &vec_step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const

double	evalIvarIpas (double step, const VectorDouble &dir=VectorDouble(), int ivar=0, int jvar=0, 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

MatrixSquareGeneral	evalCvvM (const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const CovCalcMode *mode=nullptr)

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)

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

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

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

MatrixRectangular	evalCovMatrix (Db db1, Db db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr)

MatrixSquareSymmetric	evalCovMatrixSymmetric (Db db1, int ivar0=-1, const VectorInt &nbgh1=VectorInt(), const CovCalcMode mode=nullptr)

MatrixSparse *	evalCovMatrixSparse (Db db1, Db db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, double eps=EPSILON3)

VectorDouble	evalCovMatrixV (Db db1, Db db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr)

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

MatrixSquareSymmetric	evalCovMatrixSymmetricOptim (const Db db1, int ivar0=-1, const VectorInt &nbgh1=VectorInt(), const CovCalcMode mode=nullptr)

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)

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

void	evalZAndGradients (const SpacePoint &p1, const SpacePoint &p2, double &covVal, VectorDouble &covGp, VectorDouble &covGG, const CovCalcMode *mode=nullptr, bool flagGrad=false) const

void	evalZAndGradients (const VectorDouble &vec, double &covVal, VectorDouble &covGp, VectorDouble &covGG, const CovCalcMode *mode=nullptr, bool flagGrad=false) const

double	evalCov (const VectorDouble &incr, int icov=0, const ECalcMember &member=ECalcMember::fromKey("LHS")) const

void	setSill (int icov, int ivar, int jvar, double value)

void	setRangeIsotropic (int icov, double range)

void	setMarkovCoeffs (int icov, const VectorDouble &coeffs)

void	setCovaFiltered (int icov, bool filtered)

void	setActiveFactor (int iclass)

int	getActiveFactor () const

int	getAnamNClass () const

const DriftList *	getDriftList () const
	TODO : to be removed (encapsulation of DriftList) More...

const ADrift *	getDrift (int il) const

int	getDriftNumber () const

int	getExternalDriftNumber () const

int	getRankFext (int il) const

int	getDriftEquationNumber () const

bool	isDriftFiltered (unsigned int il) const

int	getDriftMaxIRFOrder (void) const

bool	isDriftDefined (const VectorInt &powers, int rank_fex=0) const

bool	isDriftDifferentDefined (const VectorInt &powers, int rank_fex=-1) const

bool	isDriftSampleDefined (const Db *db, int ib, int nech, const VectorInt &nbgh, const ELoc &loctype) const

void	setDriftFiltered (int il, bool filtered)

VectorVectorDouble	getDrifts (const Db *db, bool useSel=true)

void	setBetaHat (const VectorDouble &betaHat)

double	evalDrift (const Db *db, int iech, int il, const ECalcMember &member=ECalcMember::fromKey("LHS")) const

double	evalDriftValue (const Db *db, int iech, int ivar, int ib, const ECalcMember &member=ECalcMember::fromKey("LHS")) const

VectorDouble	evalDriftBySample (const Db *db, int iech, const ECalcMember &member=ECalcMember::fromKey("LHS")) const

void	evalDriftBySampleInPlace (const Db *db, int iech, const ECalcMember &member, VectorDouble &drftab) const

MatrixRectangular	evalDriftMatrix (const Db *db, int ivar0=-1, const VectorInt &nbgh=VectorInt(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const

double	evalDriftVarCoef (const Db *db, int iech, int ivar, const VectorDouble &coeffs) const

VectorDouble	evalDriftVarCoefs (const Db *db, const VectorDouble &coeffs, int ivar=0, bool useSel=false) const

const CovContext &	getContext () const
	TODO : to be removed (encapsulation of Context) More...

const ASpace *	getASpace () const

const VectorDouble &	getMeans () const

double	getMean (int ivar) const

const VectorDouble &	getCovar0s () const

double	getCovar0 (int ivar, int jvar) const

double	getField () const

int	getDimensionNumber () const

void	setMeans (const VectorDouble &mean)

void	setMean (double mean, int ivar=0)

void	setCovar0s (const VectorDouble &covar0)

void	setCovar0 (int ivar, int jvar, double covar0)

void	setField (double field)

const EModelProperty &	getCovMode () const

Model *	duplicate () const

Model *	createReduce (const VectorInt &validVars) const

int	getVariableNumber () const

int	hasExternalCov () const

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

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

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

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

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

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

int	stabilize (double percent, bool verbose=false)

int	standardize (bool verbose=false)

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

bool	isValid () const

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

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

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

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

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

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

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

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

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

virtual	~ASerializable ()

bool	deserialize (std::istream &is, bool verbose=true)

bool	serialize (std::ostream &os, bool verbose=true) const

bool	dumpToNF (const String &neutralFilename, bool verbose=false) const

Public Member Functions inherited from ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

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

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

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

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

static Model *	createFromDb (const Db *db)

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

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

static VectorECov	initCovList (const VectorInt &covranks)

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

static String	getHomeDirectory (const String &sub="")

static String	getWorkingDirectory ()

static String	getTestData (const String &subdir, const String &filename)

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

static void	setContainerName (bool useDefault, const String &containerName="", bool verbose=false)

static void	unsetContainerName ()

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getContainerName ()

static const String &	getPrefixName ()

static bool	createDirectory (const String &dir)

static String	getExecDirectory ()

static String	getDirectory (const String &path)

Constructor & Destructor Documentation

◆ Model() [1/3]

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

◆ Model() [2/3]

Model::Model	(	int	nvar,
		int	ndim = `2`
	)

◆ Model() [3/3]

Model::Model ( const Model & m )

◆ ~Model()

Model::~Model ( )

virtual

Member Function Documentation

◆ addCov()

void Model::addCov ( const CovAniso * cov )

◆ addCovFromParam()

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

◆ addDrift()

void Model::addDrift ( const ADrift * drift )

◆ create()

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

static

◆ createFromDb()

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

static

◆ createFromEnvironment()

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

static

◆ createFromNF()

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

static

◆ createFromParam()

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

static

◆ createNugget()

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

static

◆ delAllCovas()

void Model::delAllCovas ( )

◆ delAllDrifts()

void Model::delAllDrifts ( )

◆ delCova()

void Model::delCova ( int icov )

◆ delDrift()

void Model::delDrift ( int rank )

◆ eval()

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

inline

◆ eval0()

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

inline

◆ eval0MatInPlace()

void Model::eval0MatInPlace	(	MatrixSquareGeneral &	mat,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

Calculate the Matrix of covariance for zero distance

Parameters

mat	Covariance matrix (Dimension: nvar * nvar)
mode	Calculation Options

Remarks: : Matrix 'mat' should be dimensioned and initialized beforehand

◆ eval0Nvar()

MatrixSquareGeneral Model::eval0Nvar ( const CovCalcMode * mode = nullptr ) const

inline

◆ evalAverageDbToDb()

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

inline

◆ evalAverageIncrToIncr()

double Model::evalAverageIncrToIncr	(	const VectorVectorDouble &	d1,
		const VectorVectorDouble &	d2,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalAveragePointToDb()

double Model::evalAveragePointToDb	(	const SpacePoint &	p1,
		const Db *	db2,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)

inline

◆ evalCvv()

double Model::evalCvv	(	const VectorDouble &	ext,
		const VectorInt &	ndisc,
		const VectorDouble &	angles = `VectorDouble()`,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalCvvM()

MatrixSquareGeneral Model::evalCvvM	(	const VectorDouble &	ext,
		const VectorInt &	ndisc,
		const VectorDouble &	angles = `VectorDouble()`,
		const CovCalcMode *	mode = `nullptr`
	)

inline

◆ evalCvvShift()

double Model::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

inline

◆ evalCxv()

double Model::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`
	)

inline

◆ evalCxvM()

MatrixSquareGeneral Model::evalCxvM	(	const SpacePoint &	p1,
		const VectorDouble &	ext,
		const VectorInt &	ndisc,
		const VectorDouble &	angles = `VectorDouble()`,
		const VectorDouble &	x0 = `VectorDouble()`,
		const CovCalcMode *	mode = `nullptr`
	)

inline

◆ evalIvarIpas()

double Model::evalIvarIpas	(	double	step,
		const VectorDouble &	dir = `VectorDouble()`,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalIvarNpas()

VectorDouble Model::evalIvarNpas	(	const VectorDouble &	vec_step,
		const VectorDouble &	dir = `VectorDouble()`,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalMat()

MatrixSquareGeneral Model::evalMat	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalMatInPlace()

void Model::evalMatInPlace	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		MatrixSquareGeneral &	mat,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

Calculate the Matrix of covariance between two space points

Parameters

p1	Reference of the first space point
p2	Reference of the second space point
mat	Covariance matrix (Dimension: nvar * nvar)
mode	Calculation Options

Remarks: : Matrix 'mat' should be dimensioned and initialized beforehand

◆ evalNvarIpas()

MatrixSquareGeneral Model::evalNvarIpas	(	double	step,
		const VectorDouble &	dir,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalNvarIpasIncr()

MatrixSquareGeneral Model::evalNvarIpasIncr	(	const VectorDouble &	dincr,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ evalPointToDb()

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

inline

◆ evalPointToDbAsSP()

VectorDouble Model::evalPointToDbAsSP	(	const std::vector< SpacePoint > &	p1s,
		const SpacePoint &	p2,
		int	ivar = `0`,
		int	jvar = `0`,
		const CovCalcMode *	mode = `nullptr`
	)		const

inline

◆ extractCova()

CovAniso Model::extractCova ( int icov ) const

◆ getActiveCovList()

VectorInt Model::getActiveCovList ( ) const

◆ getAllActiveCovList()

VectorInt Model::getAllActiveCovList ( ) const

◆ getAnam()

const AAnam * Model::getAnam ( ) const

◆ getAnamHermite()

const AnamHermite * Model::getAnamHermite ( ) const

◆ getBallRadius()

double Model::getBallRadius ( ) const

Returns the Ball radius (from the first covariance of _covaList)

Returns: Value of the Ball Radius (if defined, i.e. for Numerical Gradient calculation)

◆ getCova() [1/2]

CovAniso * Model::getCova ( int icov )

◆ getCova() [2/2]

const CovAniso * Model::getCova ( int icov ) const

◆ getCovaMinIRFOrder()

int Model::getCovaMinIRFOrder ( ) const

◆ getCovAnisoList()

const ACovAnisoList * Model::getCovAnisoList ( ) const

TODO : to be removed (encapsulation of ACovAnisoList)

◆ getCovAnisoListModify()

ACovAnisoList * Model::getCovAnisoListModify ( )

◆ getCovaNumber()

int Model::getCovaNumber ( bool skipNugget = false ) const

◆ getCovaType()

const ECov & Model::getCovaType ( int icov ) const

◆ getCovName()

String Model::getCovName ( int icov ) const

◆ getGradParamNumber()

int Model::getGradParamNumber ( int icov ) const

◆ getMaximumDistance()

double Model::getMaximumDistance ( ) const

◆ getParam()

double Model::getParam ( int icov ) const

◆ getRange()

double Model::getRange ( int icov ) const

◆ getRanges()

VectorDouble Model::getRanges ( int icov ) const

◆ getRankNugget()

int Model::getRankNugget ( ) const

◆ getSill()

double Model::getSill	(	int	icov,
		int	ivar,
		int	jvar
	)		const

◆ getSillValues()

const MatrixSquareSymmetric & Model::getSillValues ( int icov ) const

◆ getTotalSill()

double Model::getTotalSill	(	int	ivar = `0`,
		int	jvar = `0`
	)		const

◆ getTotalSills()

MatrixSquareSymmetric Model::getTotalSills ( ) const

◆ hasAnam()

bool Model::hasAnam ( ) const

◆ hasDrift()

bool Model::hasDrift ( ) const

◆ hasNugget()

bool Model::hasNugget ( ) const

◆ isAllActiveCovList()

bool Model::isAllActiveCovList ( ) const

◆ isChangeSupportDefined()

bool Model::isChangeSupportDefined ( ) const

◆ isFlagGradient()

bool Model::isFlagGradient ( ) const

◆ isFlagGradientFunctional()

bool Model::isFlagGradientFunctional ( ) const

◆ isFlagGradientNumerical()

bool Model::isFlagGradientNumerical ( ) const

◆ isFlagLinked()

bool Model::isFlagLinked ( ) const

◆ normalize()

void Model::normalize ( double sill )

◆ operator=()

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

◆ resetFromDb()

int Model::resetFromDb ( const Db * db )

◆ setAnam()

int Model::setAnam	(	const AAnam *	anam,
		const VectorInt &	strcnt = `VectorInt()`
	)

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

Parameters

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

Returns

◆ setCovList()

void Model::setCovList ( const ACovAnisoList * covalist )

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

Parameters

covalist List of Covariances to be added

◆ setDriftIRF()

void Model::setDriftIRF	(	int	order = `0`,
		int	nfex = `0`
	)

Define the list of drift functions for:

a given degree of the IRF
a given number of external drifts
Parameters

order Order of the IRF

nfex Number of External Drifts

Remarks
This method deletes any pre-existing drift functions and replaces them by the new definition

This replacement is performed accounting for information stored in 'model', such as:
the space dimension
the number of variables

◆ setDriftList()

void Model::setDriftList ( const DriftList * driftlist )

Add a list of Drifts. This operation cleans any previously stored drift function

Parameters

driftlist List of Drifts to be added

Remarks: This method deletes any pre-existing drift functions

◆ setDrifts()

void Model::setDrifts ( const VectorString & driftSymbols )

◆ setFlagLinked()

void Model::setFlagLinked ( bool flagLinked )

◆ setTapeRange()

void Model::setTapeRange ( double range )

◆ switchToGradient()

void Model::switchToGradient ( )

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

◆ toString()

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

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from AStringable.

◆ unsetAnam()

int Model::unsetAnam ( )

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

include/Model/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

◆ addCov()

◆ addCovFromParam()

◆ addDrift()

◆ create()

◆ createFromDb()

◆ createFromEnvironment()

◆ createFromNF()

◆ createFromParam()

◆ createNugget()

◆ delAllCovas()

◆ delAllDrifts()

◆ delCova()

◆ delDrift()

◆ eval()

◆ eval0()

◆ eval0MatInPlace()

◆ eval0Nvar()

◆ evalAverageDbToDb()

◆ evalAverageIncrToIncr()

◆ evalAveragePointToDb()

◆ evalCvv()

◆ evalCvvM()

◆ evalCvvShift()

◆ evalCxv()

◆ evalCxvM()

◆ evalIvarIpas()

◆ evalIvarNpas()

◆ evalMat()

◆ evalMatInPlace()

◆ evalNvarIpas()

◆ evalNvarIpasIncr()

◆ evalPointToDb()

◆ evalPointToDbAsSP()

◆ extractCova()

◆ getActiveCovList()

◆ getAllActiveCovList()

◆ getAnam()

◆ getAnamHermite()

◆ getBallRadius()

◆ getCova() [1/2]

◆ getCova() [2/2]

◆ getCovaMinIRFOrder()

◆ getCovAnisoList()

◆ getCovAnisoListModify()

◆ getCovaNumber()

◆ getCovaType()

◆ getCovName()

◆ getGradParamNumber()

◆ getMaximumDistance()

◆ getParam()

◆ getRange()

◆ getRanges()

◆ getRankNugget()

◆ getSill()

◆ getSillValues()

◆ getTotalSill()

◆ getTotalSills()

◆ hasAnam()

◆ hasDrift()

◆ hasNugget()

◆ isAllActiveCovList()

◆ isChangeSupportDefined()

◆ isFlagGradient()

◆ isFlagGradientFunctional()

◆ isFlagGradientNumerical()

◆ isFlagLinked()

◆ normalize()

◆ operator=()

◆ resetFromDb()

◆ setAnam()

◆ setCovList()