#include <AnamDiscreteIR.hpp>

Inheritance diagram for AnamDiscreteIR:

Public Member Functions
	AnamDiscreteIR (double rcoef=0.)

	AnamDiscreteIR (const AnamDiscreteIR &m)

AnamDiscreteIR &	operator= (const AnamDiscreteIR &m)

virtual	~AnamDiscreteIR ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable Interface. More...

const EAnam &	getType () const override
	AAnam Interface. More...

bool	hasFactor () const override

VectorDouble	z2factor (double z, const VectorInt &ifacs) const override

double	computeVariance (double sval) const override

int	updatePointToBlock (double r_coef) override

bool	allowChangeSupport () const override

bool	isChangeSupportDefined () const override

int	fitFromArray (const VectorDouble &tab, const VectorDouble &wt=VectorDouble()) override

void	calculateMeanAndVariance () override
	AnamDiscrete Interface. More...

AnamDiscreteIR *	create (double rcoef=0.)

void	reset (int ncut, double r_coef, const VectorDouble &zcut, const VectorDouble &stats)

double	getRCoef () const

void	setRCoef (double rcoef)

int	factor2Selectivity (Db db, Selectivity selectivity, const VectorInt &cols_est, const VectorInt &cols_std, int iptr0)

Public Member Functions inherited from AnamDiscrete
	AnamDiscrete ()

	AnamDiscrete (const AnamDiscrete &m)

AnamDiscrete &	operator= (const AnamDiscrete &m)

virtual	~AnamDiscrete ()

bool	hasGaussian () const override
	AAnam interface. More...

int	getNClass () const

virtual double	getVariance () const override

int	getNCut () const

int	getNElem () const

const VectorDouble &	getZCut () const

double	getZCut (int i) const

double	getMean () const

void	setMean (double mean)

void	setVariance (double variance)

void	setNCut (int ncut)

void	setZCut (const VectorDouble &zcut)

void	setNElem (int nelem)

void	setStats (const VectorDouble &stats)

double	getDDStatProp (int iclass) const

double	getDDStatZmoy (int iclass) const

double	getDDStatCnorm (int iclass) const

double	getDDStatLambda (int iclass) const

double	getDDStatU (int iclass) const

double	getDDStatMul (int iclass) const

void	setDDStatProp (int iclass, double value)

void	setDDStatZmoy (int iclass, double value)

void	setDDStatCnorm (int iclass, double value)

void	setDDStatLambda (int iclass, double value)

void	setDDStatU (int iclass, double value)

void	setDDStatMul (int iclass, double value)

double	getIRStatT (int iclass) const

double	getIRStatQ (int iclass) const

double	getIRStatZ (int iclass) const

double	getIRStatB (int iclass) const

double	getIRStatR (int iclass) const

double	getIRStatRV (int iclass) const

void	setIRStatT (int iclass, double value)

void	setIRStatQ (int iclass, double value)

void	setIRStatZ (int iclass, double value)

void	setIRStatB (int iclass, double value)

void	setIRStatR (int iclass, double value)

void	setIRStatRV (int iclass, double value)

const MatrixRectangular &	getStats () const

Public Member Functions inherited from AAnam
	AAnam ()

	AAnam (const AAnam &m)

AAnam &	operator= (const AAnam &m)

virtual	~AAnam ()

virtual int	getNFactor () const

virtual double	rawToTransformValue (double z) const

virtual double	transformToRawValue (double y) const

double	invertVariance (double cvv) const

VectorDouble	rawToTransformVec (const VectorDouble &z) const

VectorDouble	transformToRawVec (const VectorDouble &z) const

int	fitFromLocator (Db *db, const ELoc &locatorType=ELoc::fromKey("Z"))

int	fit (Db *db, const String &name)

int	rawToGaussianByLocator (Db *db, const NamingConvention &namconv=NamingConvention("Y"))

int	rawToGaussian (Db *db, const String &name, const NamingConvention &namconv=NamingConvention("Y"))

int	normalScore (Db *db, const String &name, const NamingConvention &namconv=NamingConvention("Gaussian"))

int	gaussianToRawByLocator (Db *db, const NamingConvention &namconv=NamingConvention("Z"))

int	gaussianToRaw (Db *db, const String &name, const NamingConvention &namconv=NamingConvention("Z"))

int	rawToFactorByRanks (Db *db, const VectorInt &ifacs, const NamingConvention &namconv=NamingConvention("Factor"))

int	rawToFactor (Db *db, int nfactor, const NamingConvention &namconv=NamingConvention("Factor"))

Public Member Functions inherited from AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (const AStringable &r)

