gstlearn  1.0.0
CCC
Checking validity for various parameters

Functions

bool Db::isColIdxValid (int icol) const
 
bool Db::isUIDValid (int iuid) const
 
bool Db::isSampleIndexValid (int iech) const
 
bool Db::isSampleIndicesValid (const VectorInt &iechs, bool useSel=false) const
 
bool Db::isLocatorIndexValid (const ELoc &locatorType, int locatorIndex) const
 
bool Db::isDimensionIndexValid (int 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
icolColumn rank to be checked
iuidUser-designated rank
iechSample rank to be checked
idimSpace rank to be checked
iechsVector of sample ranks to be checked
useSelWhen TRUE, the rank corresponds to the active sample
locatorTypeType of the Locator
locatorIndexRank of the locator (0-based)

Function Documentation

◆ isColIdxValid()

bool Db::isColIdxValid ( int  icol) const

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

◆ isDimensionIndexValid()

bool Db::isDimensionIndexValid ( int  idim) const

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

◆ isLocatorIndexValid()

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

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

◆ isSampleIndexValid()

bool Db::isSampleIndexValid ( int  iech) const

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

◆ isSampleIndicesValid()

bool Db::isSampleIndicesValid ( const VectorInt iechs,
bool  useSel = false 
) const

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

◆ isUIDValid()

bool Db::isUIDValid ( int  iuid) const

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