ACovFunc Class Reference

#include <ACovFunc.hpp>

Inheritance diagram for ACovFunc:

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.
virtual String	getFormula () const
	ACovFunc Interface.
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.
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 CovMarkov, and CovMatern.

getCompatibleSpaceR()

virtual bool ACovFunc::getCompatibleSpaceR ( ) const

inlinevirtual

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

getCompatibleSpaceS()

virtual bool ACovFunc::getCompatibleSpaceS ( ) const

inlinevirtual

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

getContext()

const CovContext & ACovFunc::getContext ( ) const

inline

getCorrec()

virtual double ACovFunc::getCorrec ( ) const

inlinevirtual

Reimplemented in CovMarkov, and CovMatern.

getCovName()

virtual String ACovFunc::getCovName ( ) const

pure virtual

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

getFormula()

virtual String ACovFunc::getFormula ( ) const

inlinevirtual

ACovFunc Interface.

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

getMarkovCoeffs()

VectorDouble ACovFunc::getMarkovCoeffs ( ) const

virtual

Reimplemented in CovMarkov, and CovMatern.

getMaxNDim()

virtual unsigned int ACovFunc::getMaxNDim ( ) const

inlinevirtual

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

getMinOrder()

virtual int ACovFunc::getMinOrder ( ) const

inlinevirtual

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

getParam()

double ACovFunc::getParam ( ) const

inline

getParMax()

virtual double ACovFunc::getParMax ( ) const

inlinevirtual

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

getScadef()

virtual double ACovFunc::getScadef ( ) const

inlinevirtual

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

getType()

const ECov & ACovFunc::getType ( ) const

inline

hasCovDerivative()

virtual bool ACovFunc::hasCovDerivative ( ) const

inlinevirtual

Reimplemented in CovCubic, CovGaussian, CovGCspline2, and CovWendland2.

hasCovOnRn()

virtual bool ACovFunc::hasCovOnRn ( ) const

inlinevirtual

Reimplemented in CovLinearSph, CovMarkov, and CovPoisson.

hasCovOnSphere()

bool ACovFunc::hasCovOnSphere ( ) const

virtual

Reimplemented in CovExponential, CovGeometric, CovLinearSph, and CovPoisson.

hasInt1D()

bool ACovFunc::hasInt1D ( ) const

virtual

hasInt2D()

bool ACovFunc::hasInt2D ( ) const

virtual

hasMarkovCoeffs()

virtual bool ACovFunc::hasMarkovCoeffs ( ) const

inlinevirtual

Reimplemented in CovMarkov, and CovMatern.

hasParam()

virtual bool ACovFunc::hasParam ( ) const

inlinevirtual

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

hasRange()

virtual int ACovFunc::hasRange ( ) const

inlinevirtual

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

hasSpectrumOnRn()

virtual bool ACovFunc::hasSpectrumOnRn ( ) const

inlinevirtual

Reimplemented in CovMarkov, and CovMatern.

hasSpectrumOnSphere()

virtual bool ACovFunc::hasSpectrumOnSphere ( ) const

inlinevirtual

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

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 CovExponential, CovGaussian, CovLinearSph, CovMatern, and CovPoisson.

isValidForTurningBand()

virtual bool ACovFunc::isValidForTurningBand ( ) const

inlinevirtual

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

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 CovMarkov, and CovMatern.

setField()

void ACovFunc::setField

(

double

field

)

setMarkovCoeffs()

void ACovFunc::setMarkovCoeffs ( VectorDouble  coeffs )

virtual

Reimplemented in CovMarkov, and CovMatern.

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 CovExponential, CovGaussian, and CovMatern.

simulateTurningBand()

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

inlinevirtual

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

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:

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