1.3.0
CCC
 
CovAniso Class Reference

This class describes an elementary covariance. More...

#include <CovAniso.hpp>

Inheritance diagram for CovAniso:
ACov ICloneable ASpaceObject AStringable ACovGradient CovGradientFunctional CovGradientNumerical

Detailed Description

This class describes an elementary covariance.

This covariance is described through the following list of parameters:

  • the covariance type: the list of these types is provided in ECov.hpp
  • the largest set of parameters for any covariance: range(s), anisotropy angle(s), third parameter. Some of these parameters do not make sense, depending on the covariance type: e.g. the range for nugget effect, the third parameter for a spherical structure, ... All these parameters are processed and stored as a tensor in order to avoid repetitive calculations.
  • the sill. This comes as a square symmetric matrix whose dimension is equal to the number of variables.

Public Member Functions

 CovAniso (const ECov &type, const CovContext &ctxt)
 
 CovAniso (const String &symbol, const CovContext &ctxt)
 
 CovAniso (const ECov &type, double range, double param, double sill, const CovContext &ctxt, bool flagRange=true)
 
 CovAniso (const CovAniso &r)
 
CovAnisooperator= (const CovAniso &r)
 
virtual ~CovAniso ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 ICloneable Interface. More...
 
virtual bool isConsistent (const ASpace *space) const override
 ASpaceObject Interface. More...
 
virtual int getNVariables () const override
 ACov Interface. More...
 
