BasisSequenceFactory

class BasisSequenceFactory(*args)

Basis sequence factory.

Available constructors:
BasisSequenceFactory(basisSeqFacImp)
Parameters:
basisSeqFacImp : a 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.

Attributes:
thisown

The membership flag

Methods

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

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

build(x, y, psi, indices)

Run the algorithm.

Parameters:
x : 2-d sequence of float

Input sample

y : 2-d sequence of float

Output sample

psi : sequence of Function

Basis

indices : sequence of int

Current indices of the basis

Returns:
measure : BasisSequence

Fitting measure

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

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

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:
impl : Implementation

The implementation class.

getMaximumRelativeConvergence()

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

Returns:
e : float

Stopping criterion.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

getVerbose()

Accessor to the verbosity.

Returns:
v : bool.

Verbosity

setMaximumRelativeConvergence(coefficientsPaths)

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

Parameters:
e : float

Stopping criterion.

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

setVerbose(verbose)

Accessor to the verbosity.

Parameters:
v : bool

Enable or disable the verbosity.

thisown

The membership flag