gstlrn::VarioOrder Class Reference

#include <VarioOrder.hpp>

Public Member Functions
	VarioOrder (Id flag_dist=0, Id size_aux=0)
	VarioOrder (const VarioOrder &r)=default
VarioOrder &	operator= (const VarioOrder &r)=default
virtual	~VarioOrder ()=default
Id	final ()
void	clear ()
void	printout (Id idir_target, Id ipas_target, Id verbose)
void	getBounds (Id idir, Id ilag, Id *ifirst, Id *ilast) const
void	getIndices (Id ipair, Id *iech, Id *jech, double *dist) const
void	getAuxiliary (Id ipair, char *aux_iech, char *aux_jech) const
Id	add (Id iech, Id jech, void *aux_iech, void *aux_jech, Id ilag, Id idir, double dist)
bool	empty () const

Constructor & Destructor Documentation

VarioOrder() [1/2]

gstlrn::VarioOrder::VarioOrder	(	Id	flag_dist = 0,
		Id	size_aux = 0
	)

VarioOrder() [2/2]

gstlrn::VarioOrder::VarioOrder ( const VarioOrder &  r )

default

~VarioOrder()

virtual gstlrn::VarioOrder::~VarioOrder ( )

virtualdefault

Member Function Documentation

add()

Id gstlrn::VarioOrder::add	(	Id	iech,
		Id	jech,
		void *	aux_iech,
		void *	aux_jech,
		Id	ilag,
		Id	idir,
		double	dist
	)

Add a record to the Variogram Order structure

Returns

Error return code

Parameters

[in]	iech	Rank of the first sample
[in]	jech	Rank of the second sample
[in]	aux_iech	Auxiliary array for sample 'iech' (or NULL)
[in]	aux_jech	Auxiliary array for sample 'jech' (or NULL)
[in]	ilag	Rank of the lag
[in]	idir	Rank of the direction (or 0)
[in]	dist	Calculated distance (only stored if flag_dist == 1)

clear()

void gstlrn::VarioOrder::clear

(

)

empty()

bool gstlrn::VarioOrder::empty ( ) const

inline

final()

Id gstlrn::VarioOrder::final

(

)

getAuxiliary()

void gstlrn::VarioOrder::getAuxiliary	(	Id	ipair,
		char *	aux_iech,
		char *	aux_jech
	)		const

Returns the two auxiliary arrays for a given (ordered) pair

Parameters

[in]	ipair	Rank of the sorted pair
[out]	aux_iech	Array to auxiliary information for sample 'iech'
[out]	aux_jech	Array to auxiliary information for sample 'jech'

getBounds()

void gstlrn::VarioOrder::getBounds	(	Id	idir,
		Id	ilag,
		Id *	ifirst,
		Id *	ilast
	)		const

Returns the first and last indices matching a target lag

Parameters

[in]	idir	Rank of the target direction
[in]	ilag	Rank of the target lag
[out]	ifirst	Rank of the first sample of the lag (included)
[out]	ilast	Rank of the last sample of the lag (excluded)

getIndices()

void gstlrn::VarioOrder::getIndices	(	Id	ipair,
		Id *	iech,
		Id *	jech,
		double *	dist
	)		const

Returns the two samples for a given (ordered) pair

Parameters

[in]	ipair	Rank of the sorted pair
[out]	iech	Rank of the first sample
[out]	jech	Rank of the second sample
[out]	dist	Calculated distance or TEST (if flag_dist == 0)

operator=()

VarioOrder & gstlrn::VarioOrder::operator= ( const VarioOrder &  r )

default

printout()

void gstlrn::VarioOrder::printout	(	Id	idir_target,
		Id	ipas_target,
		Id	verbose
	)

Print the VarioOrder structure

Parameters

[in]	idir_target	Rank of the target direction (starting from 0) or -1
[in]	ipas_target	Rank of the target lag (starting from 0) or -1
[in]	verbose	1 for a complete printout

---

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

• include/Variogram/VarioOrder.hpp
• src/Variogram/VarioOrder.cpp