#include <AAnam.hpp>

Inheritance diagram for gstlrn::AAnam:

Public Member Functions
	AAnam ()

	AAnam (const AAnam &m)

AAnam &	operator= (const AAnam &m)

virtual	~AAnam ()

virtual const EAnam &	getType () const =0
	Interface for AAnam.

virtual double	getVariance () const

virtual bool	hasFactor () const

virtual Id	getNFactor () const

virtual Id	getNClass () const

virtual bool	isChangeSupportDefined () const =0

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

virtual double	computeVariance (double sval) const

virtual Id	updatePointToBlock (double r_coef)

virtual bool	allowChangeSupport () const

virtual bool	hasGaussian () const

virtual double	rawToTransformValue (double z) const

virtual double	transformToRawValue (double y) const

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

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 String	toString (const AStringFormat *strfmt=nullptr) const

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)

virtual String	_getNFName () const =0

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

Additional Inherited Members
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 ()

Constructor & Destructor Documentation

◆ AAnam() [1/2]

gstlrn::AAnam::AAnam ( )

◆ AAnam() [2/2]

gstlrn::AAnam::AAnam ( const AAnam & m )

◆ ~AAnam()

gstlrn::AAnam::~AAnam ( )

virtual

Member Function Documentation

◆ allowChangeSupport()

virtual bool gstlrn::AAnam::allowChangeSupport ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, and gstlrn::AnamHermite.

◆ computeVariance()

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

virtual

Calculates the block variance

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

Reimplemented in gstlrn::AnamHermite, gstlrn::AnamDiscreteDD, and gstlrn::AnamDiscreteIR.

◆ fit()

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

◆ fitFromArray()

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

inlinevirtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, gstlrn::AnamEmpirical, and gstlrn::AnamHermite.

◆ fitFromLocator()

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

◆ gaussianToRaw()

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

◆ gaussianToRawByLocator()

Id gstlrn::AAnam::gaussianToRawByLocator	(	Db *	db,
		const NamingConvention &	namconv = `NamingConvention("Z")`
	)

◆ getNClass()

virtual Id gstlrn::AAnam::getNClass ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamDiscrete, and gstlrn::AnamHermite.

◆ getNFactor()

virtual Id gstlrn::AAnam::getNFactor ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamEmpirical, and gstlrn::AnamHermite.

◆ getType()

virtual const EAnam & gstlrn::AAnam::getType ( ) const

pure virtual

Interface for AAnam.

Implemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, gstlrn::AnamEmpirical, gstlrn::AnamHermite, and gstlrn::AnamUser.

◆ getVariance()

virtual double gstlrn::AAnam::getVariance ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamContinuous, and gstlrn::AnamDiscrete.

◆ hasFactor()

virtual bool gstlrn::AAnam::hasFactor ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, and gstlrn::AnamHermite.

◆ hasGaussian()

virtual bool gstlrn::AAnam::hasGaussian ( ) const

inlinevirtual

Reimplemented in gstlrn::AnamContinuous, and gstlrn::AnamDiscrete.

◆ invertVariance()

double gstlrn::AAnam::invertVariance ( double cvv ) const

Find the coefficient of change of support

Returns: Value for the change of support coefficient

Parameters

[in] cvv Mean covariance value over a block

◆ isChangeSupportDefined()

virtual bool gstlrn::AAnam::isChangeSupportDefined ( ) const

pure virtual

Implemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, gstlrn::AnamEmpirical, gstlrn::AnamHermite, and gstlrn::AnamUser.

◆ normalScore()

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

Transform the target variable inti Gaussian by Normal Score

Returns: Error return code

Parameters

[in]	db	Db Structure
[in]	name	Target variable
[in]	namconv	Naming convention

◆ operator=()

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

◆ rawToFactor()

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

Calculate the factors corresponding to an input data vector

Returns: Error return code

Parameters

[in]	db	Db structure
[in]	nfactor	Number of first factors
[in]	namconv	Naming convention

◆ rawToFactorByRanks()

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

Calculate the factors corresponding to an input data vector

Returns: Error return code

Parameters

[in]	db	Db structure
[in]	ifacs	Array of factor ranks
[in]	namconv	Naming convention

◆ rawToGaussian()

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

◆ rawToGaussianByLocator()

Id gstlrn::AAnam::rawToGaussianByLocator	(	Db *	db,
		const NamingConvention &	namconv = `NamingConvention("Y")`
	)

Process the variable(s) stored with locator Z

Parameters

db	Db structure
namconv	Naming Convention

Returns

◆ rawToTransformValue()

double gstlrn::AAnam::rawToTransformValue ( double z ) const

virtual

Reimplemented in gstlrn::AnamUser, gstlrn::AnamHermite, and gstlrn::AnamEmpirical.

◆ rawToTransformVec()

gstlrn::AAnam::rawToTransformVec ( const 1 & z ) const

◆ transformToRawValue()

double gstlrn::AAnam::transformToRawValue ( double y ) const

virtual

Reimplemented in gstlrn::AnamUser, gstlrn::AnamHermite, and gstlrn::AnamEmpirical.

◆ transformToRawVec()

gstlrn::AAnam::transformToRawVec ( const 1 & y ) const

◆ updatePointToBlock()

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

virtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, and gstlrn::AnamHermite.

◆ z2factor()

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

virtual

Reimplemented in gstlrn::AnamDiscreteDD, gstlrn::AnamDiscreteIR, and gstlrn::AnamHermite.

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

include/Anamorphosis/AAnam.hpp
src/Anamorphosis/AAnam.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AAnam() [1/2]

◆ AAnam() [2/2]

◆ ~AAnam()

Member Function Documentation

◆ allowChangeSupport()

◆ computeVariance()

◆ fit()

◆ fitFromArray()

◆ fitFromLocator()

◆ gaussianToRaw()

◆ gaussianToRawByLocator()

◆ getNClass()

◆ getNFactor()

◆ getType()

◆ getVariance()

◆ hasFactor()

◆ hasGaussian()

◆ invertVariance()

◆ isChangeSupportDefined()

◆ normalScore()

◆ operator=()

◆ rawToFactor()

◆ rawToFactorByRanks()

◆ rawToGaussian()

◆ rawToGaussianByLocator()

◆ rawToTransformValue()

◆ rawToTransformVec()

◆ transformToRawValue()

◆ transformToRawVec()

◆ updatePointToBlock()

◆ z2factor()