#include <mountain_car_env.h>

Inheritance diagram for bitrl::envs::gymnasium::MountainCar:

[legend]

Collaboration diagram for bitrl::envs::gymnasium::MountainCar:

[legend]

Public Types
typedef GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >::base_type	base_type
	Base class 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 state.

Public Types inherited from bitrl::envs::gymnasium::GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >
typedef EnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >	base_type
	Base environment type alias.

typedef base_type::time_step_type	time_step_type
	Time step returned at each environment step.

typedef base_type::state_space_type	state_space_type
	Type describing the observation/state space of the environment.

typedef base_type::action_space_type	action_space_type
	Type describing the action space of the environment.

typedef base_type::action_type	action_type
	Type representing a valid action to execute.

typedef base_type::state_type	state_type
	Type representing a state/observation returned by the environment.

Public Types inherited from bitrl::envs::EnvBase< TimeStepType, SpaceType >
typedef TimeStepType	time_step_type
	Alias for the type returned when stepping the environment.

typedef SpaceType::state_space	state_space_type
	Type describing the environment state space.

typedef SpaceType::state_type	state_type
	Type describing an individual state.

typedef SpaceType::action_space	action_space_type
	Type describing the environment action space.

typedef SpaceType::action_type	action_type
	Type representing an individual action.

Public Member Functions
	MountainCar (network::RESTRLEnvClient &api_server)
	MountainCar. Constructor. Creates an environment.

	MountainCar (const MountainCar &other)
	copy ctor

	~MountainCar () override=default
	~MountainCar. Destructor.

virtual void	make (const std::string &version, const std::unordered_map< std::string, std::any > &options, const std::unordered_map< std::string, std::any > &reset_options) override final
	make. Build the environment

virtual time_step_type	step (const action_type &action) override final
	step

uint_t	n_actions () const noexcept
	n_actions. Returns the number of actions

Public Member Functions inherited from bitrl::envs::gymnasium::GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >
virtual	~GymnasiumEnvBase ()
	Virtual destructor.

virtual bool	is_alive () const
	Check whether the environment is still alive/connected.

virtual void	close () override
	Close the environment on the server and release any resources.

virtual time_step_type	reset () override
	Reset the environment to an initial state using the reset options specified during make.

virtual time_step_type	reset ()=0
	Import the reset() overloads from the base class.

uint_t	n_copies () const

network::RESTRLEnvClient &	get_api_server () const
	Retrieve the REST API wrapper instance used for communication.

std::string	get_url () const
	Get the full URL for this environment endpoint on the server.

Public Member Functions inherited from bitrl::envs::EnvBase< TimeStepType, SpaceType >
virtual	~EnvBase ()=default
	Virtual destructor.

virtual time_step_type	step (const action_type &action)=0
	Perform one step in the environment using an action.

const std::unordered_map< std::string, std::any > &	make_options () const noexcept
	Access the configuration options provided to make().

const std::unordered_map< std::string, std::any > &	reset_options () const noexcept
	Access the configuration options provided to make().

template<typename T >
T	read_option (const std::string &op_name) const
	Read a specific make() option and cast it to the requested type.

std::string	idx () const noexcept
	Get the id identifying this environment within a simulation batch. The id is valid only if make has been called.

bool	is_created () const noexcept
	Check if make() has successfully initialized the environment.

std::string	env_name () const noexcept
	Get the name of this environment instance.

std::string	version () const noexcept
	Get the environment version set during make().

Static Public Attributes
static const std::string	name = "MountainCar"
	name

static const std::string	URI = "/gymnasium/mountain-car-env"
	The URI for accessing the environment.

Static Public Attributes inherited from bitrl::envs::EnvBase< TimeStepType, SpaceType >
static const uint_t	DEFAULT_ENV_SEED = 42
	Default seed used in reset() if none provided.

Protected Member Functions
virtual time_step_type	create_time_step_from_response_ (const nlohmann::json &response) const override final
	Handle the reset response from the environment server.

Protected Member Functions inherited from bitrl::envs::gymnasium::GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >
	GymnasiumEnvBase (network::RESTRLEnvClient &api_server, const std::string &name)
	Constructor.

	GymnasiumEnvBase (const GymnasiumEnvBase &)
	Copy constructor.

