ApproximationAlgorithm

class ApproximationAlgorithm(*args)

Approximation algorithm.

See also

LeastSquaresStrategy, ApproximationAlgorithmImplementationFactory, LeastSquaresMetaModelSelectionFactory

Notes

The ApproximationAlgorithm is built from an approximation algorithm implementation factory which is a ApproximationAlgorithmImplementationFactory or a LeastSquaresMetaModelSelectionFactory.

This class is not usable because it has sense only whithin the FunctionalChaosAlgorithm.

Methods

getClassName() Accessor to the object’s name.
getCoefficients() Accessor to the coefficients.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getName() Accessor to the object’s name.
getPsi() Accessor to the basis.
getRelativeError() Accessor to the coefficients.
getResidual() Accessor to the coefficients.
getVerbose() Accessor to the verbosity flag.
getWeight() Accessor to the weights.
getX() Accessor to the input sample.
getY() Accessor to the output sample.
run() Run the algorithm.
setName(name) Accessor to the object’s name.
setVerbose(verbose) Accessor to the verbosity flag.
__init__(*args)
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getCoefficients()

Accessor to the coefficients.

Returns:

coefficients : NumericalPoint

The coefficients

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.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getPsi()

Accessor to the basis.

Returns:

coefficients : Basis

The basis

getRelativeError()

Accessor to the coefficients.

Returns:

relativeError : float

The relative error

getResidual()

Accessor to the coefficients.

Returns:

coefficients : float

The residual

getVerbose()

Accessor to the verbosity flag.

Returns:

v : bool.

Verbosity

getWeight()

Accessor to the weights.

Returns:

weight : NumericalPoint

Output weights

getX()

Accessor to the input sample.

Returns:

x : NumericalSample

Input sample

getY()

Accessor to the output sample.

Returns:

y : NumericalSample

Input sample

run()

Run the algorithm.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setVerbose(verbose)

Accessor to the verbosity flag.

Parameters:

v : bool

Enable or disable the verbosity.