unienv_interface.space.spaces.union¶
Implementation of a space that represents the cartesian product of other spaces.
Classes:
| Name | Description |
|---|---|
UnionSpace |
|
UnionSpace
¶
UnionSpace(
backend: ComputeBackend[Any, BDeviceType, BDtypeType, BRNGType],
spaces: Iterable[Space[Any, BDeviceType, BDtypeType, BRNGType]],
device: Optional[BDeviceType] = None,
metadata: Optional[Mapping[str, Any]] = None,
)
Bases: Space[Tuple[int, Any], BDeviceType, BDtypeType, BRNGType]
Methods:
| Name | Description |
|---|---|
to |
|
sample |
|
create_empty |
Create an empty data structure for this space. |
is_bounded |
|
contains |
Return boolean specifying if x is a valid member of this space. |
clip |
Clip a union value |
get_repr |
|
is_subspaceeq |
Return whether this union space is a non-strict subspace of |
data_to |
|
with_metadata |
Return a copy of this space with updated metadata (this space is left unchanged). |
is_subspace |
Return whether this space is a STRICT subspace of |
abbr_device |
Return the shared device across spaces, or |
Attributes:
| Name | Type | Description |
|---|---|---|
spaces |
|
|
device |
Optional[_SpaceBDeviceT]
|
|
metadata |
SpaceMetadata
|
Read-only description of the data (see "Metadata" in the class docstring); empty if none was given. |
shape |
tuple[int, ...] | None
|
Return the shape of the space as an immutable property. |
spaces
instance-attribute
¶
metadata
property
¶
metadata: SpaceMetadata
Read-only description of the data (see "Metadata" in the class docstring); empty if none was given.
shape
property
¶
Return the shape of the space as an immutable property.
contains
¶
Return boolean specifying if x is a valid member of this space.
clip
¶
Clip a union value (index, value) with the alternative at index (see Space.clip).
A superset union has the same number of alternatives, each a superset
of the alternative at the same index here, so the index is kept and
only the value is clipped. Raises ValueError if x is not an
(index, value) pair with a valid index.
get_repr
¶
get_repr(
abbreviate: bool = False,
include_backend=True,
include_device=True,
include_dtype=True,
)
is_subspaceeq
¶
Return whether this union space is a non-strict subspace of other (⊆).
Kept simple: True iff other is a UnionSpace on the same backend
with the same number of alternatives and, for every index i,
self.spaces[i].is_subspaceeq(other.spaces[i]) holds (pairwise,
same-index recursion). This is a conservative structural check — it
does not attempt to reason about alternative reordering or set-union
semantics. device is ignored.
with_metadata
¶
with_metadata(
metadata: Optional[Mapping[str, Any]] = None,
/,
*,
replace: bool = False,
**updates: Any,
) -> Space[SpaceDataT, _SpaceBDeviceT, _SpaceBDTypeT, _SpaceBDRNGT]
Return a copy of this space with updated metadata (this space is left unchanged).
metadata and updates are merged into the current metadata, or
replace it entirely with replace=True (space.with_metadata(replace=True)
clears it). Nested spaces are shared with this space, not copied.
is_subspace
¶
is_subspace(other: Space) -> bool
Return whether this space is a STRICT subspace of other (self ⊂ other).
Defined uniformly for all spaces as::
self.is_subspace(other) ⟺ self.is_subspaceeq(other) and not other.is_subspaceeq(self)
I.e. self ⊆ other holds but other ⊆ self does not, so self
is a PROPER (strict) subspace of other. This is the ⊂ relation
versus the non-strict ⊆ provided by :meth:is_subspaceeq.
This definition is used instead of relying on __eq__ because some
space classes only have identity __eq__; defining strict
containment via the symmetric non-strict check works uniformly for all
classes regardless of their __eq__ implementation.
For structurally-distinct-but-mutually-containing spaces (which should
not occur under the strict dtype/shape policies enforced by the
per-class is_subspaceeq implementations) this degrades gracefully
to False: if both self.is_subspaceeq(other) and
other.is_subspaceeq(self) hold, the two spaces are considered
equivalent and neither is a STRICT subspace of the other.
If either side's is_subspaceeq is not implemented (the base
:meth:is_subspaceeq raises NotImplementedError), the exception
propagates to the caller — it is NOT swallowed into False so that
callers can tell that the comparison is unsupported.
Note: controller-required-space checks should typically use
:meth:is_subspaceeq (a controller's required space may exactly equal
the env space, in which case the strict is_subspace would return
False).