Protected Member Functions inherited from bitrl::envs::EnvBase< TimeStepType, SpaceType >
	EnvBase (const std::string &idx=bitrl::consts::INVALID_STR, const std::string &name=bitrl::consts::INVALID_STR)
	Constructor (protected — for subclassing only).

	EnvBase (const EnvBase &)
	Copy constructor.

void	set_version_ (const std::string &version) noexcept
	Set internal version string.

void	set_idx_ (const std::string &idx) noexcept
	Set the id of the environment.

void	set_make_options_ (const std::unordered_map< std::string, std::any > &options) noexcept
	Store options for future access.

void	set_reset_options_ (const std::unordered_map< std::string, std::any > &options) noexcept
	Store reset options for future access.

void	invalidate_is_created_flag_ () noexcept
	Mark environment as not created.

void	make_created_ () noexcept
	Mark environment creation as successful.

time_step_type &	get_current_time_step_ () noexcept
	Mutable access to the current time step.

const time_step_type &	get_current_time_step_ () const noexcept
	Read-only access to the current time step.

Additional Inherited Members
Protected Attributes inherited from bitrl::envs::gymnasium::GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >
network::RESTRLEnvClient *	api_server_
	Server wrapper handling communication with remote Gymnasium environment.

Detailed Description

The MountainCar class.

Member Typedef Documentation

◆ action_space_type

typedef base_type::action_space_type bitrl::envs::gymnasium::MountainCar::action_space_type

The type of the action space for the environment.

◆ action_type

typedef base_type::action_type bitrl::envs::gymnasium::MountainCar::action_type

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

◆ base_type

typedef GymnasiumEnvBase<TimeStep<std::vector<real_t>>,ContinuousVectorStateDiscreteActionEnv<3,2,0,real_t>>::base_type bitrl::envs::gymnasium::MountainCar::base_type

Base class type.

◆ state_space_type

typedef base_type::state_space_type bitrl::envs::gymnasium::MountainCar::state_space_type

The type describing the state space for the environment.

◆ state_type

typedef base_type::state_type bitrl::envs::gymnasium::MountainCar::state_type

The type of the state.

◆ time_step_type

typedef base_type::time_step_type bitrl::envs::gymnasium::MountainCar::time_step_type

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

Constructor & Destructor Documentation

◆ MountainCar() [1/2]

bitrl::envs::gymnasium::MountainCar::MountainCar ( network::RESTRLEnvClient & api_server )

MountainCar. Constructor. Creates an environment.

Parameters

version	The version of the environment
gym_namespace	The boost::python open-ai gym namespace
do_create	If true it calls make

◆ MountainCar() [2/2]

bitrl::envs::gymnasium::MountainCar::MountainCar ( const MountainCar & other )

copy ctor

◆ ~MountainCar()

bitrl::envs::gymnasium::MountainCar::~MountainCar ( )

overridedefault

~MountainCar. Destructor.

Member Function Documentation

◆ create_time_step_from_response_()

MountainCar::time_step_type bitrl::envs::gymnasium::MountainCar::create_time_step_from_response_ ( const nlohmann::json & response ) const

finaloverrideprotectedvirtual

Handle the reset response from the environment server.

Implements bitrl::envs::gymnasium::GymnasiumEnvBase< TimeStep< std::vector< real_t > >, ContinuousVectorStateDiscreteActionEnv< 3, 2, 0, real_t > >.

◆ make()

void bitrl::envs::gymnasium::MountainCar::make	(	const std::string &	version,
		const std::unordered_map< std::string, std::any > &	options,
		const std::unordered_map< std::string, std::any > &	reset_options
	)

finaloverridevirtual

make. Build the environment

Implements bitrl::envs::EnvBase< TimeStepType, SpaceType >.

◆ n_actions()

uint_t bitrl::envs::gymnasium::MountainCar::n_actions ( ) const

inlinenoexcept

n_actions. Returns the number of actions

◆ step()

MountainCar::time_step_type bitrl::envs::gymnasium::MountainCar::step ( const action_type & action )

finaloverridevirtual

step

Member Data Documentation

◆ name

const std::string bitrl::envs::gymnasium::MountainCar::name = "MountainCar"

static

name

◆ URI

const std::string bitrl::envs::gymnasium::MountainCar::URI = "/gymnasium/mountain-car-env"