mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-07-31 22:04:31 +00:00
e913bc81b8
* feat: add `isort` to `pre-commit` * ci: skip `__init__.py` file for `isort` * ci: make `isort` mandatory in lint pipeline * docs: add a section on Git hooks * ci: check isort diff * fix: isort from master branch * docs: add pre-commit badge * ci: update black + bandit versions * feat: add PR template * refactor: PR template * ci: remove bandit * docs: add Black badge * ci: try to remove all `|| true` statements * ci: remove lint_python job - Remove `lint_python` CI job - Move `pyupgrade` job to `pre-commit` workflow * fix: avoid messing with typing * docs: add a note on running `pre-cpmmit` manually * ci: apply `pre-commit` to the whole codebase
67 lines
1.8 KiB
Python
67 lines
1.8 KiB
Python
from typing import Optional
|
|
|
|
import numpy as np
|
|
|
|
from .space import Space
|
|
|
|
|
|
class Discrete(Space[int]):
|
|
r"""A discrete space in :math:`\{ 0, 1, \\dots, n-1 \}`.
|
|
|
|
A start value can be optionally specified to shift the range
|
|
to :math:`\{ a, a+1, \\dots, a+n-1 \}`.
|
|
|
|
Example::
|
|
|
|
>>> Discrete(2) # {0, 1}
|
|
>>> Discrete(3, start=-1) # {-1, 0, 1}
|
|
|
|
"""
|
|
|
|
def __init__(self, n: int, seed: Optional[int] = None, start: int = 0):
|
|
assert n > 0, "n (counts) have to be positive"
|
|
assert isinstance(start, (int, np.integer))
|
|
self.n = int(n)
|
|
self.start = int(start)
|
|
super().__init__((), np.int64, seed)
|
|
|
|
def sample(self) -> int:
|
|
return int(self.start + self.np_random.integers(self.n))
|
|
|
|
def contains(self, x) -> bool:
|
|
if isinstance(x, int):
|
|
as_int = x
|
|
elif isinstance(x, (np.generic, np.ndarray)) and (
|
|
x.dtype.char in np.typecodes["AllInteger"] and x.shape == ()
|
|
):
|
|
as_int = int(x) # type: ignore
|
|
else:
|
|
return False
|
|
return self.start <= as_int < self.start + self.n
|
|
|
|
def __repr__(self) -> str:
|
|
if self.start != 0:
|
|
return "Discrete(%d, start=%d)" % (self.n, self.start)
|
|
return "Discrete(%d)" % self.n
|
|
|
|
def __eq__(self, other) -> bool:
|
|
return (
|
|
isinstance(other, Discrete)
|
|
and self.n == other.n
|
|
and self.start == other.start
|
|
)
|
|
|
|
def __setstate__(self, state):
|
|
super().__setstate__(state)
|
|
|
|
# Don't mutate the original state
|
|
state = dict(state)
|
|
|
|
# Allow for loading of legacy states.
|
|
# See https://github.com/openai/gym/pull/2470
|
|
if "start" not in state:
|
|
state["start"] = 0
|
|
|
|
# Update our state
|
|
self.__dict__.update(state)
|