KrigingSystem Class Reference

#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 ()
int	resetData ()
int	setKrigOpt (const KrigOpt &krigopt)
int	setKrigOptCalcul (const EKrigOpt &calcul, const VectorInt &ndiscs=VectorInt(), bool flag_per_cell=false)
int	setKrigOptXValid (bool flag_xvalid, bool flag_kfold, bool optionXValidEstim=false, bool optionXValidStdev=false, bool optionXValidVarZ=false)
int	setKrigOptBayes (bool flag_bayes, const VectorDouble &prior_mean, const MatrixSymmetric &prior_cov)
int	setKrigOptDataWeights (int iptrWeights, bool flagSet=true)
int	setKrigOptFlagSimu (bool flagSimu, int nbsimu=0, int rankPGS=-1)
int	setKrigOptFlagGlobal (bool flag_global)
int	setKrigOptFlagLTerm (bool flag_lterm)
int	setKrigOptAnamophosis (AAnam *anam)
int	setKrigOptFactorKriging (bool flag_factor_kriging)
int	updKrigOptEstim (int iptrEst, int iptrStd, int iptrVarZ, bool forceNoDual=false)
int	updKrigOptIclass (int index_class, int nclasses)
int	updKrigOptNeighOnly (int iptrNeigh)
bool	isReady ()
int	estimate (int iech_out)
void	conclusion ()
int	getNDim () const
int	getNVar () const
int	getNech () const
int	getCovSize () const
int	getDriftSize () const
int	getNrhs () const
VectorInt	getSampleNbgh () const
VectorVectorDouble	getSampleCoordinates () const
VectorDouble	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]

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

KrigingSystem() [2/2]

KrigingSystem::KrigingSystem ( const KrigingSystem &  m )

delete

~KrigingSystem()

KrigingSystem::~KrigingSystem ( )

virtual

Member Function Documentation

conclusion()

void KrigingSystem::conclusion

(

)

This method closes the use of a KrigingSystem sequence

estimate()

int KrigingSystem::estimate

(

int

iech_out

)

Perform the Kriging of target

Parameters

iech_out

Rank of the target

Returns

getCovSize()

int KrigingSystem::getCovSize ( ) const

inline

getDriftSize()

int KrigingSystem::getDriftSize ( ) const

inline

getLHS()

MatrixSymmetric KrigingSystem::getLHS ( ) const

inline

getLHSF()

MatrixDense KrigingSystem::getLHSF ( ) const

inline

getLTerm()

double KrigingSystem::getLTerm ( ) const

inline

getMu()

MatrixDense KrigingSystem::getMu

(

)

const

getNDim()

int KrigingSystem::getNDim ( ) const

inline

getNech()

int KrigingSystem::getNech ( ) const

inline

getNrhs()

int KrigingSystem::getNrhs ( ) const

inline

getNVar()

int KrigingSystem::getNVar ( ) const

inline

getRHS()

MatrixDense KrigingSystem::getRHS ( ) const

inline

getRHSF()

MatrixDense KrigingSystem::getRHSF ( ) const

inline

getSampleCoordinates()

VectorVectorDouble KrigingSystem::getSampleCoordinates

(

)

const

Returns the coordinates of the neighboring samples

Returns

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

getSampleData()

VectorDouble KrigingSystem::getSampleData ( ) const

inline

getSampleNbgh()

VectorInt KrigingSystem::getSampleNbgh ( ) const

inline

getVariance()

MatrixSquare KrigingSystem::getVariance ( ) const

inline

getWeights()

MatrixDense KrigingSystem::getWeights

(

)

const

isReady()

bool KrigingSystem::isReady

(

)

Performs the last operations before launching the loop on Estimations

Returns

operator=()

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

delete

resetData()

int KrigingSystem::resetData

(

)

setKrigOpt()

int KrigingSystem::setKrigOpt

(

const KrigOpt &

krigopt

)

setKrigOptAnamophosis()

int KrigingSystem::setKrigOptAnamophosis

(

AAnam *

anam

)

Perform Gaussian Anamoprhosis kriging

Parameters

anam	Pointer to the AAnam structure

Returns

setKrigOptBayes()

int KrigingSystem::setKrigOptBayes	(	bool	flag_bayes,
		const VectorDouble &	prior_mean,
		const MatrixSymmetric &	prior_cov
	)

setKrigOptCalcul()

int KrigingSystem::setKrigOptCalcul	(	const EKrigOpt &	calcul,
		const VectorInt &	ndiscs = VectorInt(),
		bool	flag_per_cell = false
	)

setKrigOptDataWeights()

int KrigingSystem::setKrigOptDataWeights	(	int	iptrWeights,
		bool	flagSet = true
	)

setKrigOptFactorKriging()

int KrigingSystem::setKrigOptFactorKriging

(

bool

flag_factor_kriging

)

setKrigOptFlagGlobal()

int KrigingSystem::setKrigOptFlagGlobal

(

bool

flag_global

)

setKrigOptFlagLTerm()

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

int KrigingSystem::setKrigOptFlagSimu	(	bool	flagSimu,
		int	nbsimu = 0,
		int	rankPGS = -1
	)

setKrigOptXValid()

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

int KrigingSystem::updKrigOptEstim	(	int	iptrEst,
		int	iptrStd,
		int	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()

int KrigingSystem::updKrigOptIclass	(	int	index_class,
		int	nclasses
	)

updKrigOptNeighOnly()

int KrigingSystem::updKrigOptNeighOnly

(

int

iptrNeigh

)

---

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

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