gstlrn::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 1 &nbgh=1())
const &	getSampleRanks (Id ivar) const
const &	getSampleRanks () const
&	getSampleRanksByVariable (Id ivar)
std::shared_ptr< 1 > &	getZflatten ()
Id	getNumber () const
	Return the total number of samples.
Id	getCount (Id ivar) const
	Get the number of active samples for a given variable.
Id	getTotalCount () const
	Get the total number of active samples for all variables.
Id	identifyVariableRank (Id ipos) const
Id	identifySampleRank (Id ipos) const
void	dump (bool flagFull=false) const

Constructor & Destructor Documentation

RankHandler() [1/2]

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

RankHandler() [2/2]

gstlrn::RankHandler::RankHandler

(

const RankHandler &

r

)

~RankHandler()

gstlrn::RankHandler::~RankHandler ( )

virtual

Member Function Documentation

defineSampleRanks()

void gstlrn::RankHandler::defineSampleRanks

(

const 1 &

nbgh = 1()

)

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 gstlrn::RankHandler::dump

(

bool

flagFull = false

)

const

getCount()

Id gstlrn::RankHandler::getCount

(

Id

ivar

)

const

Get the number of active samples for a given variable.

Parameters

ivar	Rank of the target variable

Returns

Id

getNumber()

Id gstlrn::RankHandler::getNumber

(

)

const

Return the total number of samples.

Returns

Id

getSampleRanks() [1/2]

const & gstlrn::RankHandler::getSampleRanks ( ) const

inline

getSampleRanks() [2/2]

const & gstlrn::RankHandler::getSampleRanks ( Id  ivar ) const

inline

getSampleRanksByVariable()

& gstlrn::RankHandler::getSampleRanksByVariable ( Id  ivar )

inline

getTotalCount()

Id gstlrn::RankHandler::getTotalCount

(

)

const

Get the total number of active samples for all variables.

Returns

Id

getZflatten()

std::shared_ptr< 1 > & gstlrn::RankHandler::getZflatten ( )

inline

identifySampleRank()

Id gstlrn::RankHandler::identifySampleRank

(

Id

ipos

)

const

identifyVariableRank()

Id gstlrn::RankHandler::identifyVariableRank

(

Id

ipos

)

const

operator=()

RankHandler & gstlrn::RankHandler::operator=

(

const RankHandler &

r

)

---

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

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