# {py:mod}`evorl.envs.space`

```{py:module} evorl.envs.space
```

```{autodoc2-docstring} evorl.envs.space
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Box <evorl.envs.space.Box>`
  - ```{autodoc2-docstring} evorl.envs.space.Box
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Discrete <evorl.envs.space.Discrete>`
  - ```{autodoc2-docstring} evorl.envs.space.Discrete
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Space <evorl.envs.space.Space>`
  - ```{autodoc2-docstring} evorl.envs.space.Space
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`SpaceContainer <evorl.envs.space.SpaceContainer>`
  - ```{autodoc2-docstring} evorl.envs.space.SpaceContainer
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`is_leaf_space <evorl.envs.space.is_leaf_space>`
  - ```{autodoc2-docstring} evorl.envs.space.is_leaf_space
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} Box
:canonical: evorl.envs.space.Box

Bases: {py:obj}`evorl.envs.space.Space`

```{autodoc2-docstring} evorl.envs.space.Box
:parser: autodoc2_docstrings_parser
```

````{py:method} contains(x: chex.Array) -> chex.Array
:canonical: evorl.envs.space.Box.contains

````

````{py:attribute} high
:canonical: evorl.envs.space.Box.high
:type: chex.Array
:value: >
   None

```{autodoc2-docstring} evorl.envs.space.Box.high
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} low
:canonical: evorl.envs.space.Box.low
:type: chex.Array
:value: >
   None

```{autodoc2-docstring} evorl.envs.space.Box.low
:parser: autodoc2_docstrings_parser
```

````

````{py:method} sample(key: chex.PRNGKey) -> chex.Array
:canonical: evorl.envs.space.Box.sample

````

````{py:property} shape
:canonical: evorl.envs.space.Box.shape
:type: chex.Shape

````

`````

`````{py:class} Discrete
:canonical: evorl.envs.space.Discrete

Bases: {py:obj}`evorl.envs.space.Space`

```{autodoc2-docstring} evorl.envs.space.Discrete
:parser: autodoc2_docstrings_parser
```

````{py:method} contains(x: chex.Array) -> chex.Array
:canonical: evorl.envs.space.Discrete.contains

````

````{py:attribute} n
:canonical: evorl.envs.space.Discrete.n
:type: int
:value: >
   None

```{autodoc2-docstring} evorl.envs.space.Discrete.n
:parser: autodoc2_docstrings_parser
```

````

````{py:method} sample(key: chex.PRNGKey) -> chex.Array
:canonical: evorl.envs.space.Discrete.sample

````

````{py:property} shape
:canonical: evorl.envs.space.Discrete.shape
:type: chex.Shape

````

`````

`````{py:class} Space
:canonical: evorl.envs.space.Space

Bases: {py:obj}`evorl.types.PyTreeData`

```{autodoc2-docstring} evorl.envs.space.Space
:parser: autodoc2_docstrings_parser
```

````{py:method} contains(x: chex.Array) -> bool
:canonical: evorl.envs.space.Space.contains
:abstractmethod:

```{autodoc2-docstring} evorl.envs.space.Space.contains
:parser: autodoc2_docstrings_parser
```

````

````{py:method} sample(key: chex.PRNGKey) -> chex.Array
:canonical: evorl.envs.space.Space.sample
:abstractmethod:

```{autodoc2-docstring} evorl.envs.space.Space.sample
:parser: autodoc2_docstrings_parser
```

````

````{py:property} shape
:canonical: evorl.envs.space.Space.shape
:abstractmethod:
:type: chex.Shape

```{autodoc2-docstring} evorl.envs.space.Space.shape
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} SpaceContainer
:canonical: evorl.envs.space.SpaceContainer

Bases: {py:obj}`evorl.envs.space.Space`

```{autodoc2-docstring} evorl.envs.space.SpaceContainer
:parser: autodoc2_docstrings_parser
```

````{py:method} contains(data: chex.ArrayTree) -> chex.ArrayTree
:canonical: evorl.envs.space.SpaceContainer.contains

````

````{py:method} sample(key: chex.PRNGKey) -> chex.ArrayTree
:canonical: evorl.envs.space.SpaceContainer.sample

````

````{py:property} shape
:canonical: evorl.envs.space.SpaceContainer.shape
:type: chex.ArrayTree

````

````{py:attribute} spaces
:canonical: evorl.envs.space.SpaceContainer.spaces
:type: chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.envs.space.SpaceContainer.spaces
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:function} is_leaf_space(space)
:canonical: evorl.envs.space.is_leaf_space

```{autodoc2-docstring} evorl.envs.space.is_leaf_space
:parser: autodoc2_docstrings_parser
```
````