Loading [MathJax]/extensions/tex2jax.js
1.6.0
Geostatistics & Machine Learning toolbox | https://gstlearn.org
 
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ModelGeneric Class Reference

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

#include <ModelGeneric.hpp>

Inheritance diagram for ModelGeneric:
ICloneable 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

 ModelGeneric (const CovContext &ctxt=CovContext())
 
 ModelGeneric (const ModelGeneric &m)=delete
 
ModelGenericoperator= (const ModelGeneric &m)=delete
 
virtual ~ModelGeneric ()
 
MatrixRectangular evalDriftMatrix (const Db *db, int ivar0=-1, const VectorInt &nbgh=VectorInt(), const ECalcMember &member=ECalcMember::fromKey("LHS")) const
 
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 (const Db *db1, int ivar0=-1, const VectorInt &nbgh1=VectorInt(), const CovCalcMode *mode=nullptr)
 
MatrixRectangular evalCovMatrixOptim (Db *db1, Db *db2=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr)
 
MatrixSquareGeneral eval0Mat (const CovCalcMode *mode=nullptr) const
 
MatrixSquareSymmetric evalCovMatrixSymmetricOptim (const Db *db1, int ivar0=-1, const VectorInt &nbgh1=VectorInt(), const CovCalcMode *mode=nullptr)
 
MatrixSparseevalCovMatrixSparse (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)
 
- Public Member Functions inherited from ICloneable
 ICloneable ()
 
virtual ~ICloneable ()
 
virtual ICloneableclone () const =0
 

Constructor & Destructor Documentation

◆ ModelGeneric() [1/2]

ModelGeneric::ModelGeneric ( const CovContext ctxt = CovContext())

◆ ModelGeneric() [2/2]

ModelGeneric::ModelGeneric ( const ModelGeneric m)
delete

◆ ~ModelGeneric()

ModelGeneric::~ModelGeneric ( )
virtual

Member Function Documentation

◆ eval0Mat()

MatrixSquareGeneral ModelGeneric::eval0Mat ( const CovCalcMode mode = nullptr) const

◆ evalCovMatrix()

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

◆ evalCovMatrixOptim()

MatrixRectangular ModelGeneric::evalCovMatrixOptim ( Db db1,
Db db2 = nullptr,
int  ivar0 = -1,
int  jvar0 = -1,
const VectorInt nbgh1 = VectorInt(),
const VectorInt nbgh2 = VectorInt(),
const CovCalcMode mode = nullptr 
)

◆ evalCovMatrixSparse()

MatrixSparse * ModelGeneric::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 
)

◆ evalCovMatrixSymmetric()

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

◆ evalCovMatrixSymmetricOptim()

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

◆ evalDriftMatrix()

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

◆ operator=()

ModelGeneric & ModelGeneric::operator= ( const ModelGeneric m)
delete

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