PenalizedLeastSquaresAlgorithmFactory

class PenalizedLeastSquaresAlgorithmFactory(*args)

Penalized least squares algorithm factory.

Available constructors:

PenalizedLeastSquaresAlgorithmFactory()

See also

ApproximationAlgorithm, LeastSquaresMetaModelSelectionFactory

Notes

Implementation of an approximation algorithm implementation factory which builds an ApproximationAlgorithm.

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

Methods

getClassName()	Accessor to the object's name.
getId()	Accessor to the object's id.
getName()	Accessor to the object's name.
getShadowedId()	Accessor to the object's shadowed id.
getVisibility()	Accessor to the object's visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setName(name)	Accessor to the object's name.
setShadowedId(id)	Accessor to the object's shadowed id.
setVisibility(visible)	Accessor to the object's visibility state.

build

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleNamebool

True if the name is not empty and not the default one.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visiblebool

Visibility flag.

Examples using the class

Compute leave-one-out error of a polynomial chaos expansion

Compute leave-one-out error of a polynomial chaos expansion