1.5.0
CCC
  
Public Member Functions | List of all members
ACovFunc Class Referenceabstract

#include <ACovFunc.hpp>

Inheritance diagram for ACovFunc:
AStringable CovBesselJ CovCauchy CovCosExp CovCosinus CovCubic CovExponential CovGC1 CovGC3 CovGC5 CovGCspline CovGCspline2 CovGamma CovGaussian CovGeometric CovLinear CovLinearSph CovMarkov CovMatern CovNugget CovPenta CovPoisson CovPower CovReg1D CovSincard CovSpherical CovStable CovStorkey CovTriangle CovWendland0 CovWendland1 CovWendland2

Public Member Functions

 ACovFunc (const ECov &type, const CovContext &ctxt)
 
 ACovFunc (const ACovFunc &r)
 
ACovFunc & operator= (const ACovFunc &r)
 
virtual ~ACovFunc ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 AStringable Interface. More...
 
virtual String getFormula () const
 ACovFunc Interface. More...
 
virtual double getScadef () const
 
virtual double getParMax () const
 
virtual bool hasInt1D () const
 
virtual bool hasInt2D () const
 
virtual int hasRange () const
 
virtual bool hasParam () const
 
virtual String getCovName () const =0
 
virtual bool hasCovDerivative () const
 
virtual bool hasCovOnRn () const
 
virtual bool hasCovOnSphere () const
 
virtual bool hasSpectrumOnSphere () const
 
virtual bool hasSpectrumOnRn () const
 
virtual bool hasMarkovCoeffs () const
 
virtual double normalizeOnSphere (int n=50, double scale=1.) const
 
virtual bool isConsistent () const
 Test consistency with the current context. More...
 
virtual unsigned int getMaxNDim () const
 
virtual int getMinOrder () const
 
virtual bool getCompatibleSpaceR () const
 
virtual bool getCompatibleSpaceS () const
 
virtual bool isValidForTurningBand () const
 
virtual double simulateTurningBand (double t0, TurningBandOperate &operTB) const
 
virtual bool isValidForSpectral () const
 
virtual MatrixRectangular simulateSpectralOmega (int nb) const
 
void setParam (double param)
 
void setField (double field)
 
double evalCov (double h) const
 
double evalCovDerivative (int degree, double h) const
 
double evalCovOnSphere (double alpha, double scale=1., int degree=50) const
 
VectorDouble evalSpectrumOnSphere (int n, double scale=1.) const
 
VectorDouble evalCovVec (const VectorDouble &vech) const
 
VectorDouble evalCovDerivativeVec (int degree, const VectorDouble &vech) const
 
const ECov & getType () const
 
const CovContext & getContext () const
 
double getParam () const
 
void copyCovContext (const CovContext &ctxt)
 
virtual double evaluateSpectrum (double freq) const
 
virtual VectorDouble getMarkovCoeffs () const
 
virtual void setMarkovCoeffs (VectorDouble coeffs)
 
virtual double getCorrec () const
 
virtual void setCorrec (double val)
 
virtual void computeCorrec (int ndim)
 
virtual void computeMarkovCoeffs (int dim)
 
- Public Member Functions inherited from AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringable & operator= (const AStringable &r)
 
virtual ~AStringable ()
 
virtual void display (const AStringFormat *strfmt=nullptr) const final
 
virtual void display (int level) const final
 

Constructor & Destructor Documentation

◆ ACovFunc() [1/2]

ACovFunc::ACovFunc ( const ECov &  type,
const CovContext &  ctxt 
)

◆ ACovFunc() [2/2]

ACovFunc::ACovFunc ( const ACovFunc &  r)

◆ ~ACovFunc()

ACovFunc::~ACovFunc ( )
virtual

Member Function Documentation

◆ computeCorrec()

void ACovFunc::computeCorrec ( int  ndim)
virtual

Reimplemented in CovMatern.

◆ computeMarkovCoeffs()

virtual void ACovFunc::computeMarkovCoeffs ( int  dim)
inlinevirtual

Reimplemented in CovMatern.

◆ copyCovContext()

void ACovFunc::copyCovContext ( const CovContext &  ctxt)
inline

◆ evalCov()

double ACovFunc::evalCov ( double  h) const

◆ evalCovDerivative()

double ACovFunc::evalCovDerivative ( int  degree,
double  h 
) const

◆ evalCovDerivativeVec()

VectorDouble ACovFunc::evalCovDerivativeVec ( int  degree,
const VectorDouble &  vech 
) const

