Option_AutoFit Class Reference

#include <Option_AutoFit.hpp>

Inheritance diagram for Option_AutoFit:

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

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
• flag_intrinsic: When True, fit a Model which includes at least one Intrinsic basic structure
• 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
• useEigenLibrary: Use or discard use of Eigen library when calculating Eigen Values

Constructor & Destructor Documentation

Option_AutoFit::Option_AutoFit

(

)

Option_AutoFit::Option_AutoFit

(

const Option_AutoFit &

m

)

Option_AutoFit::~Option_AutoFit ( )

virtual

Member Function Documentation

double Option_AutoFit::getEpsdelta ( ) const

inline

int Option_AutoFit::getFlagIntrinsic ( ) const

inline

double Option_AutoFit::getInitdelta ( ) const

inline

int Option_AutoFit::getMaxiter ( ) const

inline

double Option_AutoFit::getTolred ( ) const

inline

double Option_AutoFit::getTolsigma ( ) const

inline

double Option_AutoFit::getTolstop ( ) const

inline

bool Option_AutoFit::getVerbose ( ) const

inline

int Option_AutoFit::getWmode ( ) const

inline

bool Option_AutoFit::isUseEigenLibrary ( ) const

inline

Option_AutoFit & Option_AutoFit::operator=

(

const Option_AutoFit &

m

)

void Option_AutoFit::setEpsdelta ( double  epsdelta )

inline

void Option_AutoFit::setFlagIntrinsic ( int  flagIntrinsic )

inline

void Option_AutoFit::setInitdelta ( double  initdelta )

inline

void Option_AutoFit::setMaxiter ( int  maxiter )

inline

void Option_AutoFit::setTolred ( double  tolred )

inline

void Option_AutoFit::setTolsigma ( double  tolsigma )

inline

void Option_AutoFit::setTolstop ( double  tolstop )

inline

void Option_AutoFit::setUseEigenLibrary ( bool  useEigenLibrary )

inline

void Option_AutoFit::setVerbose ( bool  verbose )

inline

void Option_AutoFit::setWmode ( int  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

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

overridevirtual

Reimplemented from AStringable.

---

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

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