Checking validity for various parameters

Functions
bool	gstlrn::Db::isColIdxValid (Id icol) const
bool	gstlrn::Db::isUIDValid (Id iuid) const
bool	gstlrn::Db::isSampleIndexValid (Id iech) const
bool	gstlrn::Db::isSampleIndicesValid (const 1 &iechs, bool useSel=false) const
bool	gstlrn::Db::isLocatorIndexValid (const ELoc &locatorType, Id locatorIndex) const
bool	gstlrn::Db::isDimensionIndexValid (Id idim) const

Detailed Description

These functions are used in order to check that the arguments are valid (such as the sample rank, the locator type, the user-designation rank)

Parameters

icol	Column rank to be checked
iuid	User-designated rank
iech	Sample rank to be checked
idim	Space rank to be checked
iechs	Vector of sample ranks to be checked
useSel	When TRUE, the rank corresponds to the active sample
locatorType	Type of the Locator
locatorIndex	Rank of the locator (0-based)

Function Documentation

isColIdxValid()

bool gstlrn::Db::isColIdxValid

(

Id

icol

)

const

Check if the argument 'icol' is a valid Column rank (0-based)

isDimensionIndexValid()

bool gstlrn::Db::isDimensionIndexValid

(

Id

idim

)

const

Check if the argument 'idim' is a valid Space rank (0-based)

isLocatorIndexValid()

bool gstlrn::Db::isLocatorIndexValid	(	const ELoc &	locatorType,
		Id	locatorIndex
	)		const

Check if the arguments 'locatorType' and 'locatorIndex' are valid

isSampleIndexValid()

bool gstlrn::Db::isSampleIndexValid

(

Id

iech

)

const

Check if the argument 'iech' is a valid Sample rank (0-based)

isSampleIndicesValid()

bool gstlrn::Db::isSampleIndicesValid	(	const 1 &	iechs,
		bool	useSel = false
	)		const

Check if the argument 'iechs' are valid Sample ranks (0-based)

isUIDValid()

bool gstlrn::Db::isUIDValid

(

Id

iuid

)

const

Check if the argument 'iuid' is a valid user-designated rank