Implementation of Acrobot game. More...

Classes
class	State

Public Types
enum	Action { negativeTorque , zeroTorque , positiveTorque , size }

Public Member Functions
	Acrobot (const double gravity=9.81, const double linkLength1=1.0, const double linkLength2=1.0, const double linkMass1=1.0, const double linkMass2=1.0, const double linkCom1=0.5, const double linkCom2=0.5, const double linkMoi=1.0, const double maxVel1=4 M_PI, const double maxVel2=9 M_PI, const double dt=0.2, const double doneReward=0, const size_t maxSteps=0)
	Construct a Acrobot instance using the given constants. More...

arma::colvec	Dsdt (arma::colvec state, const double torque) const
	This is the ordinary differential equations required for estimation of nextState through RK4 method. More...

State	InitialSample ()
	This function does random initialization of state space. More...

bool	IsTerminal (const State &state) const
	This function checks if the acrobot has reached the terminal state. More...

size_t	MaxSteps () const
	Get the maximum number of steps allowed. More...

size_t &	MaxSteps ()
	Set the maximum number of steps allowed. More...

arma::colvec	Rk4 (const arma::colvec state, const double torque) const
	This function calls the RK4 iterative method to estimate the next state based on given ordinary differential equation. More...

double	Sample (const State &state, const Action &action, State &nextState)
	Dynamics of the Acrobot System. More...

double	Sample (const State &state, const Action &action)
	Dynamics of the Acrobot System. More...

size_t	StepsPerformed () const
	Get the number of steps performed. More...

double	Torque (const Action &action) const
	This function calculates the torque for a particular action. More...

double	Wrap (double value, const double minimum, const double maximum) const
	Wrap funtion is required to truncate the angle value from -180 to 180. More...

Detailed Description

Implementation of Acrobot game.

Acrobot is a 2-link pendulum with only the second joint actuated. Intitially, both links point downwards. The goal is to swing the end-effector at a height at least the length of one link above the base. Both links can swing freely and can pass by each other, i.e., they don't collide when they have the same angle.

Definition at line 28 of file acrobot.hpp.

Member Enumeration Documentation

◆ Action

enum Action

Enumerator
negativeTorque
zeroTorque
positiveTorque
size

Definition at line 88 of file acrobot.hpp.

Constructor & Destructor Documentation

◆ Acrobot()

Acrobot	(	const double	gravity = `9.81`,
		const double	linkLength1 = `1.0`,
		const double	linkLength2 = `1.0`,
		const double	linkMass1 = `1.0`,
		const double	linkMass2 = `1.0`,
		const double	linkCom1 = `0.5`,
		const double	linkCom2 = `0.5`,
		const double	linkMoi = `1.0`,
		const double	maxVel1 = `4 * M_PI`,
		const double	maxVel2 = `9 * M_PI`,
		const double	dt = `0.2`,
		const double	doneReward = `0`,
		const size_t	maxSteps = `0`
	)

inline

Construct a Acrobot instance using the given constants.

Parameters

gravity	The gravity parameter.
linkLength1	The length of link 1.
linkLength2	The length of link 2.
linkMass1	The mass of link 1.
linkMass2	The mass of link 2.
linkCom1	The position of the center of mass of link 1.
linkCom2	The position of the center of mass of link 2.
linkMoi	The moments of inertia for both links.
maxVel1	The max angular velocity of link1.
maxVel2	The max angular velocity of link2.
dt	The differential value.
doneReward	The reward recieved by the agent on success.
maxSteps	The number of steps after which the episode terminates. If the value is 0, there is no limit.

Definition at line 116 of file acrobot.hpp.

Member Function Documentation

◆ Dsdt()

arma::colvec Dsdt	(	arma::colvec	state,
		const double	torque
	)		const

inline

This is the ordinary differential equations required for estimation of nextState through RK4 method.

Parameters

state	Current State.
torque	The torque Applied.

Definition at line 243 of file acrobot.hpp.

References M_PI.

