#include <KrigingSystem.hpp>

Public Member Functions
	KrigingSystem (Db dbin, Db dbout, const ModelGeneric model, ANeigh neigh, const KrigOpt &krigopt=KrigOpt())

	KrigingSystem (const KrigingSystem &m)=delete

KrigingSystem &	operator= (const KrigingSystem &m)=delete

virtual	~KrigingSystem ()

Id	resetData ()

Id	setKrigOpt (const KrigOpt &krigopt)

Id	setKrigOptCalcul (const EKrigOpt &calcul, const 1 &ndiscs=1(), bool flag_per_cell=false)

Id	setKrigOptXValid (bool flag_xvalid, bool flag_kfold, bool optionXValidEstim=false, bool optionXValidStdev=false, bool optionXValidVarZ=false)

Id	setKrigOptBayes (bool flag_bayes, const 1 &prior_mean, const MatrixSymmetric &prior_cov)

Id	setKrigOptDataWeights (Id iptrWeights, bool flagSet=true)

Id	setKrigOptFlagSimu (bool flagSimu, Id nbsimu=0, Id rankPGS=-1)

Id	setKrigOptFlagGlobal (bool flag_global)

Id	setKrigOptFlagLTerm (bool flag_lterm)

Id	setKrigOptAnamophosis (AAnam *anam)

Id	setKrigOptFactorKriging (bool flag_factor_kriging)

Id	updKrigOptEstim (Id iptrEst, Id iptrStd, Id iptrVarZ, bool forceNoDual=false)

Id	updKrigOptIclass (Id index_class, Id nclasses)

Id	updKrigOptNeighOnly (Id iptrNeigh)

bool	isReady ()

Id	estimate (Id iech_out)

void	conclusion ()

Id	getNDim () const

Id	getNVar () const

Id	getNech () const

Id	getCovSize () const

Id	getDriftSize () const

Id	getNrhs () const

	getSampleNbgh () const

	getSampleCoordinates () const

	getSampleData () const

MatrixSymmetric	getLHS () const

MatrixDense	getLHSF () const

MatrixDense	getRHS () const

MatrixDense	getRHSF () const

MatrixSquare	getVariance () const

MatrixDense	getWeights () const

MatrixDense	getMu () const

double	getLTerm () const

Constructor & Destructor Documentation

◆ KrigingSystem() [1/2]

gstlrn::KrigingSystem::KrigingSystem	(	Db *	dbin,
		Db *	dbout,
		const ModelGeneric *	model,
		ANeigh *	neigh,
		const KrigOpt &	krigopt = `KrigOpt()`
	)

◆ KrigingSystem() [2/2]

gstlrn::KrigingSystem::KrigingSystem ( const KrigingSystem & m )

delete

◆ ~KrigingSystem()

gstlrn::KrigingSystem::~KrigingSystem ( )

virtual

Member Function Documentation

◆ conclusion()

void gstlrn::KrigingSystem::conclusion ( )

This method closes the use of a KrigingSystem sequence

◆ estimate()

Id gstlrn::KrigingSystem::estimate ( Id iech_out )

Perform the Kriging of target

Parameters

iech_out Rank of the target

Returns

◆ getCovSize()

Id gstlrn::KrigingSystem::getCovSize ( ) const

inline

◆ getDriftSize()

Id gstlrn::KrigingSystem::getDriftSize ( ) const

inline

◆ getLHS()

MatrixSymmetric gstlrn::KrigingSystem::getLHS ( ) const

inline

◆ getLHSF()

MatrixDense gstlrn::KrigingSystem::getLHSF ( ) const

inline

◆ getLTerm()

double gstlrn::KrigingSystem::getLTerm ( ) const

inline

◆ getMu()

MatrixDense gstlrn::KrigingSystem::getMu ( ) const

◆ getNDim()

Id gstlrn::KrigingSystem::getNDim ( ) const

inline

◆ getNech()

Id gstlrn::KrigingSystem::getNech ( ) const

inline

◆ getNrhs()

Id gstlrn::KrigingSystem::getNrhs ( ) const

inline

◆ getNVar()

Id gstlrn::KrigingSystem::getNVar ( ) const

inline

◆ getRHS()

MatrixDense gstlrn::KrigingSystem::getRHS ( ) const

inline

◆ getRHSF()

MatrixDense gstlrn::KrigingSystem::getRHSF ( ) const

inline

◆ getSampleCoordinates()

gstlrn::KrigingSystem::getSampleCoordinates ( ) const

Returns the coordinates of the neighboring samples

Returns: Array organized by Coordinate (minor) then by Sample (major)

◆ getSampleData()

gstlrn::KrigingSystem::getSampleData ( ) const

inline

◆ getSampleNbgh()

gstlrn::KrigingSystem::getSampleNbgh ( ) const

inline

◆ getVariance()

MatrixSquare gstlrn::KrigingSystem::getVariance ( ) const

inline

◆ getWeights()

MatrixDense gstlrn::KrigingSystem::getWeights ( ) const

◆ isReady()

bool gstlrn::KrigingSystem::isReady ( )

Performs the last operations before launching the loop on Estimations