◆ evalCovOnSphere()

double ACovFunc::evalCovOnSphere ( double  alpha,
double  scale = 1.,
int  degree = 50 
) const

◆ evalCovVec()

VectorDouble ACovFunc::evalCovVec ( const VectorDouble &  vech) const

◆ evalSpectrumOnSphere()

VectorDouble ACovFunc::evalSpectrumOnSphere ( int  n,
double  scale = 1. 
) const

◆ evaluateSpectrum()

double ACovFunc::evaluateSpectrum ( double  freq) const
virtual

Reimplemented in CovMatern, and CovMarkov.

◆ getCompatibleSpaceR()

virtual bool ACovFunc::getCompatibleSpaceR ( ) const
inlinevirtual

Reimplemented in CovWendland2, CovWendland1, CovWendland0, CovTriangle, CovStorkey, CovStable, CovSpherical, CovSincard, CovReg1D, CovPower, CovPenta, CovNugget, CovMatern, CovLinear, CovGCspline2, CovGCspline, CovGC5, CovGC3, CovGC1, CovGaussian, CovGamma, CovExponential, CovCubic, CovCosinus, CovCosExp, CovCauchy, and CovBesselJ.

◆ getCompatibleSpaceS()

virtual bool ACovFunc::getCompatibleSpaceS ( ) const
inlinevirtual

Reimplemented in CovPoisson, CovMatern, CovLinearSph, CovGeometric, and CovExponential.

◆ getContext()

const CovContext& ACovFunc::getContext ( ) const
inline

◆ getCorrec()

virtual double ACovFunc::getCorrec ( ) const
inlinevirtual

Reimplemented in CovMatern, and CovMarkov.

◆ getCovName()

virtual String ACovFunc::getCovName ( ) const
pure virtual

Implemented in CovWendland2, CovWendland1, CovWendland0, CovTriangle, CovStorkey, CovStable, CovSpherical, CovSincard, CovReg1D, CovPower, CovPoisson, CovPenta, CovNugget, CovMatern, CovMarkov, CovLinearSph, CovLinear, CovGeometric, CovGCspline2, CovGCspline, CovGC5, CovGC3, CovGC1, CovGaussian, CovGamma, CovExponential, CovCubic, CovCosinus, CovCosExp, CovCauchy, and CovBesselJ.

◆ getFormula()

virtual String ACovFunc::getFormula ( ) const
inlinevirtual

ACovFunc Interface.

Reimplemented in CovSpherical, CovSincard, CovNugget, CovMatern, CovMarkov, CovGaussian, CovGamma, CovExponential, CovCubic, CovCauchy, and CovBesselJ.

◆ getMarkovCoeffs()

VectorDouble ACovFunc::getMarkovCoeffs ( ) const
virtual

Reimplemented in CovMatern, and CovMarkov.

◆ getMaxNDim()

virtual unsigned int ACovFunc::getMaxNDim ( ) const
inlinevirtual

Reimplemented in CovWendland2, CovWendland1, CovWendland0, CovTriangle, CovStorkey, CovSpherical, CovReg1D, CovPenta, CovGCspline2, CovCubic, and CovCosinus.

◆ getMinOrder()

virtual int ACovFunc::getMinOrder ( ) const
inlinevirtual

Reimplemented in CovWendland2, CovWendland1, CovWendland0, CovTriangle, CovStorkey, CovStable, CovSpherical, CovSincard, CovReg1D, CovPower, CovPoisson, CovPenta, CovNugget, CovMatern, CovLinearSph, CovLinear, CovGeometric, CovGCspline2, CovGCspline, CovGC5, CovGC3, CovGC1, CovGaussian, CovGamma, CovExponential, CovCubic, CovCosinus, CovCosExp, CovCauchy, and CovBesselJ.

◆ getParam()

double ACovFunc::getParam ( ) const
inline

◆ getParMax()

virtual double ACovFunc::getParMax ( ) const
inlinevirtual

Reimplemented in CovStable, CovPower, CovPoisson, CovMatern, CovMarkov, CovGamma, CovCosExp, CovCauchy, and CovBesselJ.

◆ getScadef()

virtual double ACovFunc::getScadef ( ) const
inlinevirtual

Reimplemented in CovStable, CovSincard, CovReg1D, CovMatern, CovMarkov, CovGaussian, CovGamma, CovExponential, CovCosExp, and CovCauchy.

