BasisSequenceFactory¶
-
class
BasisSequenceFactory
(*args)¶ Basis sequence factory.
- Available constructors:
BasisSequenceFactory(basisSeqFacImp)
- Parameters
- basisSeqFacImpa BasisSequenceFactoryImplementation
See also
Notes
BasisSequenceFactory is the interface of the BasisSequenceFactoryImplementation. This class is not usable because it has sense only whithin the
FunctionalChaosAlgorithm
.Methods
build
(x, y, psi, indices)Run the algorithm.
Accessor to the object’s name.
getId
()Accessor to the object’s id.
Accessor to the underlying implementation.
Accessor to the stopping criterion on the L1-norm of the coefficients.
getName
()Accessor to the object’s name.
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
- x2-d sequence of float
Input sample
- y2-d sequence of float
Output sample
- psisequence of
Function
Basis
- indicessequence of int
Current indices of the basis
- Returns
- measure
BasisSequence
Fitting measure
- measure
-
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.
-
getImplementation
()¶ Accessor to the underlying implementation.
- Returns
- implImplementation
The implementation class.
-
getMaximumRelativeConvergence
()¶ Accessor to the stopping criterion on the L1-norm of the coefficients.
- Returns
- efloat
Stopping criterion.
-
getName
()¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getVerbose
()¶ Accessor to the verbosity.
- Returns
- vbool.
Verbosity
-
setMaximumRelativeConvergence
(coefficientsPaths)¶ Accessor to the stopping criterion on the L1-norm of the coefficients.
- Parameters
- efloat
Stopping criterion.
-
setName
(name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setVerbose
(verbose)¶ Accessor to the verbosity.
- Parameters
- vbool
Enable or disable the verbosity.