#include <AnamDiscreteDD.hpp>

Inheritance diagram for gstlrn::AnamDiscreteDD:

Public Member Functions
	AnamDiscreteDD (double mu=1., double scoef=0.)

	AnamDiscreteDD (const AnamDiscreteDD &m)

AnamDiscreteDD &	operator= (const AnamDiscreteDD &m)

virtual	~AnamDiscreteDD ()

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

const EAnam &	getType () const override
	AAnam Interface.

bool	hasFactor () const override

Id	getNFactor () const override

	z2factor (double z, const 1 &ifacs) const override

double	computeVariance (double sval) const override

Id	updatePointToBlock (double r_coef) override

bool	allowChangeSupport () const override

bool	isChangeSupportDefined () const override

Id	fitFromArray (const 1 &tab, const 1 &wt=1()) override

void	calculateMeanAndVariance () override
	AnamDiscrete Interface.

	factors_exp (bool verbose=false)

	factors_maf (bool verbose=false)

	factors_mod ()

MatrixSquare	chi2I (const 1 &chi, Id mode)

void	reset (Id ncut, double scoef, double mu, const 1 &zcut, const MatrixSquare &pcaz2f, const MatrixSquare &pcaf2z, const 1 &stats)

PCA &	getMAF ()

double	getMu () const

double	getSCoef () const

const MatrixSquare &	getI2Chi () const

MatrixSquare	getPcaZ2Fs () const

MatrixSquare	getPcaF2Zs () const

void	setMu (double mu)

void	setRCoef (double rcoef)

void	setPcaZ2F (const MatrixSquare &pcaz2f)

void	setPcaF2Z (const MatrixSquare &pcaf2z)

void	setI2Chi (const MatrixSquare &i2Chi)

Id	factor2Selectivity (Db db, Selectivity selectivity, const 1 &cols_est, const 1 &cols_std, Id iptr0)

Public Member Functions inherited from gstlrn::AnamDiscrete
	AnamDiscrete ()

	AnamDiscrete (const AnamDiscrete &m)

AnamDiscrete &	operator= (const AnamDiscrete &m)

virtual	~AnamDiscrete ()

bool	hasGaussian () const override
	AAnam interface.

Id	getNClass () const override

double	getVariance () const override

Id	getNCut () const

Id	getNElem () const

const &	getZCut () const

double	getZCut (Id i) const

double	getMean () const

void	setMean (double mean)

void	setVariance (double variance)

void	setNCut (Id ncut)

void	setZCut (const 1 &zcut)

void	setNElem (Id nelem)

void	setStats (const 1 &stats)

double	getDDStatProp (Id iclass) const

double	getDDStatZmoy (Id iclass) const

double	getDDStatCnorm (Id iclass) const

double	getDDStatLambda (Id iclass) const

double	getDDStatU (Id iclass) const

double	getDDStatMul (Id iclass) const

void	setDDStatProp (Id iclass, double value)

void	setDDStatZmoy (Id iclass, double value)

void	setDDStatCnorm (Id iclass, double value)

void	setDDStatLambda (Id iclass, double value)

void	setDDStatU (Id iclass, double value)

void	setDDStatMul (Id iclass, double value)

double	getIRStatT (Id iclass) const

double	getIRStatQ (Id iclass) const

double	getIRStatZ (Id iclass) const

double	getIRStatB (Id iclass) const

double	getIRStatR (Id iclass) const

double	getIRStatRV (Id iclass) const

void	setIRStatT (Id iclass, double value)

void	setIRStatQ (Id iclass, double value)

void	setIRStatZ (Id iclass, double value)

void	setIRStatB (Id iclass, double value)

void	setIRStatR (Id iclass, double value)

void	setIRStatRV (Id iclass, double value)

const MatrixDense &	getStats () const

Public Member Functions inherited from gstlrn::AAnam
	AAnam ()

	AAnam (const AAnam &m)

AAnam &	operator= (const AAnam &m)

virtual	~AAnam ()

virtual double	rawToTransformValue (double z) const

virtual double	transformToRawValue (double y) const

