BasisSequenceFactory

class BasisSequenceFactory(*args)

Basis sequence factory.

Available constructors:

BasisSequenceFactory(basisSeqFacImp)

Parameters

basisSeqFacImpa BasisSequenceFactoryImplementation

See also

LARS

Notes

BasisSequenceFactory is the interface of the BasisSequenceFactoryImplementation. This class is not usable because it has sense only whithin the FunctionalChaosAlgorithm.

Methods

build(self, x, y, psi, indices)	Run the algorithm.
getClassName(self)	Accessor to the object’s name.
getId(self)	Accessor to the object’s id.
getImplementation(self)	Accessor to the underlying implementation.
getMaximumRelativeConvergence(self)	Accessor to the stopping criterion on the L1-norm of the coefficients.
getName(self)	Accessor to the object’s name.
getVerbose(self)	Accessor to the verbosity.
setMaximumRelativeConvergence(self, …)	Accessor to the stopping criterion on the L1-norm of the coefficients.
setName(self, name)	Accessor to the object’s name.
setVerbose(self, verbose)	Accessor to the verbosity.

__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

build(self, x, y, psi, indices)

Run the algorithm.

Parameters

x2-d sequence of float

Input sample

y2-d sequence of float

Output sample

psisequence of Function

Basis

indicessequence of int

Current indices of the basis

Returns

measureBasisSequence

Fitting measure

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

The object class name (object.__class__.__name__).

getId(self)

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getImplementation(self)

Accessor to the underlying implementation.

Returns

implImplementation

The implementation class.

getMaximumRelativeConvergence(self)

Accessor to the stopping criterion on the L1-norm of the coefficients.

Returns

efloat

Stopping criterion.

getName(self)

Accessor to the object’s name.

Returns

namestr

The name of the object.

getVerbose(self)

Accessor to the verbosity.

Returns

vbool.

Verbosity

setMaximumRelativeConvergence(self, coefficientsPaths)

Accessor to the stopping criterion on the L1-norm of the coefficients.

Parameters

efloat

Stopping criterion.

setName(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setVerbose(self, verbose)

Accessor to the verbosity.

Parameters

vbool

Enable or disable the verbosity.