gemd.entity.bounds.base_bounds module
Base class for all bounds.
- class gemd.entity.bounds.base_bounds.BaseBounds
Bases:
DictSerializableBase class for bounds, including RealBounds and CategoricalBounds.
- typ
alias of
NotImplementedError
- as_dict() Dict[str, Any]
Convert the object to a dictionary.
- Returns
A dictionary representation of the object, where the keys are its fields.
- Return type
dict
- static build(d: Mapping[str, Any]) DictSerializableType
Build an object from a JSON dictionary.
This differs from from_dict in that the values themselves may also be dictionaries corresponding to serialized DictSerializable objects.
- Parameters
d (dict) – The object as a serialized dictionary.
- Returns
The deserialized object.
- Return type
- abstract contains(bounds: Union[BaseBoundsType, BaseValueType])
Check if another bounds is contained within this bounds.
- Parameters
bounds (BaseBounds or BaseValue) – Other bounds object to check. If it’s a Value object, check against the smallest compatible bounds, as returned by the Value’s
_to_bounds()method.- Returns
True if all values valid for bounds are also valid for this object
- Return type
bool
- dump() Dict[str, Any]
Convert the object to a JSON dictionary, so that every entry is serialized.
Uses the json encoder client, so objects with uids are converted to LinkByUID dictionaries.
- Returns
A string representation of the object as a dictionary.
- Return type
str
- classmethod from_dict(d: Mapping[str, Any]) DictSerializableType
Reconstitute the object from a dictionary.
- Parameters
d (dict) – The object as a dictionary of key-value pairs that correspond to the object’s fields.
- Returns
The deserialized object.
- Return type
- abstract union(*others: Union[BaseBoundsType, BaseValueType]) BaseBoundsType
Return the union of this bounds and other bounds.
The others list must also be the same class (e.g., categorical, real…).
- Parameters
others (BaseBounds or BaseValue) – Other bounds or value objects to include. If they’re Value objects, increase by the smallest compatible bounds, as returned by the value’s
_to_bounds()method.- Returns
The union of this bounds and the passed bounds
- Return type
- abstract update(*others: Union[BaseBoundsType, BaseValueType])
Update this bounds to include other bounds.
The others list must also be the same class (e.g., categorical, real…).
- Parameters
others (BaseBounds or BaseValue) – Other bounds or value objects to include. If they’re Value objects, increase by the smallest compatible bounds, as returned by the value’s
_to_bounds()method.
- skip = {}