double	invertVariance (double cvv) const

	rawToTransformVec (const 1 &z) const

	transformToRawVec (const 1 &y) const

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

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

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

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

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

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

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

Id	rawToFactorByRanks (Db *db, const 1 &ifacs, const NamingConvention &namconv=NamingConvention("Factor"))

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

Public Member Functions inherited from gstlrn::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 (Id level) const final

Public Member Functions inherited from gstlrn::ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

	ASerializable (ASerializable &&r) noexcept

ASerializable &	operator= (ASerializable &&r) noexcept

virtual	~ASerializable ()

bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT"), bool verbose=false) const
	Dump the contents of an object into an Output File using a given Output NF Format.

void	setDefaultFormatNF (const EFormatNF &format)

Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

std::shared_ptr< ICloneable >	cloneShared () const

std::unique_ptr< ICloneable >	cloneUnique () const

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

static AnamDiscreteDD *	create (double mu=1., double scoef=0.)

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

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

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getPrefixName ()

Friends
class	Selectivity

Constructor & Destructor Documentation

◆ AnamDiscreteDD() [1/2]

gstlrn::AnamDiscreteDD::AnamDiscreteDD	(	double	mu = `1.`,
		double	scoef = `0.`
	)

◆ AnamDiscreteDD() [2/2]

gstlrn::AnamDiscreteDD::AnamDiscreteDD ( const AnamDiscreteDD & m )

◆ ~AnamDiscreteDD()

gstlrn::AnamDiscreteDD::~AnamDiscreteDD ( )

virtual

Member Function Documentation

◆ allowChangeSupport()

bool gstlrn::AnamDiscreteDD::allowChangeSupport ( ) const

inlineoverridevirtual

Reimplemented from gstlrn::AAnam.

◆ calculateMeanAndVariance()

void gstlrn::AnamDiscreteDD::calculateMeanAndVariance ( )

overridevirtual

AnamDiscrete Interface.

Reimplemented from gstlrn::AnamDiscrete.

◆ chi2I()

MatrixSquare gstlrn::AnamDiscreteDD::chi2I	(	const 1 &	chi,
		Id	mode
	)

Parameters

chi	Chi Matrix
mode	Type of recovery function 1 : Indicator 2 : Metal quantity 3 : Benefit

Returns: Calculate the transition matrix from factor to a recovery item i.e. Indicator, Metal Quantity or Benefit (according to mode) (Diffusion Discrete)

◆ computeVariance()

double gstlrn::AnamDiscreteDD::computeVariance ( double sval ) const

overridevirtual

Calculates the block variance

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

Reimplemented from gstlrn::AAnam.

◆ create()

AnamDiscreteDD * gstlrn::AnamDiscreteDD::create	(	double	mu = `1.`,
		double	scoef = `0.`
	)

static

◆ createFromNF()

AnamDiscreteDD * gstlrn::AnamDiscreteDD::createFromNF	(	const String &	NFFilename,
		bool	verbose = `true`
	)

static

ASerializable Interface.

◆ factor2Selectivity()

Id gstlrn::AnamDiscreteDD::factor2Selectivity	(	Db *	db,
		Selectivity *	selectivity,
		const 1 &	cols_est,
		const 1 &	cols_std,
		Id	iptr0
	)

Calculate Experimental Grade-Tonnage curves from factors Case of Discrete Diffusion

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

◆ factors_exp()

gstlrn::AnamDiscreteDD::factors_exp ( bool verbose = false )

◆ factors_maf()

gstlrn::AnamDiscreteDD::factors_maf ( bool verbose = false )

◆ factors_mod()

gstlrn::AnamDiscreteDD::factors_mod ( )

◆ fitFromArray()

Id gstlrn::AnamDiscreteDD::fitFromArray	(	const 1 &	tab,
		const 1 &	wt = `1()`
	)

overridevirtual

Reimplemented from gstlrn::AAnam.

◆ getI2Chi()

const MatrixSquare & gstlrn::AnamDiscreteDD::getI2Chi ( ) const

inline

◆ getMAF()

PCA & gstlrn::AnamDiscreteDD::getMAF ( )

inline

◆ getMu()

