Template Class FrozenLake

Inheritance Relationships

Base Type

  • public bitrl::envs::gymnasium::ToyTextEnvBase< TimeStep< uint_t >, frozenlake_state_size< side_size >::size, 3 > (Template Class ToyTextEnvBase)

Class Documentation

template<uint_t side_size>
class FrozenLake : public bitrl::envs::gymnasium::ToyTextEnvBase<TimeStep<uint_t>, frozenlake_state_size<side_size>::size, 3>

The FrozenLake class. Wrapper to Gymnasium FrozenLake environment.

Public Types

typedef std::vector<std::tuple<real_t, uint_t, real_t, bool>> dynamics_t

dynamics_t

typedef ToyTextEnvBase<TimeStep<uint_t>, frozenlake_state_size<side_size>::size, 3>::base_type base_type

The base type.

typedef base_type::time_step_type time_step_type

The time step type we return every time a step in the environment is performed.

typedef base_type::state_space_type state_space_type

The type describing the state space for the environment.

typedef base_type::action_space_type action_space_type

The type of the action space for the environment.

typedef base_type::action_type action_type

The type of the action to be undertaken in the environment.

typedef base_type::state_type state_type

The type of the action to be undertaken in the environment.

Public Functions

FrozenLake(const RESTApiServerWrapper &api_server)

Constructor.

FrozenLake(const RESTApiServerWrapper &api_server, const uint_t cidx, bool slippery)

Constructor.

FrozenLake(const FrozenLake &other)

copy constructor

~FrozenLake() = default

~FrozenLake. Destructor.

virtual void make(const std::string &version, const std::unordered_map<std::string, std::any> &options) final override

make. Builds the environment. Optionally we can choose if the environment will be slippery

virtual time_step_type step(const action_type &action) final override

Step in the environment following the given action.

FrozenLake<side_size> make_copy(uint_t cidx) const

Create a new copy of the environment with the given copy index.

inline std::string map_type() const noexcept

map_type

Returns:

inline bool is_slippery() const noexcept

is_slipery

Returns:

Public Static Attributes

static const std::string name = "FrozenLake"

name

static const std::string URI = "/gymnasium/frozen-lake-env"

The URI for accessing the environment.

Protected Functions

virtual time_step_type create_time_step_from_response_(const nlohmann::json &response) const final override

build the dynamics from response

Handle the reset response from the environment server