◆ getType()

const ECov& ACovFunc::getType ( ) const
inline

◆ hasCovDerivative()

virtual bool ACovFunc::hasCovDerivative ( ) const
inlinevirtual

Reimplemented in CovWendland2, CovGCspline2, CovGaussian, and CovCubic.

◆ hasCovOnRn()

virtual bool ACovFunc::hasCovOnRn ( ) const
inlinevirtual

Reimplemented in CovPoisson, CovMarkov, and CovLinearSph.

◆ hasCovOnSphere()

bool ACovFunc::hasCovOnSphere ( ) const
virtual

Reimplemented in CovPoisson, CovLinearSph, CovGeometric, and CovExponential.

◆ hasInt1D()

bool ACovFunc::hasInt1D ( ) const
virtual

◆ hasInt2D()

bool ACovFunc::hasInt2D ( ) const
virtual

◆ hasMarkovCoeffs()

virtual bool ACovFunc::hasMarkovCoeffs ( ) const
inlinevirtual

Reimplemented in CovMatern, and CovMarkov.

◆ hasParam()

virtual bool ACovFunc::hasParam ( ) const
inlinevirtual

Reimplemented in CovStable, CovPower, CovPoisson, CovMatern, CovMarkov, CovGamma, CovCosExp, CovCauchy, and CovBesselJ.

◆ hasRange()

virtual int ACovFunc::hasRange ( ) const
inlinevirtual

Reimplemented in CovPower, CovNugget, CovLinear, CovGCspline, CovGC5, CovGC3, and CovGC1.

◆ hasSpectrumOnRn()

virtual bool ACovFunc::hasSpectrumOnRn ( ) const
inlinevirtual

Reimplemented in CovMatern, and CovMarkov.

◆ hasSpectrumOnSphere()

virtual bool ACovFunc::hasSpectrumOnSphere ( ) const
inlinevirtual

Reimplemented in CovPoisson, CovMatern, CovMarkov, CovLinearSph, CovGeometric, and CovExponential.

◆ isConsistent()

bool ACovFunc::isConsistent ( ) const
virtual

Test consistency with the current context.

TODO : Test irfDegree vs getMinOrder in CovElem because zonal anisotropies

◆ isValidForSpectral()

virtual bool ACovFunc::isValidForSpectral ( ) const
inlinevirtual

Reimplemented in CovPoisson, CovMatern, CovLinearSph, CovGaussian, and CovExponential.

◆ isValidForTurningBand()

virtual bool ACovFunc::isValidForTurningBand ( ) const
inlinevirtual

Reimplemented in CovStable, CovSpherical, CovSincard, CovPower, CovNugget, CovMatern, CovLinear, CovGCspline, CovGC5, CovGC3, CovGC1, CovGaussian, CovExponential, CovCubic, and CovBesselJ.

◆ normalizeOnSphere()

virtual double ACovFunc::normalizeOnSphere ( int  n = 50,
double  scale = 1. 
) const
inlinevirtual

Reimplemented in CovMarkov.

◆ operator=()

ACovFunc & ACovFunc::operator= ( const ACovFunc &  r)

◆ setCorrec()

virtual void ACovFunc::setCorrec ( double  val)
inlinevirtual

Reimplemented in CovMatern, and CovMarkov.

◆ setField()

void ACovFunc::setField ( double  field)

◆ setMarkovCoeffs()

void ACovFunc::setMarkovCoeffs ( VectorDouble  coeffs)
virtual

Reimplemented in CovMatern, and CovMarkov.

◆ setParam()

void ACovFunc::setParam ( double  param)

TODO : Do not throw in setter. Check range and build the error message here.

◆ simulateSpectralOmega()

virtual MatrixRectangular ACovFunc::simulateSpectralOmega ( int  nb) const
inlinevirtual

Reimplemented in CovMatern, CovGaussian, and CovExponential.

◆ simulateTurningBand()

virtual double ACovFunc::simulateTurningBand ( double  t0,
TurningBandOperate &  operTB 
) const
inlinevirtual

Reimplemented in CovStable, CovSpherical, CovSincard, CovPower, CovMatern, CovLinear, CovGCspline, CovGC5, CovGC3, CovGC1, CovGaussian, CovExponential, CovCubic, and CovBesselJ.

◆ toString()

String ACovFunc::toString ( const AStringFormat *  strfmt = nullptr) const
overridevirtual

AStringable Interface.

Reimplemented from AStringable.

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