double gstlrn::AnamDiscreteDD::getMu ( ) const

inline

◆ getNFactor()

Id gstlrn::AnamDiscreteDD::getNFactor ( ) const

inlineoverridevirtual

Reimplemented from gstlrn::AAnam.

◆ getPcaF2Zs()

MatrixSquare gstlrn::AnamDiscreteDD::getPcaF2Zs ( ) const

inline

◆ getPcaZ2Fs()

MatrixSquare gstlrn::AnamDiscreteDD::getPcaZ2Fs ( ) const

inline

◆ getSCoef()

double gstlrn::AnamDiscreteDD::getSCoef ( ) const

inline

◆ getType()

const EAnam & gstlrn::AnamDiscreteDD::getType ( ) const

inlineoverridevirtual

AAnam Interface.

Implements gstlrn::AAnam.

◆ hasFactor()

bool gstlrn::AnamDiscreteDD::hasFactor ( ) const

inlineoverridevirtual

Reimplemented from gstlrn::AAnam.

◆ isChangeSupportDefined()

bool gstlrn::AnamDiscreteDD::isChangeSupportDefined ( ) const

inlineoverridevirtual

Implements gstlrn::AAnam.

◆ operator=()

AnamDiscreteDD & gstlrn::AnamDiscreteDD::operator= ( const AnamDiscreteDD & m )

◆ reset()

void gstlrn::AnamDiscreteDD::reset	(	Id	ncut,
		double	scoef,
		double	mu,
		const 1 &	zcut,
		const MatrixSquare &	pcaz2f,
		const MatrixSquare &	pcaf2z,
		const 1 &	stats
	)

◆ setI2Chi()

void gstlrn::AnamDiscreteDD::setI2Chi ( const MatrixSquare & i2Chi )

inline

◆ setMu()

void gstlrn::AnamDiscreteDD::setMu ( double mu )

inline

◆ setPcaF2Z()

void gstlrn::AnamDiscreteDD::setPcaF2Z ( const MatrixSquare & pcaf2z )

inline

◆ setPcaZ2F()

void gstlrn::AnamDiscreteDD::setPcaZ2F ( const MatrixSquare & pcaz2f )

inline

◆ setRCoef()

void gstlrn::AnamDiscreteDD::setRCoef ( double rcoef )

inline

◆ toString()

String gstlrn::AnamDiscreteDD::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

ICloneable Interface.

AStringable Interface

Reimplemented from gstlrn::AnamDiscrete.

◆ updatePointToBlock()

Id gstlrn::AnamDiscreteDD::updatePointToBlock ( double r_coef )

overridevirtual

Reimplemented from gstlrn::AAnam.

◆ z2factor()

gstlrn::AnamDiscreteDD::z2factor	(	double	z,
		const 1 &	ifacs
	)		const

overridevirtual

Reimplemented from gstlrn::AAnam.

Friends And Related Symbol Documentation

◆ Selectivity

friend class Selectivity

friend

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

include/Anamorphosis/AnamDiscreteDD.hpp
src/Anamorphosis/AnamDiscreteDD.cpp

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

◆ AnamDiscreteDD() [1/2]

◆ AnamDiscreteDD() [2/2]

◆ ~AnamDiscreteDD()

Member Function Documentation

◆ allowChangeSupport()

◆ calculateMeanAndVariance()

◆ chi2I()

◆ computeVariance()

◆ create()

◆ createFromNF()

◆ factor2Selectivity()

◆ factors_exp()

◆ factors_maf()

◆ factors_mod()

◆ fitFromArray()

◆ getI2Chi()

◆ getMAF()

◆ getMu()

◆ getNFactor()

◆ getPcaF2Zs()

◆ getPcaZ2Fs()

◆ getSCoef()

◆ getType()

◆ hasFactor()

◆ isChangeSupportDefined()

◆ operator=()

◆ reset()

◆ setI2Chi()

◆ setMu()

◆ setPcaF2Z()

◆ setPcaZ2F()

◆ setRCoef()

◆ toString()

◆ updatePointToBlock()

◆ z2factor()

Friends And Related Symbol Documentation

◆ Selectivity