Referenced by Acrobot::Rk4().

◆ InitialSample()

State InitialSample ( )

inline

This function does random initialization of state space.

Definition at line 207 of file acrobot.hpp.

References Acrobot::State::State().

◆ IsTerminal()

bool IsTerminal ( const State & state ) const

inline

This function checks if the acrobot has reached the terminal state.

Parameters

state The current State.

Returns: true if state is a terminal state, otherwise false.

Definition at line 219 of file acrobot.hpp.

References Log::Info, Acrobot::State::Theta1(), and Acrobot::State::Theta2().

Referenced by Acrobot::Sample().

◆ MaxSteps() [1/2]

size_t MaxSteps ( ) const

inline

Get the maximum number of steps allowed.

Definition at line 344 of file acrobot.hpp.

◆ MaxSteps() [2/2]

size_t& MaxSteps ( )

inline

Set the maximum number of steps allowed.

Definition at line 346 of file acrobot.hpp.

◆ Rk4()

arma::colvec Rk4	(	const arma::colvec	state,
		const double	torque
	)		const

inline

This function calls the RK4 iterative method to estimate the next state based on given ordinary differential equation.

Parameters

state	The current State.
torque	The torque applied.

Definition at line 329 of file acrobot.hpp.

References Acrobot::Dsdt().

Referenced by Acrobot::Sample().

◆ Sample() [1/2]

double Sample	(	const State &	state,
		const Action &	action,
		State &	nextState
	)

inline

Dynamics of the Acrobot System.

To get reward and next state based on current state and current action. Always return -1 reward.

Parameters

state	The current State.
action	The action taken.
nextState	The next state.

Returns: reward, it's always -1.0.

The value of angular velocity is bounded in min and max value.

Definition at line 154 of file acrobot.hpp.

References Acrobot::State::AngularVelocity1(), Acrobot::State::AngularVelocity2(), Acrobot::IsTerminal(), M_PI, Acrobot::Rk4(), Acrobot::State::Theta1(), Acrobot::State::Theta2(), Acrobot::Torque(), and Acrobot::Wrap().

Referenced by Acrobot::Sample().

◆ Sample() [2/2]

double Sample	(	const State &	state,
		const Action &	action
	)

inline

Dynamics of the Acrobot System.

To get reward and next state based on current state and current action. This function calls the Sample function to estimate the next state return reward for taking a particular action.

Parameters

state	The current State.
action	The action taken.
nextState	The next state.

Definition at line 198 of file acrobot.hpp.

References Acrobot::Sample().

◆ StepsPerformed()

size_t StepsPerformed ( ) const

inline

Get the number of steps performed.

Definition at line 341 of file acrobot.hpp.

◆ Torque()

double Torque ( const Action & action ) const

inline

This function calculates the torque for a particular action.

0 : negative torque, 1 : zero torque, 2 : positive torque.

Parameters

Action action taken.

Definition at line 316 of file acrobot.hpp.

References mlpack::math::Random().

Referenced by Acrobot::Sample().

◆ Wrap()

double Wrap	(	double	value,
		const double	minimum,
		const double	maximum
	)		const

inline

Wrap funtion is required to truncate the angle value from -180 to 180.

This function will make sure that value will always be between minimum to maximum.

Parameters

value	Scalar value to wrap.
minimum	Minimum range of wrap.
maximum	Maximum range of wrap.

Definition at line 292 of file acrobot.hpp.

Referenced by Acrobot::Sample().

The documentation for this class was generated from the following file:

/home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/reinforcement_learning/environment/acrobot.hpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Action

Constructor & Destructor Documentation

◆ Acrobot()

Member Function Documentation

◆ Dsdt()

◆ InitialSample()

◆ IsTerminal()

◆ MaxSteps() [1/2]

◆ MaxSteps() [2/2]

◆ Rk4()

◆ Sample() [1/2]

◆ Sample() [2/2]

◆ StepsPerformed()

◆ Torque()

◆ Wrap()