virtual	~AStringable ()

virtual void	display (const AStringFormat *strfmt=nullptr) const final

virtual void	display (int level) const final

Public Member Functions inherited from ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

virtual	~ASerializable ()

bool	deserialize (std::istream &is, bool verbose=true)

bool	serialize (std::ostream &os, bool verbose=true) const

bool	dumpToNF (const String &neutralFilename, bool verbose=false) const

Public Member Functions inherited from ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

Static Public Member Functions
static AnamDiscreteIR *	createFromNF (const String &neutralFilename, bool verbose=true)
	ASerializable Interface. More...

Static Public Member Functions inherited from ASerializable
static String	buildFileName (int status, const String &filename, bool ensureDirExist=false)

static String	getHomeDirectory (const String &sub="")

static String	getWorkingDirectory ()

static String	getTestData (const String &subdir, const String &filename)

static String	getFileIdentity (const String &filename, bool verbose=false)

static void	setContainerName (bool useDefault, const String &containerName="", bool verbose=false)

static void	unsetContainerName ()

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getContainerName ()

static const String &	getPrefixName ()

static bool	createDirectory (const String &dir)

static String	getExecDirectory ()

static String	getDirectory (const String &path)

Protected Member Functions
virtual bool	_deserialize (std::istream &is, bool verbose=false) override
	Interface for ASerializable. More...

virtual bool	_serialize (std::ostream &os, bool verbose=false) const override

String	_getNFName () const override

Protected Member Functions inherited from AnamDiscrete
bool	_isClassValid (int iclass) const

void	_resize ()

Protected Member Functions inherited from AAnam
bool	_isSampleSkipped (Db *db, int iech, const VectorInt &cols_est, const VectorInt &cols_std)

bool	_isFitted () const

Protected Member Functions inherited from ASerializable
bool	_fileOpenWrite (const String &filename, std::ofstream &os, bool verbose=false) const

bool	_fileOpenRead (const String &filename, std::ifstream &is, bool verbose=false) const

Private Member Functions
int	_stats_residuals (int verbose, int nech, const VectorDouble &tab, int nsorted, double mean, double residuals, double T, double *Q)

double	_getResidual (int iclass, double z) const

void	_globalSelectivity (Selectivity *selectivity)

Private Attributes
double	_sCoef

Friends
class	Selectivity

Additional Inherited Members
Static Protected Member Functions inherited from ASerializable
static bool	_commentWrite (std::ostream &os, const String &comment)

template<typename T >
static bool	_recordWrite (std::ostream &os, const String &title, const T &val)

template<typename T >
static bool	_recordWriteVec (std::ostream &os, const String &title, const VectorT< T > &vec)

template<typename T >
static bool	_recordRead (std::istream &is, const String &title, T &val)

template<typename T >
static bool	_recordReadVec (std::istream &is, const String &title, VectorT< T > &vec, int nvalues)

static bool	_onlyBlanks (char *string)

static bool	_tableRead (std::istream &is, const String &string, int ntab, double *tab)

static bool	_tableWrite (std::ostream &os, const String &string, int ntab, const VectorDouble &tab)

Constructor & Destructor Documentation

◆ AnamDiscreteIR() [1/2]

AnamDiscreteIR::AnamDiscreteIR ( double rcoef = 0. )

◆ AnamDiscreteIR() [2/2]

AnamDiscreteIR::AnamDiscreteIR ( const AnamDiscreteIR & m )

◆ ~AnamDiscreteIR()

AnamDiscreteIR::~AnamDiscreteIR ( )

virtual

Member Function Documentation

◆ _deserialize()

bool AnamDiscreteIR::_deserialize	(	std::istream &	is,
		bool	verbose = `false`
	)

overrideprotectedvirtual

Interface for ASerializable.

Reimplemented from AnamDiscrete.

◆ _getNFName()

String AnamDiscreteIR::_getNFName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from AnamDiscrete.

◆ _getResidual()

double AnamDiscreteIR::_getResidual	(	int	iclass,
		double	z
	)		const

private

Parameters

iclass	Rank of the class
z	Input value

Returns: Calculate the normalized residual for a given value

◆ _globalSelectivity()

void AnamDiscreteIR::_globalSelectivity ( Selectivity * selectivity )

private

Calculate the theoretical grade tonnage value (Discrete Indicator Residuals)

◆ _serialize()

bool AnamDiscreteIR::_serialize	(	std::ostream &	os,
		bool	verbose = `false`
	)		const

overrideprotectedvirtual

Reimplemented from AnamDiscrete.

◆ _stats_residuals()

