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(self)

Accessor to the object’s name.

getCoefficients(self)

Accessor to the coefficients.

getId(self)

Accessor to the object’s id.

getImplementation(self, \*args)

Accessor to the underlying implementation.

getName(self)

Accessor to the object’s name.

getPsi(self)

Accessor to the basis.

getRelativeError(self)

Accessor to the coefficients.

getResidual(self)

Accessor to the coefficients.

getVerbose(self)

Accessor to the verbosity flag.

getWeight(self)

Accessor to the weights.

getX(self)

Accessor to the input sample.

getY(self)

Accessor to the output sample.

run(self)

Run the algorithm.

setName(self, name)

Accessor to the object’s name.

setVerbose(self, verbose)

Accessor to the verbosity flag.

__init__(self, *args)

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

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

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

getCoefficients(self)

Accessor to the coefficients.

Returns
coefficientsPoint

The coefficients

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getImplementation(self, *args)

Accessor to the underlying implementation.

Returns
implImplementation

The implementation class.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getPsi(self)

Accessor to the basis.

Returns
coefficientsBasis

The basis

getRelativeError(self)

Accessor to the coefficients.

Returns
relativeErrorfloat

The relative error

getResidual(self)

Accessor to the coefficients.

Returns
coefficientsfloat

The residual

getVerbose(self)

Accessor to the verbosity flag.

Returns
vbool.

Verbosity

getWeight(self)

Accessor to the weights.

Returns
weightPoint

Output weights

getX(self)

Accessor to the input sample.

Returns
xSample

Input sample

getY(self)

Accessor to the output sample.

Returns
ySample

Input sample

run(self)

Run the algorithm.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setVerbose(self, verbose)

Accessor to the verbosity flag.

Parameters
vbool

Enable or disable the verbosity.