ProjectionStrategy

class ProjectionStrategy(*args)

Base class for the evaluation strategies of the approximation coefficients.

Available constructors:

ProjectionStrategy(projectionStrategy)

Parameters:
projectionStrategyProjectionStrategy

A projection strategy which is a LeastSquaresStrategy or an IntegrationStrategy.

Methods

getClassName()

Accessor to the object's name.

getCoefficients()

Accessor to the coefficients.

getDesignProxy()

Accessor to the design proxy.

getExperiment()

Accessor to the experiments.

getId()

Accessor to the object's id.

getImplementation()

Accessor to the underlying implementation.

getInputSample()

Accessor to the input sample.

getMeasure()

Accessor to the measure.

getName()

Accessor to the object's name.

getOutputSample()

Accessor to the output sample.

getRelativeError()

Accessor to the relative error.

getResidual()

Accessor to the residual.

getWeights()

Accessor to the weights.

involvesModelSelection()

Get the model selection flag.

isLeastSquares()

Get the least squares flag.

setExperiment(weightedExperiment)

Accessor to the design of experiment.

setInputSample(inputSample)

Accessor to the input sample.

setMeasure(measure)

Accessor to the measure.

setName(name)

Accessor to the object's name.

setOutputSample(outputSample)

Accessor to the output sample.

setWeights(weights)

Accessor to the weights.

Notes

This class is used in the functional chaos expansion context implemented in the class FunctionalChaosAlgorithm. It is not usable outside this context.

The model is approximated by the meta model defined in Functional Chaos Expansion by equation (5) and the coefficients (a_k)_{k \in I_n} are computed by:

__init__(*args)
getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getCoefficients()

Accessor to the coefficients.

Returns:
coefPoint

Coefficients (\alpha_k)_{k \in I_n}.

getDesignProxy()

Accessor to the design proxy.

Parameters:
designProxyDesignProxy

The design matrix.

getExperiment()

Accessor to the experiments.

Returns:
expWeightedExperiment

Weighted experiment used to evaluate the coefficients.

getId()

Accessor to the object’s id.

Returns:
idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns:
implImplementation

A copy of the underlying implementation object.

getInputSample()

Accessor to the input sample.

Returns:
XSample

Input Sample.

getMeasure()

Accessor to the measure.

Returns:
muDistribution

Measure \mu_{\inputRV} defining the inner product.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getOutputSample()

Accessor to the output sample.

Returns:
YSample

Output Sample.

getRelativeError()

Accessor to the relative error.

Returns:
efloat

Relative error.

getResidual()

Accessor to the residual.

Returns:
erfloat

Residual error.

getWeights()

Accessor to the weights.

Returns:
wPoint

Weights of the design of experiments.

involvesModelSelection()

Get the model selection flag.

A model selection method can be used to select the coefficients of the decomposition which enable to best predict the output. Model selection can lead to a sparse functional chaos expansion.

Returns:
involvesModelSelectionbool

True if the method involves a model selection method.

isLeastSquares()

Get the least squares flag.

There are two methods to compute the coefficients: integration or least squares.

Returns:
isLeastSquaresbool

True if the coefficients are estimated from least squares.

setExperiment(weightedExperiment)

Accessor to the design of experiment.

Parameters:
expWeightedExperiment

Weighted design of experiment.

setInputSample(inputSample)

Accessor to the input sample.

Parameters:
XSample

Input Sample.

setMeasure(measure)

Accessor to the measure.

Parameters:
mDistribution

Measure \mu_{\inputRV} defining the scalar product.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setOutputSample(outputSample)

Accessor to the output sample.

Parameters:
YSample

Output Sample.

setWeights(weights)

Accessor to the weights.

Parameters:
wPoint

Weights of the design of experiments.