int AnamDiscreteIR::_stats_residuals	(	int	verbose,
		int	nech,
		const VectorDouble &	tab,
		int *	nsorted,
		double *	mean,
		double *	residuals,
		double *	T,
		double *	Q
	)

private

◆ allowChangeSupport()

bool AnamDiscreteIR::allowChangeSupport ( ) const

inlineoverridevirtual

Reimplemented from AAnam.

◆ calculateMeanAndVariance()

void AnamDiscreteIR::calculateMeanAndVariance ( )

overridevirtual

AnamDiscrete Interface.

Reimplemented from AnamDiscrete.

◆ computeVariance()

double AnamDiscreteIR::computeVariance ( double sval ) const

overridevirtual

Calculates the block variance

Returns: Value of the block variance (as a function of support coefficient)

Reimplemented from AAnam.

◆ create()

AnamDiscreteIR * AnamDiscreteIR::create ( double rcoef = 0. )

◆ createFromNF()

AnamDiscreteIR * AnamDiscreteIR::createFromNF	(	const String &	neutralFilename,
		bool	verbose = `true`
	)

static

ASerializable Interface.

◆ factor2Selectivity()

int AnamDiscreteIR::factor2Selectivity	(	Db *	db,
		Selectivity *	selectivity,
		const VectorInt &	cols_est,
		const VectorInt &	cols_std,
		int	iptr0
	)

Calculate Experimental Grade-Tonnage curves from factors Case of Discrete Indicator Residuals

Returns: Error return code

Parameters

[in]	db	Db structure containing the factors (Z-locators)
[in]	selectivity	Selectivity structure
[in]	cols_est	Array of UIDs for factor estimation
[in]	cols_std	Array of UIDs for factor St. Dev.
[in]	iptr0	Rank for storing the results

◆ fitFromArray()

int AnamDiscreteIR::fitFromArray	(	const VectorDouble &	tab,
		const VectorDouble &	wt = `VectorDouble()`
	)

overridevirtual

Reimplemented from AAnam.

◆ getRCoef()

double AnamDiscreteIR::getRCoef ( ) const

inline

◆ getType()

const EAnam& AnamDiscreteIR::getType ( ) const

inlineoverridevirtual

AAnam Interface.

Implements AAnam.

◆ hasFactor()

bool AnamDiscreteIR::hasFactor ( ) const

inlineoverridevirtual

Reimplemented from AAnam.

◆ isChangeSupportDefined()

bool AnamDiscreteIR::isChangeSupportDefined ( ) const

inlineoverridevirtual

Implements AAnam.

◆ operator=()

AnamDiscreteIR & AnamDiscreteIR::operator= ( const AnamDiscreteIR & m )

◆ reset()

void AnamDiscreteIR::reset	(	int	ncut,
		double	r_coef,
		const VectorDouble &	zcut,
		const VectorDouble &	stats
	)

◆ setRCoef()

void AnamDiscreteIR::setRCoef ( double rcoef )

inline

◆ toString()

String AnamDiscreteIR::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

ICloneable Interface.

AStringable Interface

Reimplemented from AnamDiscrete.

◆ updatePointToBlock()

int AnamDiscreteIR::updatePointToBlock ( double r_coef )

overridevirtual

Reimplemented from AAnam.

◆ z2factor()

VectorDouble AnamDiscreteIR::z2factor	(	double	z,
		const VectorInt &	ifacs
	)		const

overridevirtual

Reimplemented from AAnam.

Friends And Related Function Documentation

◆ Selectivity

friend class Selectivity

friend

Member Data Documentation

◆ _sCoef

double AnamDiscreteIR::_sCoef

private

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

include/Anamorphosis/AnamDiscreteIR.hpp
src/Anamorphosis/AnamDiscreteIR.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ AnamDiscreteIR() [1/2]

◆ AnamDiscreteIR() [2/2]

◆ ~AnamDiscreteIR()

Member Function Documentation

◆ _deserialize()

◆ _getNFName()

◆ _getResidual()

◆ _globalSelectivity()

◆ _serialize()

◆ _stats_residuals()

◆ allowChangeSupport()

◆ calculateMeanAndVariance()

◆ computeVariance()

◆ create()

◆ createFromNF()

◆ factor2Selectivity()

◆ fitFromArray()

◆ getRCoef()

◆ getType()

◆ hasFactor()

◆ isChangeSupportDefined()

◆ operator=()

◆ reset()

◆ setRCoef()

◆ toString()

◆ updatePointToBlock()

◆ z2factor()

Friends And Related Function Documentation

◆ Selectivity

Member Data Documentation

◆ _sCoef