gstlrn::Option_AutoFit Class Reference

#include <Option_AutoFit.hpp>

Inheritance diagram for gstlrn::Option_AutoFit:

Detailed Description

This class defines the options and parameters used during the Variogram Fitting. All the parameters described hereafter are either available in the construction, or can be set using a specific get() function.

• verbose: Ask for a verbose option during the Automatic Model fitting
• wmode: Weighting option (see comments on the setWMode() function)
• maxiter: Maximum number of iterations
• tolstop: Define an absolute criterion used for stopping the iterations
• tolred: Define the relative criterion used for stopping the iterations
• epsdelta: Define the tolerance used for the search
• tolsigma: Percentage of the variance below which a basic structure is discarded
• initdelta: Initial radius of the trusting area

Public Member Functions
	Option_AutoFit ()
	Option_AutoFit (const Option_AutoFit &m)
Option_AutoFit &	operator= (const Option_AutoFit &m)
virtual	~Option_AutoFit ()
String	toString (const AStringFormat *strfmt=nullptr) const override
double	getEpsdelta () const
double	getInitdelta () const
Id	getMaxiter () const
double	getTolred () const
double	getTolsigma () const
double	getTolstop () const
bool	getVerbose () const
Id	getWmode () const
void	setEpsdelta (double epsdelta)
void	setInitdelta (double initdelta)
void	setMaxiter (Id maxiter)
void	setTolred (double tolred)
void	setTolsigma (double tolsigma)
void	setTolstop (double tolstop)
void	setVerbose (bool verbose)
void	setWmode (Id wmode)
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

Option_AutoFit() [1/2]

gstlrn::Option_AutoFit::Option_AutoFit

(

)

Option_AutoFit() [2/2]

gstlrn::Option_AutoFit::Option_AutoFit

(

const Option_AutoFit &

m

)

~Option_AutoFit()

gstlrn::Option_AutoFit::~Option_AutoFit ( )

virtual

Member Function Documentation

getEpsdelta()

double gstlrn::Option_AutoFit::getEpsdelta ( ) const

inline

getInitdelta()

double gstlrn::Option_AutoFit::getInitdelta ( ) const

inline

getMaxiter()

Id gstlrn::Option_AutoFit::getMaxiter ( ) const

inline

getTolred()

double gstlrn::Option_AutoFit::getTolred ( ) const

inline

getTolsigma()

double gstlrn::Option_AutoFit::getTolsigma ( ) const

inline

getTolstop()

double gstlrn::Option_AutoFit::getTolstop ( ) const

inline

getVerbose()

bool gstlrn::Option_AutoFit::getVerbose ( ) const

inline

getWmode()

Id gstlrn::Option_AutoFit::getWmode ( ) const

inline

operator=()

Option_AutoFit & gstlrn::Option_AutoFit::operator=

(

const Option_AutoFit &

m

)

setEpsdelta()

void gstlrn::Option_AutoFit::setEpsdelta ( double  epsdelta )

inline

setInitdelta()

void gstlrn::Option_AutoFit::setInitdelta ( double  initdelta )

inline

setMaxiter()

void gstlrn::Option_AutoFit::setMaxiter ( Id  maxiter )

inline

setTolred()

void gstlrn::Option_AutoFit::setTolred ( double  tolred )

inline

setTolsigma()

void gstlrn::Option_AutoFit::setTolsigma ( double  tolsigma )

inline

setTolstop()

void gstlrn::Option_AutoFit::setTolstop ( double  tolstop )

inline

setVerbose()

void gstlrn::Option_AutoFit::setVerbose ( bool  verbose )

inline

setWmode()

void gstlrn::Option_AutoFit::setWmode ( Id  wmode )

inline

Set the type of the weighting function used in the fitting procedure. This function is defined in the case of several directional experimental variograms, calculated in a multivariate case: 0: The weight is constant 1: The weight is proportional to the number of pairs 2: The weight is proportional to the number of pairs and inverse proportional to the distance 3: The weight is inverse proportional to the number of lags for each direction

Parameters

wmode

type of weighting function (0, 1, 2 or 3, see above)

Note

The default value for wmode is 2

toString()

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

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

• include/Model/Option_AutoFit.hpp
• src/Model/Option_AutoFit.cpp