RankHandler Class Reference

Class returning the list of sample IDs for a quick search within a Db. More...

#include <RankHandler.hpp>

Detailed Description

Class returning the list of sample IDs for a quick search within a Db.

The main functionality of this class is to return the list of samples per variable, within a given list of elligible sample ranks (neighborhood)

Public Member Functions
	RankHandler (const Db *db=nullptr, bool useSel=true, bool useZ=true, bool useVerr=false, bool useExtD=true)
	RankHandler (const RankHandler &r)
RankHandler &	operator= (const RankHandler &r)
virtual	~RankHandler ()
void	defineSampleRanks (const VectorInt &nbgh=VectorInt())
const VectorInt &	getSampleRanks (int ivar) const
const VectorVectorInt &	getSampleRanks () const
VectorInt &	getSampleRanksByVariable (int ivar)
std::shared_ptr< VectorDouble > &	getZflatten ()
int	getNumber () const
	Return the total number of samples.
int	getCount (int ivar) const
	Get the number of active samples for a given variable.
int	getTotalCount () const
	Get the total number of active samples for all variables.
int	identifyVariableRank (int ipos) const
int	identifySampleRank (int ipos) const
void	dump (bool flagFull=false) const

Constructor & Destructor Documentation

RankHandler() [1/2]

RankHandler::RankHandler	(	const Db *	db = nullptr,
		bool	useSel = true,
		bool	useZ = true,
		bool	useVerr = false,
		bool	useExtD = true
	)

RankHandler() [2/2]

RankHandler::RankHandler

(

const RankHandler &

r

)

~RankHandler()

RankHandler::~RankHandler ( )

virtual

Member Function Documentation

defineSampleRanks()

void RankHandler::defineSampleRanks

(

const VectorInt &

nbgh = VectorInt()

)

Defines the list of indices 'index' for valid samples for the set of variables (Z locator)

Parameters

nbgh	Vector giving the ranks of the elligible samples (optional)

dump()

void RankHandler::dump

(

bool

flagFull = false

)

const

getCount()

int RankHandler::getCount

(

int

ivar

)

const

Get the number of active samples for a given variable.

Parameters

ivar	Rank of the target variable

Returns

int

getNumber()

int RankHandler::getNumber

(

)

const

Return the total number of samples.

Returns

int

getSampleRanks() [1/2]

const VectorVectorInt & RankHandler::getSampleRanks ( ) const

inline

getSampleRanks() [2/2]

const VectorInt & RankHandler::getSampleRanks ( int  ivar ) const

inline

getSampleRanksByVariable()

VectorInt & RankHandler::getSampleRanksByVariable ( int  ivar )

inline

getTotalCount()

int RankHandler::getTotalCount

(

)

const

Get the total number of active samples for all variables.

Returns

int

getZflatten()

std::shared_ptr< VectorDouble > & RankHandler::getZflatten ( )

inline

identifySampleRank()

int RankHandler::identifySampleRank

(

int

ipos

)

const

identifyVariableRank()

int RankHandler::identifyVariableRank

(

int

ipos

)

const

operator=()

RankHandler & RankHandler::operator=

(

const RankHandler &

r

)

---

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

• include/Db/RankHandler.hpp
• src/Db/RankHandler.cpp