virtual double eval0 (int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override
 ACov Interface. More...
 
virtual double eval (const SpacePoint &p1, const SpacePoint &p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const override
 Calculate the covariance between two variables and two points (general case) More...
 
virtual void eval0MatInPlace (MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
 
virtual void evalMatInPlace (const SpacePoint &p1, const SpacePoint &p2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
 
virtual double evalCovOnSphere (double alpha, int degree=50, bool flagScaleDistance=true, const CovCalcMode *mode=nullptr) const override
 
virtual VectorDouble evalSpectrumOnSphere (int n, bool flagNormDistance=false, bool flagCumul=false) const override
 
virtual double evalSpectrum (const VectorDouble &freq, int ivar=0, int jvar=0) const override
 
virtual double getIntegralRange (int ndisc, double hmax) const
 
virtual String getFormula () const
 
virtual double getBallRadius () const
 
bool isOptimizationInitialized (const Db *db=nullptr) const
 
void optimizationPreProcess (const Db *db) const
 
void optimizationPostProcess () const
 
void optimizationSetTarget (const SpacePoint &pt) const
 
void optimizationSetTarget (int iech) const
 
void evalOptimInPlace (MatrixRectangular &res, const VectorInt &ivars, const VectorVectorInt &index, int ivar2=0, int icol=0, const CovCalcMode *mode=nullptr, bool flagSym=false) const
 
void evalMatOptimInPlace (int icas1, int iech1, int icas2, int iech2, MatrixSquareGeneral &mat, const CovCalcMode *mode=nullptr) const override
 
bool isValidForTurningBand () const
 
double simulateTurningBand (double t0, TurningBandOperate &operTB) const
 
bool isValidForSpectral () const
 
MatrixRectangular simulateSpectralOmega (int nb) const
 
void setContext (const CovContext &ctxt)
 
void setParam (double param)
 
void copyCovContext (const CovContext &ctxt)
 
void setNoStatFactor (double noStatFactor)
 
void setSill (double sill)
 
void setSill (const MatrixSquareSymmetric &sill)
 Only valid when there is only one variable (in the context) More...
 
void setSill (const VectorDouble &sill)
 
void setSill (int ivar, int jvar, double sill)
 
void initSill (double value=0.)
 
void setRangeIsotropic (double range)
 Practical range. More...
 
void setRange (int idim, double range)
 
void setRanges (const VectorDouble &ranges)
 
void setScale (double scale)
 
void setScale (int idim, double scale)
 Make the covariance isotropic. More...
 
void setScales (const VectorDouble &scales)
 
void setAnisoRotation (const Rotation &rot)
 
void setAnisoRotation (const VectorDouble &rot)
 
void setAnisoAngles (const VectorDouble &angles)
 
void setAnisoAngle (int idim, double angle)
 
void setRotationAnglesAndRadius (const VectorDouble &angles=VectorDouble(), const VectorDouble &ranges=VectorDouble(), const VectorDouble &scales=VectorDouble())
 
const MatrixSquareSymmetricgetSill () const
 
double getSill (int ivar, int jvar) const
 
double getSlope (int ivar, int jvar) const
 
VectorDouble getRanges () const
 
const RotationgetAnisoRotation () const
 
const VectorDoublegetScales () const
 
void setType (const ECov &type)
 
double getRange () const
 
double getScale () const
 
bool getFlagAniso () const
 
bool getFlagRotation () const
 
double getRange (int idim) const
 
double getScale (int idim) const
 
const VectorDouble getAnisoAngles () const
 
const MatrixSquareGeneralgetAnisoRotMat () const
 
const MatrixSquareGeneralgetAnisoInvMat () const
 
const VectorDouble getAnisoCoeffs () const
 
double getAnisoAngles (int idim) const
 
double getAnisoRotMat (int idim, int jdim) const
 
double getAnisoCoeffs (int idim) const
 
const CovContextgetContext () const
 
const ECov & getType () const
 
double getParam () const
 
double getScadef () const
 
double getParMax () const
 
int getMaxNDim () const
 
int getMinOrder () const
 
bool hasInt1D () const
 
bool hasInt2D () const
 
int hasRange () const
 
int hasParam () const
 
String getCovName () const
 
bool isIsotropic () const
 
bool isAsymptotic () const
 
bool hasRotation () const
 
const TensorgetAniso () const
 
void setAniso (const Tensor &aniso)
 
const ACovFuncgetCova () const
 
int getGradParamNumber () const
 
bool hasCovDerivative () const
 
bool hasCovOnSphere () const
 
bool hasSpectrumOnSphere () const
 
bool hasMarkovCoeffs () const
 
bool hasSpectrumOnRn () const
 
VectorDouble evalCovOnSphereVec (const VectorDouble &alpha, int degree=50, bool flagScaleDistance=false, const CovCalcMode *mode=nullptr) const
 
Array evalCovFFT (const VectorDouble &ext, int N=128, int ivar=0, int jvar=0) const
 
VectorDouble getMarkovCoeffs () const
 
void setMarkovCoeffs (VectorDouble coeffs)
 
void setMarkovCoeffsBySquaredPolynomials (VectorDouble coeffs1, VectorDouble coeffs2, double eps=0)
 
void computeMarkovCoeffs ()
 
double getCorrec () const
 
double getFullCorrec () const
 
int getDimensionNumber () const
 
CovAnisocreateReduce (const VectorInt &validVars) const
 
- Public Member Functions inherited from ACov
 ACov (const ASpace *space=nullptr)
 
 ACov (const ACov &r)
 
ACovoperator= (const ACov &r)
 
virtual ~ACov ()
 
virtual bool isIndexable () const
 
virtual bool isNoStat () const
 
virtual const ANoStatgetNoStat () const
 
virtual ANoStatgetNoStatModify () const
 
virtual bool isOptimEnabled () const
 Tell if the use of Optimization is enabled or not. More...
 
virtual void updateCovByPoints (int icas1, int iech1, int icas2, int iech2)
 
virtual void updateCovByMesh (int imesh)
 
void setOptimEnabled (bool isOptimEnabled)
 
VectorDouble eval (const std::vector< SpacePoint > &vec_p1, const std::vector< SpacePoint > &vec_p2, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const
 
MatrixSquareGeneral eval0Mat (const CovCalcMode *mode=nullptr) const
 
MatrixSquareGeneral evalMat (const SpacePoint &p1, const SpacePoint &p2, 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 evalIvarIpasIncr (const VectorDouble &dincr, int ivar=0, int jvar=0, 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
 
MatrixSquareGeneral evalNvarIpas (double step, const VectorDouble &dir=VectorDouble(), const CovCalcMode *mode=nullptr) const
 
MatrixSquareGeneral evalNvarIpasIncr (const VectorDouble &dincr, const CovCalcMode *mode=nullptr) const
 
double evalIsoIvarIpas (double step, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const
 
VectorDouble evalIsoIvarNpas (const VectorDouble &vec_step, int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const
 
MatrixSquareGeneral evalIsoNvarIpas (double step, 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) const
 
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) const
 
double evalCxv (const Db *db, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), int ivar=0, int jvar=0, const CovCalcMode *mode=nullptr) const
 
MatrixSquareGeneral evalCxvM (const SpacePoint &p1, const VectorDouble &ext, const VectorInt &ndisc, const VectorDouble &angles=VectorDouble(), const VectorDouble &x0=VectorDouble(), const CovCalcMode *mode=nullptr) const
 
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) const
 
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) const
 
MatrixRectangular evalCovMatrix (Db *db1_arg, Db *db2_arg=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, const VectorInt &nbgh1, const CovCalcMode *mode)
 
MatrixSparseevalCovMatrixSparse (Db *db1_arg, Db *db2_arg=nullptr, int ivar0=-1, int jvar0=-1, const VectorInt &nbgh1=VectorInt(), const VectorInt &nbgh2=VectorInt(), const CovCalcMode *mode=nullptr, double eps=EPSILON3)
 
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) const
 
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
 
- Public Member Functions inherited from ASpaceObject
 ASpaceObject (const ASpace *space=nullptr)
 
 ASpaceObject (const ASpace &space)
 
 ASpaceObject (const ASpaceObject &r)
 
ASpaceObjectoperator= (const ASpaceObject &r)
 
virtual ~ASpaceObject ()
 
const ASpacegetSpace () const
 Accessor to the current object space context. More...
 
bool isConsistent () const
 Indicate if I am consistent with my current space context. More...
 
VectorDouble getUnitaryVector () const
 Return unitary vector for the current space context. More...
 
unsigned int getNDim () const
 Shortcuts to ASpace methods. More...
 
const VectorDoublegetOrigin () const
 Return the current space context origin coordinates. More...
 
double getDistance (const SpacePoint &p1, const SpacePoint &p2) const
 Return the distance between two space points for the current space context. More...
 
double getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim) const
 Return the distance along one direction between two space points. More...
 
VectorDouble getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
 Return the increment vector between two space points for the current space context. More...
 
- Public Member Functions inherited from AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringableoperator= (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 ICloneable
 ICloneable ()
 
virtual ~ICloneable ()
 
virtual ICloneableclone () const =0
 

Static Public Member Functions

static CovAnisocreateIsotropic (const CovContext &ctxt, const ECov &type, double range, double sill=1., double param=1., bool flagRange=true)
 
static CovAnisocreateAnisotropic (const CovContext &ctxt, const ECov &type, const VectorDouble &ranges, double sill=1., double param=1., const VectorDouble &angles=VectorDouble(), bool flagRange=true)
 
static CovAnisocreateIsotropicMulti (const CovContext &ctxt, const ECov &type, double range, const MatrixSquareSymmetric &sills, double param=1., bool flagRange=true)
 
static CovAnisocreateAnisotropicMulti (const CovContext &ctxt, const ECov &type, const VectorDouble &ranges, const MatrixSquareSymmetric &sills, double param=1., const VectorDouble &angles=VectorDouble(), bool flagRange=true)
 

Constructor & Destructor Documentation

CovAniso::CovAniso ( const ECov &  type,
const CovContext ctxt 
)
CovAniso::CovAniso ( const String symbol,
const CovContext ctxt 
)
CovAniso::CovAniso ( const ECov &  type,
double  range,
double  param,
double  sill,
const CovContext ctxt,
bool  flagRange = true 
)
CovAniso::CovAniso ( const CovAniso r)
CovAniso::~CovAniso ( )
virtual

Member Function Documentation

void CovAniso::computeMarkovCoeffs ( )
void CovAniso::copyCovContext ( const CovContext ctxt)
CovAniso * CovAniso::createAnisotropic ( const CovContext ctxt,
const ECov &  type,
const VectorDouble ranges,
double  sill = 1.,
double  param = 1.,
const VectorDouble angles = VectorDouble(),
bool  flagRange = true 
)
static
CovAniso * CovAniso::createAnisotropicMulti ( const CovContext ctxt,
const ECov &  type,
const VectorDouble ranges,
const MatrixSquareSymmetric sills,
double  param = 1.,
const VectorDouble angles = VectorDouble(),
bool  flagRange = true 
)
static
CovAniso * CovAniso::createIsotropic ( const CovContext ctxt,
const ECov &  type,
double  range,
double  sill = 1.,
double  param = 1.,
bool  flagRange = true 
)
static
CovAniso * CovAniso::createIsotropicMulti ( const CovContext ctxt,
const ECov &  type,
double  range,
const MatrixSquareSymmetric sills,
double  param = 1.,
bool  flagRange = true 
)
static
CovAniso * CovAniso::createReduce ( const VectorInt validVars) const
double CovAniso::eval ( const SpacePoint p1,
const SpacePoint p2,
int  ivar = 0,
int  jvar = 0,
const CovCalcMode mode = nullptr 
) const
overridevirtual

Calculate the covariance between two variables and two points (general case)

Implements ACov.

Reimplemented in CovGradientNumerical.

double CovAniso::eval0 ( int  ivar = 0,
int  jvar = 0,
const CovCalcMode mode = nullptr 
) const
overridevirtual

ACov Interface.

Implements ACov.

Reimplemented in CovGradientNumerical.

void CovAniso::eval0MatInPlace ( MatrixSquareGeneral mat,
const CovCalcMode mode = nullptr 
) const
overridevirtual

Calculate the Matrix of covariance for zero distance

Parameters
matCovariance matrix (Dimension: nvar * nvar)
modeCalculation Options
Remarks
: Matrix 'mat' should be dimensioned and initialized beforehand

Reimplemented from ACov.

Array CovAniso::evalCovFFT ( const VectorDouble ext,
int  N = 128,
int  ivar = 0,
int  jvar = 0 
) const
double CovAniso::evalCovOnSphere ( double  alpha,
int  degree = 50,
bool  flagScaleDistance = true,
const CovCalcMode mode = nullptr 
) const
overridevirtual

Reimplemented from ACov.

VectorDouble CovAniso::evalCovOnSphereVec ( const VectorDouble alpha,
int  degree = 50,
bool  flagScaleDistance = false,
const CovCalcMode mode = nullptr 
) const
void CovAniso::evalMatInPlace ( const SpacePoint p1,
const SpacePoint p2,
MatrixSquareGeneral mat,
const CovCalcMode mode = nullptr 
) const
overridevirtual

Calculate the Matrix of covariance between two space points

Parameters
p1Reference of the first space point
p2Reference of the second space point
matCovariance matrix (Dimension: nvar * nvar)
modeCalculation Options
Remarks
: Matrix 'mat' should be dimensioned and initialized beforehand

Reimplemented from ACov.

void CovAniso::evalMatOptimInPlace ( int  icas1,
int  iech1,
int  icas2,
int  iech2,
MatrixSquareGeneral mat,
const CovCalcMode mode = nullptr 
) const
overridevirtual

Calculate the Matrix of covariance between two elements of two Dbs (defined beforehand)

Parameters
icas1Origin of the Db containing the first point
iech1Rank of the first point
icas2Origin of the Db containing the second point
iech2Rank of the second point
matCovariance matrix (Dimension: nvar * nvar)
modeCalculation Options
Remarks
: Matrix 'mat' should be dimensioned and initialized beforehand

Implements ACov.

void CovAniso::evalOptimInPlace ( MatrixRectangular res,
const VectorInt ivars,
const VectorVectorInt index1,
int  ivar2 = 0,
int  icol = 0,
const CovCalcMode mode = nullptr,
bool  flagSym = false 
) const

Fill the vector of covariances between each valid SpacePoint (recorded in _p1As) and the target (recorded in _p2A)

Parameters
resVector of covariances
ivarsArrays of ranks for the first point
index1Arrays of sample indices for the first point
ivar2Rank of the variable for the second point
icolRank of the column (variable + sample) for the second point
modeCovCalcMode structure
flagSymTrue if used for a Symmetric matrix (should only fill upper triangle)
Remarks
: The optimized version is not compatible with Franck's non-stationarity. Then no correction must be applied to cov(h)
double CovAniso::evalSpectrum ( const VectorDouble freq,
int  ivar = 0,
int  jvar = 0 
) const
overridevirtual

Reimplemented from ACov.

VectorDouble CovAniso::evalSpectrumOnSphere ( int  n,
bool  flagNormDistance = false,
bool  flagCumul = false 
) const
overridevirtual

Reimplemented from ACov.

const Tensor& CovAniso::getAniso ( ) const
inline
const VectorDouble CovAniso::getAnisoAngles ( ) const
inline
double CovAniso::getAnisoAngles ( int  idim) const
inline
const VectorDouble CovAniso::getAnisoCoeffs ( ) const
double CovAniso::getAnisoCoeffs ( int  idim) const
inline
const MatrixSquareGeneral& CovAniso::getAnisoInvMat ( ) const
inline
const Rotation& CovAniso::getAnisoRotation ( ) const
inline
const MatrixSquareGeneral& CovAniso::getAnisoRotMat ( ) const
inline
double CovAniso::getAnisoRotMat ( int  idim,
int  jdim 
) const
inline
virtual double CovAniso::getBallRadius ( ) const
inlinevirtual

Reimplemented in CovGradientNumerical.

const CovContext& CovAniso::getContext ( ) const
inline
double CovAniso::getCorrec ( ) const
const ACovFunc* CovAniso::getCova ( ) const
inline
String CovAniso::getCovName ( ) const
inline
int CovAniso::getDimensionNumber ( ) const
inline
bool CovAniso::getFlagAniso ( ) const
inline
bool CovAniso::getFlagRotation ( ) const
inline
virtual String CovAniso::getFormula ( ) const
inlinevirtual
double CovAniso::getFullCorrec ( ) const
int CovAniso::getGradParamNumber ( ) const
double CovAniso::getIntegralRange ( int  ndisc,
double  hmax 
) const
virtual

Calculate the Integral Range in various Space Dimension (1, 2 or 3)

Returns
VectorDouble CovAniso::getMarkovCoeffs ( ) const
int CovAniso::getMaxNDim ( ) const
inline
int CovAniso::getMinOrder ( ) const
inline
virtual int CovAniso::getNVariables ( ) const
inlineoverridevirtual

ACov Interface.

Implements ACov.

double CovAniso::getParam ( ) const

For compatibility, this function returns 0 if the Covariance has no Third Parameter

Returns
Third parameter
double CovAniso::getParMax ( ) const
inline
double CovAniso::getRange ( ) const

This function returns the range in the isotropic case In the anisotropic case, it returns the largest range over all directions

Returns
double CovAniso::getRange ( int  idim) const
inline
VectorDouble CovAniso::getRanges ( ) const
double CovAniso::getScadef ( ) const
inline
double CovAniso::getScale ( ) const
double CovAniso::getScale ( int  idim) const
inline
const VectorDouble& CovAniso::getScales ( ) const
inline
const MatrixSquareSymmetric& CovAniso::getSill ( ) const
inline
double CovAniso::getSill ( int  ivar,
int  jvar 
) const
double CovAniso::getSlope ( int  ivar,
int  jvar 
) const

Return the Slope calculated as the sill / range(idim=0)

Parameters
ivarRank of the first variable
jvarRank of the second variable
Returns
const ECov& CovAniso::getType ( ) const
inline
bool CovAniso::hasCovDerivative ( ) const
inline
bool CovAniso::hasCovOnSphere ( ) const
inline
bool CovAniso::hasInt1D ( ) const
inline
bool CovAniso::hasInt2D ( ) const
inline
bool CovAniso::hasMarkovCoeffs ( ) const
inline
int CovAniso::hasParam ( ) const
inline
int CovAniso::hasRange ( ) const
inline
bool CovAniso::hasRotation ( ) const
inline
bool CovAniso::hasSpectrumOnRn ( ) const
inline
bool CovAniso::hasSpectrumOnSphere ( ) const
inline
void CovAniso::initSill ( double  value = 0.)
bool CovAniso::isAsymptotic ( ) const
inline
bool CovAniso::isConsistent ( const ASpace space) const
overridevirtual

ASpaceObject Interface.

Implements ASpaceObject.

bool CovAniso::isIsotropic ( ) const
inline
bool CovAniso::isOptimizationInitialized ( const Db db = nullptr) const

Checks that the Optimization has already been initiated, by:

  • checking that the storage (for Sample Points projected in the Covariance rotation system) is already allocated
  • checking that the dimension of this storage is correct (only if 'db' is provided): in particular, this check is not necessary when freeing this storage.
bool CovAniso::isValidForSpectral ( ) const
bool CovAniso::isValidForTurningBand ( ) const
CovAniso & CovAniso::operator= ( const CovAniso r)
void CovAniso::optimizationPostProcess ( ) const
void CovAniso::optimizationPreProcess ( const Db db) const

Transform a set of Space Points using the anisotropy tensor The set of resulting Space Points are stored as private member of this. Note that ALL samples are processed, independently from the presence of a selection or checking for heterotopy.

Parameters
dbInput Db
void CovAniso::optimizationSetTarget ( const SpacePoint pt) const

Define the second Space Point by transforming the input Space Point 'pt' on the basis of the current covariance

Parameters
ptTarget sample provided as a Space Point
void CovAniso::optimizationSetTarget ( int  iech) const

Define the Second Space Point as coinciding with the Input Space Point 'iech'. Note that, as the Input Space Points are already transformed in the basis of the current structure, it is just an assignment.

Parameters
iechRank of the sample among the recorded Space Points
void CovAniso::setAniso ( const Tensor aniso)
inline
void CovAniso::setAnisoAngle ( int  idim,
double  angle 
)
void CovAniso::setAnisoAngles ( const VectorDouble angles)
void CovAniso::setAnisoRotation ( const Rotation rot)
void CovAniso::setAnisoRotation ( const VectorDouble rot)
void CovAniso::setContext ( const CovContext ctxt)
void CovAniso::setMarkovCoeffs ( VectorDouble  coeffs)
void CovAniso::setMarkovCoeffsBySquaredPolynomials ( VectorDouble  coeffs1,
VectorDouble  coeffs2,
double  eps = 0 
)
void CovAniso::setNoStatFactor ( double  noStatFactor)
inline
void CovAniso::setParam ( double  param)
void CovAniso::setRange ( int  idim,
double  range 
)
void CovAniso::setRangeIsotropic ( double  range)

Practical range.

void CovAniso::setRanges ( const VectorDouble ranges)
void CovAniso::setRotationAnglesAndRadius ( const VectorDouble angles = VectorDouble(),
const VectorDouble ranges = VectorDouble(),
const VectorDouble scales = VectorDouble() 
)
void CovAniso::setScale ( double  scale)
void CovAniso::setScale ( int  idim,
double  scale 
)

Make the covariance isotropic.

void CovAniso::setScales ( const VectorDouble scales)
void CovAniso::setSill ( double  sill)
void CovAniso::setSill ( const MatrixSquareSymmetric sill)

Only valid when there is only one variable (in the context)

void CovAniso::setSill ( const VectorDouble sill)
void CovAniso::setSill ( int  ivar,
int  jvar,
double  sill 
)

TODO : Test if sill matrix is positive definite (if not, generate a warning)

void CovAniso::setType ( const ECov &  type)
MatrixRectangular CovAniso::simulateSpectralOmega ( int  nb) const
double CovAniso::simulateTurningBand ( double  t0,
TurningBandOperate operTB 
) const
String CovAniso::toString ( const AStringFormat strfmt = nullptr) const
overridevirtual

ICloneable Interface.

AStringable Interface

Reimplemented from ASpaceObject.


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