simple_cache module¶
Caching module to store only one entry.
- class gemseo.caches.simple_cache.SimpleCache(tolerance=0.0, name=None)[source]¶
Bases:
AbstractCache
Dictionary-based cache storing a unique entry.
- Parameters:
tolerance (float) –
The tolerance below which two input arrays are considered equal:
norm(new_array-cached_array)/(1+norm(cached_array)) <= tolerance
. If this is the case for all the input names, then the cached output data shall be returned rather than re-evaluating the discipline. This tolerance could be useful to optimize CPU time. It could be something like2 * numpy.finfo(float).eps
.By default it is set to 0.0.
name (str) – A name for the cache. If
None
, use the class name.
- export_to_dataset(name=None, by_group=True, categorize=True, input_names=None, output_names=None)¶
Build a
Dataset
from the cache.- Parameters:
name (str | None) – A name for the dataset. If
None
, use the name of the cache.by_group (bool) –
Whether to store the data by group in
Dataset.data
, in the sense of one unique NumPy array per group. Ifcategorize
isFalse
, there is a unique group:Dataset.PARAMETER_GROUP`
. Ifcategorize
isTrue
, the groups are stored inDataset.INPUT_GROUP
andDataset.OUTPUT_GROUP
. Ifby_group
isFalse
, store the data by variable names.By default it is set to True.
categorize (bool) –
Whether to distinguish between the different groups of variables. Otherwise, group all the variables in
Dataset.PARAMETER_GROUP`
.By default it is set to True.
input_names (Iterable[str] | None) – The names of the inputs to be exported. If
None
, use all the inputs.output_names (Iterable[str] | None) – The names of the outputs to be exported. If
None
, use all the outputs. If an output name is also an input name, the output name is suffixed with[out]
.
- Returns:
A dataset version of the cache.
- Return type:
- get(k[, d]) D[k] if k in D, else d. d defaults to None. ¶
- items() a set-like object providing a view on D's items ¶
- keys() a set-like object providing a view on D's keys ¶
- values() an object providing a view on D's values ¶
- property last_entry: CacheEntry¶
The last cache entry.