Null¶
- class Null(*args)¶
Null history storage strategy.
See also
Notes
The null strategy does not store anything.
Methods
clear
()Clear the stored points.
Accessor to the object's name.
getName
()Accessor to the object's name.
Accessor to the stored sample.
hasName
()Test if the object is named.
setDimension
(dimension)Set the dimension of points to store.
setName
(name)Accessor to the object's name.
store
(*args)Store points or samples.
- __init__(*args)¶
- clear()¶
Clear the stored points.
Notes
It erases the previously stored points
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getSample()¶
Accessor to the stored sample.
- Returns:
- sample
Sample
Numerical sample which is the collection of points stored by the history strategy.
- sample
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- setDimension(dimension)¶
Set the dimension of points to store.
This method must be called before calling the store method.
- Parameters:
- dimension: int
Dimension of points to store
Notes
It erases the previously stored points
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- store(*args)¶
Store points or samples.
- Parameters:
- datasequence of float or 2-d sequence of float
Point or sample to store.
Notes
It adds a unique point or all the point of the sample in the natural order to the history.
Examples using the class¶
Specify a simulation algorithm