mlpack 3.4.2
Public Member Functions | Static Public Attributes | List of all members
Acrobot::State Class Reference

#include <acrobot.hpp>

Public Member Functions

 State ()
 Construct a state instance. More...
 
 State (const arma::colvec &data)
 Construct a state instance from given data. More...
 
double & AngularVelocity1 ()
 Modify the angular velocity (one). More...
 
double AngularVelocity1 () const
 Get value of Angular velocity (one). More...
 
double & AngularVelocity2 ()
 Modify the angular velocity (two). More...
 
double AngularVelocity2 () const
 Get value of Angular velocity (two). More...
 
arma::colvec & Data ()
 Modify the state representation. More...
 
const arma::colvec & Encode () const
 Encode the state to a column vector. More...
 
double & Theta1 ()
 Modify value of theta (one). More...
 
double Theta1 () const
 Get value of theta (one). More...
 
double & Theta2 ()
 Modify value of theta (two). More...
 
double Theta2 () const
 Get value of theta (two). More...
 

Static Public Attributes

static constexpr size_t dimension = 4
 Dimension of the encoded state. More...
 

Detailed Description

Definition at line 35 of file acrobot.hpp.

Constructor & Destructor Documentation

◆ State() [1/2]

State ( )
inline

Construct a state instance.

Definition at line 41 of file acrobot.hpp.

◆ State() [2/2]

State ( const arma::colvec &  data)
inline

Construct a state instance from given data.

Parameters
dataData for the theta and angular velocity of two links.

Definition at line 48 of file acrobot.hpp.

Member Function Documentation

◆ AngularVelocity1() [1/2]

double & AngularVelocity1 ( )
inline

Modify the angular velocity (one).

Definition at line 67 of file acrobot.hpp.

◆ AngularVelocity1() [2/2]

double AngularVelocity1 ( ) const
inline

Get value of Angular velocity (one).

Definition at line 65 of file acrobot.hpp.

Referenced by Acrobot::Sample().

◆ AngularVelocity2() [1/2]

double & AngularVelocity2 ( )
inline

Modify the angular velocity (two).

Definition at line 72 of file acrobot.hpp.

◆ AngularVelocity2() [2/2]

double AngularVelocity2 ( ) const
inline

Get value of Angular velocity (two).

Definition at line 70 of file acrobot.hpp.

Referenced by Acrobot::Sample().

◆ Data()

arma::colvec & Data ( )
inline

Modify the state representation.

Definition at line 52 of file acrobot.hpp.

◆ Encode()

const arma::colvec & Encode ( ) const
inline

Encode the state to a column vector.

Definition at line 75 of file acrobot.hpp.

◆ Theta1() [1/2]

double & Theta1 ( )
inline

Modify value of theta (one).

Definition at line 57 of file acrobot.hpp.

◆ Theta1() [2/2]

double Theta1 ( ) const
inline

Get value of theta (one).

Definition at line 55 of file acrobot.hpp.

Referenced by Acrobot::IsTerminal(), and Acrobot::Sample().

◆ Theta2() [1/2]

double & Theta2 ( )
inline

Modify value of theta (two).

Definition at line 62 of file acrobot.hpp.

◆ Theta2() [2/2]

double Theta2 ( ) const
inline

Get value of theta (two).

Definition at line 60 of file acrobot.hpp.

Referenced by Acrobot::IsTerminal(), and Acrobot::Sample().

Member Data Documentation

◆ dimension

constexpr size_t dimension = 4
staticconstexpr

Dimension of the encoded state.

Definition at line 78 of file acrobot.hpp.


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