gstlearn  0.2.1
Geostatistics & Machine Learning toolbox
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
VarioParam Class Reference

#include <VarioParam.hpp>

Inheritance diagram for VarioParam:
AStringable ICloneable

Public Member Functions

 VarioParam (double scale=0., const VectorDouble &dates=VectorDouble(), const Faults *faults=nullptr)
 
 VarioParam (const VarioParam &VarioParam, const VectorInt &rankdirs, const Faults *faults=nullptr)
 
 VarioParam (const VarioParam &r)
 
VarioParam & operator= (const VarioParam &r)
 
virtual ~VarioParam ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 ICloneable interface. More...
 
void addDir (const DirParam &dirparam)
 
void addMultiDirs (const std::vector< DirParam > &dirparams)
 
void delDir (int rank)
 
void delAllDirs ()
 
double getScale () const
 
int getDateNumber () const
 
int getDirectionNumber () const
 
const VectorDouble & getDates () const
 
double getDate (int idate, int icas) const
 
int getLagNumber (int idir) const
 
VectorDouble getCodirs (int idir=0) const
 
const std::vector< DirParam > & getDirParams () const
 
const DirParam & getDirParam (int idir) const
 
int getDimensionNumber () const
 
bool isDefinedForGrid () const
 
int hasDate () const
 
void setScale (double scale)
 
void setDates (VectorDouble dates)
 
void setDPas (int idir, const DbGrid *db)
 
void setGrincr (int idir, const VectorInt &grincr)
 
String toStringMain (const AStringFormat *strfmt) const
 
const Faults * getFaults () const
 
bool hasFaults () const
 
void addFaults (const Faults *faults)
 
- 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
 
- Public Member Functions inherited from ICloneable
 ICloneable ()
 
virtual ~ICloneable ()
 
virtual ICloneable * clone () const =0
 

Static Public Member Functions

static VarioParam * createOmniDirection (int npas=10, double dpas=1., double toldis=0.5, int opt_code=0, int idate=0, double bench=TEST, double cylrad=TEST, double tolcode=0., const VectorDouble &breaks=VectorDouble(), double scale=0., const VectorDouble &dates=VectorDouble(), const ASpace *space=nullptr)
 Shortcuts. More...
 
static VarioParam * createMultiple (int ndir, int npas=10, double dpas=1., double toldis=0.5, double scale=0., const VectorDouble &dates=VectorDouble(), const ASpace *space=nullptr)
 
static VarioParam * createMultipleFromGrid (int npas, double scale=0., const VectorDouble &dates=VectorDouble(), const ASpace *space=nullptr)
 
static VarioParam * createFromSpaceDimension (int npas=10, double dpas=1., double toldis=0.5, double tolang=45., double scale=0., const VectorDouble &dates=VectorDouble(), const ASpace *space=nullptr)
 

Private Member Functions

int _getAddress (int ivar, int jvar) const
 
bool _isVariableValid (int ivar) const
 
bool _isDirectionValid (int idir) const
 
bool _isBivariableValid (int i) const
 
bool _isDateValid (int idate) const
 
void _initMeans ()
 
void _initVars ()
 
VectorDouble _getDirectionInterval (int idir) const
 
bool _validDefinedFromGrid (const DirParam &dirparam) const
 

Private Attributes

double _scale
 
VectorDouble _dates
 
std::vector< DirParam > _dirparams
 
const Faults * _faults
 

Detailed Description

Experimental Variogram calculation parameters TODO : to be improved

Constructor & Destructor Documentation

◆ VarioParam() [1/3]

VarioParam::VarioParam ( double  scale = 0.,
const VectorDouble &  dates = VectorDouble(),
const Faults *  faults = nullptr 
)

◆ VarioParam() [2/3]

VarioParam::VarioParam ( const VarioParam &  VarioParam,
const VectorInt &  rankdirs,
const Faults *  faults = nullptr 
)

◆ VarioParam() [3/3]

VarioParam::VarioParam ( const VarioParam &  r)

◆ ~VarioParam()

VarioParam::~VarioParam ( )
virtual

Member Function Documentation

◆ _getAddress()

int VarioParam::_getAddress ( int  ivar,
int  jvar 
) const
private

◆ _getDirectionInterval()

VectorDouble VarioParam::_getDirectionInterval ( int  idir) const
private

◆ _initMeans()

void VarioParam::_initMeans ( )
private

◆ _initVars()

void VarioParam::_initVars ( )
private

