gstlrn::ACovFunc Class Reference

#include <ACovFunc.hpp>

Inheritance diagram for gstlrn::ACovFunc:

Public Member Functions
	ACovFunc (const ECov &type, const CovContext &ctxt)
	ACovFunc (const ACovFunc &r)
ACovFunc &	operator= (const ACovFunc &r)
virtual	~ACovFunc ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
virtual String	getFormula () const
	ACovFunc Interface.
virtual double	getScadef () const
virtual double	getParMax () const
virtual bool	hasInt1D () const
virtual bool	hasInt2D () const
virtual Id	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 (Id n=50, double scale=1.) const
virtual bool	isConsistent () const
	Test consistency with the current context.
virtual size_t	getMaxNDim () const
virtual Id	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 MatrixDense	simulateSpectralOmega (Id nb) const
void	setParam (double param)
void	setField (double field)
void	setContext (const CovContext &ctxt)
double	evalCorFunc (double h) const
double	evalCovDerivative (Id degree, double h) const
double	evalCovOnSphere (double alpha, double scale=1., Id degree=50) const
	evalSpectrumOnSphere (Id n, double scale=1.) const
	evalCovVec (const 1 &vech) const
	evalCovDerivativeVec (Id degree, const 1 &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	getMarkovCoeffs () const
virtual void	setMarkovCoeffs (const 1 &coeffs)
virtual double	getCorrec () const
virtual void	setCorrec (double val)
virtual void	computeCorrec (Id ndim)
virtual void	computeMarkovCoeffs (Id dim)
double	evalDerivative (double h) const
Public Member Functions inherited from gstlrn::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 (Id level) const final

Constructor & Destructor Documentation

ACovFunc() [1/2]

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

ACovFunc() [2/2]

gstlrn::ACovFunc::ACovFunc

(

const ACovFunc &

r

)

~ACovFunc()

gstlrn::ACovFunc::~ACovFunc ( )

virtual

Member Function Documentation

computeCorrec()

void gstlrn::ACovFunc::computeCorrec ( Id  ndim )

virtual

Reimplemented in gstlrn::CovMatern.

computeMarkovCoeffs()

virtual void gstlrn::ACovFunc::computeMarkovCoeffs ( Id  dim )

inlinevirtual

Reimplemented in gstlrn::CovMatern.

copyCovContext()

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

inline

evalCorFunc()

double gstlrn::ACovFunc::evalCorFunc

(

double

h

)

const

evalCovDerivative()

double gstlrn::ACovFunc::evalCovDerivative	(	Id	degree,
		double	h
	)		const

evalCovDerivativeVec()

gstlrn::ACovFunc::evalCovDerivativeVec	(	Id	degree,
		const 1 &	vech
	)		const

evalCovOnSphere()

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

evalCovVec()

gstlrn::ACovFunc::evalCovVec

(

const 1 &

vech

)

const

evalDerivative()

double gstlrn::ACovFunc::evalDerivative ( double  h ) const

inline

evalSpectrumOnSphere()

gstlrn::ACovFunc::evalSpectrumOnSphere	(	Id	n,
		double	scale = 1.
	)		const

evaluateSpectrum()

double gstlrn::ACovFunc::evaluateSpectrum ( double  freq ) const

virtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

getCompatibleSpaceR()

virtual bool gstlrn::ACovFunc::getCompatibleSpaceR ( ) const

inlinevirtual

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

getCompatibleSpaceS()

virtual bool gstlrn::ACovFunc::getCompatibleSpaceS ( ) const

inlinevirtual

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

getContext()

const CovContext & gstlrn::ACovFunc::getContext ( ) const

inline

getCorrec()

virtual double gstlrn::ACovFunc::getCorrec ( ) const

inlinevirtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

getCovName()

virtual String gstlrn::ACovFunc::getCovName ( ) const

pure virtual

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

getFormula()

virtual String gstlrn::ACovFunc::getFormula ( ) const

inlinevirtual

ACovFunc Interface.

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

getMarkovCoeffs()

gstlrn::ACovFunc::getMarkovCoeffs ( ) const

virtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

getMaxNDim()

virtual size_t gstlrn::ACovFunc::getMaxNDim ( ) const

inlinevirtual

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

getMinOrder()

virtual Id gstlrn::ACovFunc::getMinOrder ( ) const

inlinevirtual

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

getParam()

double gstlrn::ACovFunc::getParam ( ) const

inline

getParMax()

virtual double gstlrn::ACovFunc::getParMax ( ) const

inlinevirtual

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

getScadef()

virtual double gstlrn::ACovFunc::getScadef ( ) const

inlinevirtual

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

getType()

const ECov & gstlrn::ACovFunc::getType ( ) const

inline

hasCovDerivative()

virtual bool gstlrn::ACovFunc::hasCovDerivative ( ) const

inlinevirtual

Reimplemented in gstlrn::CovCubic, gstlrn::CovGaussian, gstlrn::CovGCspline2, and gstlrn::CovWendland2.

hasCovOnRn()

virtual bool gstlrn::ACovFunc::hasCovOnRn ( ) const

inlinevirtual

Reimplemented in gstlrn::CovLinearSph, gstlrn::CovMarkov, and gstlrn::CovPoisson.

hasCovOnSphere()

bool gstlrn::ACovFunc::hasCovOnSphere ( ) const

virtual

Reimplemented in gstlrn::CovExponential, gstlrn::CovGeometric, gstlrn::CovLinearSph, and gstlrn::CovPoisson.

hasInt1D()

bool gstlrn::ACovFunc::hasInt1D ( ) const

virtual

hasInt2D()

bool gstlrn::ACovFunc::hasInt2D ( ) const

virtual

hasMarkovCoeffs()

virtual bool gstlrn::ACovFunc::hasMarkovCoeffs ( ) const

inlinevirtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

hasParam()

virtual bool gstlrn::ACovFunc::hasParam ( ) const

inlinevirtual

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

hasRange()

virtual Id gstlrn::ACovFunc::hasRange ( ) const

inlinevirtual

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

hasSpectrumOnRn()

virtual bool gstlrn::ACovFunc::hasSpectrumOnRn ( ) const

inlinevirtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

hasSpectrumOnSphere()

virtual bool gstlrn::ACovFunc::hasSpectrumOnSphere ( ) const

inlinevirtual

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

isConsistent()

bool gstlrn::ACovFunc::isConsistent ( ) const

virtual

Test consistency with the current context.

TODO : Test irfDegree vs getMinOrder in CovElem because zonal anisotropies

isValidForSpectral()

virtual bool gstlrn::ACovFunc::isValidForSpectral ( ) const

inlinevirtual

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

isValidForTurningBand()

virtual bool gstlrn::ACovFunc::isValidForTurningBand ( ) const

inlinevirtual

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

normalizeOnSphere()

virtual double gstlrn::ACovFunc::normalizeOnSphere ( Id  n = 50, double  scale = 1.  ) const

inlinevirtual

Reimplemented in gstlrn::CovMarkov.

operator=()

ACovFunc & gstlrn::ACovFunc::operator=

(

const ACovFunc &

r

)

setContext()

void gstlrn::ACovFunc::setContext ( const CovContext &  ctxt )

inline

setCorrec()

virtual void gstlrn::ACovFunc::setCorrec ( double  val )

inlinevirtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

setField()

void gstlrn::ACovFunc::setField

(

double

field

)

setMarkovCoeffs()

void gstlrn::ACovFunc::setMarkovCoeffs ( const 1 &  coeffs )

virtual

Reimplemented in gstlrn::CovMarkov, and gstlrn::CovMatern.

setParam()

void gstlrn::ACovFunc::setParam

(

double

param

)

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

simulateSpectralOmega()

virtual MatrixDense gstlrn::ACovFunc::simulateSpectralOmega ( Id  nb ) const

inlinevirtual

Reimplemented in gstlrn::CovExponential, gstlrn::CovGaussian, and gstlrn::CovMatern.

simulateTurningBand()

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

inlinevirtual

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

toString()

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

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

---

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

• include/Covariances/ACovFunc.hpp
• src/Covariances/ACovFunc.cpp