Returns

◆ operator=()

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

delete

◆ resetData()

Id gstlrn::KrigingSystem::resetData ( )

◆ setKrigOpt()

Id gstlrn::KrigingSystem::setKrigOpt ( const KrigOpt & krigopt )

◆ setKrigOptAnamophosis()

Id gstlrn::KrigingSystem::setKrigOptAnamophosis ( AAnam * anam )

Perform Gaussian Anamoprhosis kriging

Parameters

anam	Pointer to the AAnam structure

Returns

◆ setKrigOptBayes()

Id gstlrn::KrigingSystem::setKrigOptBayes	(	bool	flag_bayes,
		const 1 &	prior_mean,
		const MatrixSymmetric &	prior_cov
	)

◆ setKrigOptCalcul()

Id gstlrn::KrigingSystem::setKrigOptCalcul	(	const EKrigOpt &	calcul,
		const 1 &	ndiscs = `1()`,
		bool	flag_per_cell = `false`
	)

◆ setKrigOptDataWeights()

Id gstlrn::KrigingSystem::setKrigOptDataWeights	(	Id	iptrWeights,
		bool	flagSet = `true`
	)

◆ setKrigOptFactorKriging()

Id gstlrn::KrigingSystem::setKrigOptFactorKriging ( bool flag_factor_kriging )

◆ setKrigOptFlagGlobal()

Id gstlrn::KrigingSystem::setKrigOptFlagGlobal ( bool flag_global )

◆ setKrigOptFlagLTerm()

Id gstlrn::KrigingSystem::setKrigOptFlagLTerm ( bool flag_lterm )

Ask for the specific calculation of Z * A-1 * Z

Parameters

flag_lterm Flag for asking this specific calculation

Returns

Remarks: The calculated value can be retrieved using _getLTerm() method

◆ setKrigOptFlagSimu()

Id gstlrn::KrigingSystem::setKrigOptFlagSimu	(	bool	flagSimu,
		Id	nbsimu = `0`,
		Id	rankPGS = `-1`
	)

◆ setKrigOptXValid()

Id gstlrn::KrigingSystem::setKrigOptXValid	(	bool	flag_xvalid,
		bool	flag_kfold,
		bool	optionXValidEstim = `false`,
		bool	optionXValidStdev = `false`,
		bool	optionXValidVarZ = `false`
	)

Set the flag for performing Cross-Validation

Parameters

flag_xvalid	True if the Cross-Validation option is switched ON
flag_kfold	True if the KFold option is switch ON
optionXValidEstim	True for Z-Z; False for Z
optionXValidStdev	True for (Z*-Z)/S; False for S
optionXValidVarZ	True for Var(Z*)

Returns

Remarks: The KFold option requires a Code to be assigned to each Datum; In the Neighborhood search for a Target sample, some other data points; are discarded:; - either the Target sample itself (Leave-One-Point-Out) if KFold is False; - all samples with same code as Target if KFold is True

◆ updKrigOptEstim()

Id gstlrn::KrigingSystem::updKrigOptEstim	(	Id	iptrEst,
		Id	iptrStd,
		Id	iptrVarZ,
		bool	forceNoDual = `false`
	)

Set the calculation options

Parameters

iptrEst	UID for storing the estimation(s)
iptrStd	UID for storing the Standard deviations(s)
iptrVarZ	UID for storing the Variance(s) of estimator
forceNoDual	Force that the algebra is not using the Dual option

Returns: Error returned code

Remarks: If a term must not be calculated, its UID must be negative

◆ updKrigOptIclass()

Id gstlrn::KrigingSystem::updKrigOptIclass	(	Id	index_class,
		Id	nclasses
	)

◆ updKrigOptNeighOnly()

Id gstlrn::KrigingSystem::updKrigOptNeighOnly ( Id iptrNeigh )

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

include/Estimation/KrigingSystem.hpp
src/Estimation/KrigingSystem.cpp

Public Member Functions

Constructor & Destructor Documentation

◆ KrigingSystem() [1/2]

◆ KrigingSystem() [2/2]

◆ ~KrigingSystem()

Member Function Documentation

◆ conclusion()

◆ estimate()

◆ getCovSize()

◆ getDriftSize()

◆ getLHS()

◆ getLHSF()

◆ getLTerm()

◆ getMu()

◆ getNDim()

◆ getNech()

◆ getNrhs()

◆ getNVar()

◆ getRHS()

◆ getRHSF()

◆ getSampleCoordinates()

◆ getSampleData()

◆ getSampleNbgh()

◆ getVariance()

◆ getWeights()

◆ isReady()

◆ operator=()

◆ resetData()

◆ setKrigOpt()

◆ setKrigOptAnamophosis()

◆ setKrigOptBayes()

◆ setKrigOptCalcul()

◆ setKrigOptDataWeights()

◆ setKrigOptFactorKriging()

◆ setKrigOptFlagGlobal()

◆ setKrigOptFlagLTerm()

◆ setKrigOptFlagSimu()

◆ setKrigOptXValid()

◆ updKrigOptEstim()

◆ updKrigOptIclass()

◆ updKrigOptNeighOnly()