◆ _isBivariableValid()

bool VarioParam::_isBivariableValid ( int  i) const
private

◆ _isDateValid()

bool VarioParam::_isDateValid ( int  idate) const
private

◆ _isDirectionValid()

bool VarioParam::_isDirectionValid ( int  idir) const
private

◆ _isVariableValid()

bool VarioParam::_isVariableValid ( int  ivar) const
private

◆ _validDefinedFromGrid()

bool VarioParam::_validDefinedFromGrid ( const DirParam &  dirparam) const
private

◆ addDir()

void VarioParam::addDir ( const DirParam &  dirparam)

◆ addFaults()

void VarioParam::addFaults ( const Faults *  faults)
inline

◆ addMultiDirs()

void VarioParam::addMultiDirs ( const std::vector< DirParam > &  dirparams)

◆ createFromSpaceDimension()

VarioParam * VarioParam::createFromSpaceDimension ( int  npas = 10,
double  dpas = 1.,
double  toldis = 0.5,
double  tolang = 45.,
double  scale = 0.,
const VectorDouble &  dates = VectorDouble(),
const ASpace *  space = nullptr 
)
static

◆ createMultiple()

VarioParam * VarioParam::createMultiple ( int  ndir,
int  npas = 10,
double  dpas = 1.,
double  toldis = 0.5,
double  scale = 0.,
const VectorDouble &  dates = VectorDouble(),
const ASpace *  space = nullptr 
)
static

◆ createMultipleFromGrid()

VarioParam * VarioParam::createMultipleFromGrid ( int  npas,
double  scale = 0.,
const VectorDouble &  dates = VectorDouble(),
const ASpace *  space = nullptr 
)
static

◆ createOmniDirection()

VarioParam * VarioParam::createOmniDirection ( int  npas = 10,
double  dpas = 1.,
double  toldis = 0.5,
int  opt_code = 0,
int  idate = 0,
double  bench = TEST,
double  cylrad = TEST,
double  tolcode = 0.,
const VectorDouble &  breaks = VectorDouble(),
double  scale = 0.,
const VectorDouble &  dates = VectorDouble(),
const ASpace *  space = nullptr 
)
static

Shortcuts.

◆ delAllDirs()

void VarioParam::delAllDirs ( )

◆ delDir()

void VarioParam::delDir ( int  rank)

◆ getCodirs()

VectorDouble VarioParam::getCodirs ( int  idir = 0) const

◆ getDate()

double VarioParam::getDate ( int  idate,
int  icas 
) const

◆ getDateNumber()

int VarioParam::getDateNumber ( ) const
inline

◆ getDates()

const VectorDouble& VarioParam::getDates ( ) const
inline

◆ getDimensionNumber()

int VarioParam::getDimensionNumber ( ) const

◆ getDirectionNumber()

int VarioParam::getDirectionNumber ( ) const
inline

◆ getDirParam()

const DirParam& VarioParam::getDirParam ( int  idir) const
inline

◆ getDirParams()

const std::vector<DirParam>& VarioParam::getDirParams ( ) const
inline

◆ getFaults()

const Faults* VarioParam::getFaults ( ) const
inline

◆ getLagNumber()

int VarioParam::getLagNumber ( int  idir) const

◆ getScale()

double VarioParam::getScale ( ) const
inline

◆ hasDate()

int VarioParam::hasDate ( ) const
inline

◆ hasFaults()

bool VarioParam::hasFaults ( ) const
inline

◆ isDefinedForGrid()

bool VarioParam::isDefinedForGrid ( ) const

◆ operator=()

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

◆ setDates()

void VarioParam::setDates ( VectorDouble  dates)
inline

◆ setDPas()

void VarioParam::setDPas ( int  idir,
const DbGrid *  db 
)

◆ setGrincr()

void VarioParam::setGrincr ( int  idir,
const VectorInt &  grincr 
)

◆ setScale()

void VarioParam::setScale ( double  scale)
inline

◆ toString()

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

ICloneable interface.

AStringable Interface

Reimplemented from AStringable.

◆ toStringMain()

String VarioParam::toStringMain ( const AStringFormat *  strfmt) const

Member Data Documentation

◆ _dates

VectorDouble VarioParam::_dates
private

◆ _dirparams

std::vector<DirParam> VarioParam::_dirparams
private

◆ _faults

const Faults* VarioParam::_faults
private

◆ _scale

double VarioParam::_scale
private
The documentation for this class was generated from the following files: