1.2.0
CCC
 
KrigingSystem Class Reference

#include <KrigingSystem.hpp>

Public Member Functions

 KrigingSystem (Db *dbin, Db *dbout, const Model *model, ANeigh *neigh)
 
 KrigingSystem (const KrigingSystem &m)=delete
 
KrigingSystemoperator= (const KrigingSystem &m)=delete
 
virtual ~KrigingSystem ()
 
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 setKrigOptColCok (const VectorInt &rank_colcok)
 
int setKrigOptBayes (bool flag_bayes, const VectorDouble &prior_mean, const MatrixSquareSymmetric &prior_cov, int seed=414371)
 
int setKrigOptImage (int seed=133271)
 
int setKrigOptDataWeights (int iptrWeights, bool flagSet=true)
 
int setKrigOptMatLC (const MatrixRectangular *matLC)
 
int setKrigoptCode (bool flag_code)
 
int setKrigOptFlagSimu (bool flagSimu, int nbsimu=0, int rankPGS=-1)
 
int setKrigOptSaveWeights (bool flag_save)
 
int setKrigOptDGM (bool flag_dgm, double eps=EPSILON6)
 
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)
 
int updKrigOptIclass (int index_class, int nclasses)
 
int updKrigOptNeighOnly (int iptrNeigh)
 
bool isReady ()
 
int estimate (int iech_out)
 
void conclusion ()
 
int getNDim () const
 
int getNech () const
 
int getNeq () const
 
int getNRed () const
 
VectorInt getSampleIndices () const
 
VectorVectorDouble getSampleCoordinates () const
 
VectorDouble getSampleData () const
 
MatrixRectangular getZam () const
 
MatrixSquareSymmetric getLHSC () const
 
MatrixRectangular getRHSC () const
 
MatrixRectangular getWeights () const
 
MatrixSquareGeneral getVariance () const
 
double getLTerm () const
 
VectorDouble getRHSC (int ivar) const
 
VectorDouble getZamC () const
 
VectorDouble getLHSInvC () const
 

Constructor & Destructor Documentation

KrigingSystem::KrigingSystem ( Db dbin,
Db dbout,
const Model model,
ANeigh neigh 
)
KrigingSystem::KrigingSystem ( const KrigingSystem m)
delete
KrigingSystem::~KrigingSystem ( )
virtual

Member Function Documentation

void KrigingSystem::conclusion ( )

This method closes the use of a KrigingSystem sequence

int KrigingSystem::estimate ( int  iech_out)

Perform the Kriging of target

Parameters
iech_outRank of the target
Returns
MatrixSquareSymmetric KrigingSystem::getLHSC ( ) const
inline
VectorDouble KrigingSystem::getLHSInvC ( ) const
inline
double KrigingSystem::getLTerm ( ) const
inline
int KrigingSystem::getNDim ( ) const
int KrigingSystem::getNech ( ) const

Returns the number of samples in the neighborhood

Returns
Number of samples
Remarks
If collocated option is switch ON, samples are alreadycount (rank < 0)
int KrigingSystem::getNeq ( ) const
int KrigingSystem::getNRed ( ) const
inline
MatrixRectangular KrigingSystem::getRHSC ( ) const
inline
VectorDouble KrigingSystem::getRHSC ( int  ivar) const
VectorVectorDouble KrigingSystem::getSampleCoordinates ( ) const

Returns the coordinates of the neighboring samples

Returns
Array organized by Coordinate (minor) then by Sample (major)
VectorDouble KrigingSystem::getSampleData ( ) const
VectorInt KrigingSystem::getSampleIndices ( ) const
inline
MatrixSquareGeneral KrigingSystem::getVariance ( ) const
inline
MatrixRectangular KrigingSystem::getWeights ( ) const
inline
MatrixRectangular KrigingSystem::getZam ( ) const
inline
VectorDouble KrigingSystem::getZamC ( ) const
bool KrigingSystem::isReady ( )

Performs the last operations before launching the loop on Estimations

Returns
KrigingSystem& KrigingSystem::operator= ( const KrigingSystem m)
delete
int KrigingSystem::setKrigOptAnamophosis ( AAnam anam)

Perform Gaussian Anamoprhosis kriging

Parameters
anamPointer to the AAnam structure
Returns
int KrigingSystem::setKrigOptBayes ( bool  flag_bayes,
const VectorDouble prior_mean,
const MatrixSquareSymmetric prior_cov,
int  seed = 414371 
)
int KrigingSystem::setKrigOptCalcul ( const EKrigOpt &  calcul,
const VectorInt ndiscs = VectorInt(),
bool  flag_per_cell = false 
)
int KrigingSystem::setKrigoptCode ( bool  flag_code)

Define the option for Kriging By Profile

Parameters
flag_codeTrue if the option is switched ON
Returns
Remarks
When the Option for Kriging By Profile is ON, the covariance term in LHS
is incremented by V(iech) when both samples 'iech' and 'jech' have
the same Code.
int KrigingSystem::setKrigOptColCok ( const VectorInt rank_colcok)

Check the consistency of the Colocation specification

Returns
Error return code
Parameters
[in]rank_colcokArray of ranks of colocated variables
Remarks
The array 'rank_colcok' (if present) must be dimensioned
to the number of variables in Dbin.
Each element gives the rank of the colocated variable within Dbout
or -1 if not colocated
If the array 'rank_colcok' is absent, colocation option is OFF.
In input, the numbering in ; rank_colcok' starts from 1
In output, the numbering starts from 0
int KrigingSystem::setKrigOptDataWeights ( int  iptrWeights,
bool  flagSet = true 
)
int KrigingSystem::setKrigOptDGM ( bool  flag_dgm,
double  eps = EPSILON6 
)
int KrigingSystem::setKrigOptFactorKriging ( bool  flag_factor_kriging)
int KrigingSystem::setKrigOptFlagGlobal ( bool  flag_global)
int KrigingSystem::setKrigOptFlagLTerm ( bool  flag_lterm)

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

Parameters
flag_ltermFlag for asking this specific calculation
Returns
Remarks
The calculated value can be retrieved using _getLTerm() method
int KrigingSystem::setKrigOptFlagSimu ( bool  flagSimu,
int  nbsimu = 0,
int  rankPGS = -1 
)
int KrigingSystem::setKrigOptImage ( int  seed = 133271)
int KrigingSystem::setKrigOptMatLC ( const MatrixRectangular matLC)

Define the output as Linear Combinations of the Input Variables

Parameters
matLCVector of Vectors of weights (see remarks)
Returns
Remarks
The first dimension of 'matLC' is the number of Output variables
The second dimension is the number of input Variables.
int KrigingSystem::setKrigOptSaveWeights ( bool  flag_save)

Switch the option for saving the Kriging Weights using Keypair mechanism

Parameters
flag_saveValue of the switch
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_xvalidTrue if the Cross-Validation option is switched ON
flag_kfoldTrue if the KFold option is switch ON
optionXValidEstimTrue for Z*-Z; False for Z*
optionXValidStdevTrue for (Z*-Z)/S; False for S
optionXValidVarZTrue 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
int KrigingSystem::updKrigOptEstim ( int  iptrEst,
int  iptrStd,
int  iptrVarZ 
)

Set the calculation options

Parameters
iptrEstUID for storing the estimation(s)
iptrStdUID for storing the Standard deviations(s)
iptrVarZUID for storing the Variance(s) of estimator
Returns
Remarks
If a term must not be calculated, its UID must be negative
int KrigingSystem::updKrigOptIclass ( int  index_class,
int  nclasses 
)
int KrigingSystem::updKrigOptNeighOnly ( int  iptrNeigh)

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