FruitTreeNavigation::State Class Reference

Implementation of Fruit Tree Navigation state. More...

Public Member Functions

 State ()
 Construct a state instance. More...

 
 State (const arma::colvec &data)
 Construct a state instance from given data. More...

 
double Column () const
 Get value of column index of the node. More...

 
double & Column ()
 Modify value of column index of the node. More...

 
arma::vec & Data ()
 Modify the state representation. More...

 
double Row () const
 Get value of row index of the node. More...

 
double & Row ()
 Modify value of row index of the node. More...

 

Static Public Attributes

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

 

Detailed Description

Implementation of Fruit Tree Navigation state.

Each State is a tuple {(row, column)} representing zero based index of a node in the tree.

Definition at line 42 of file ftn.hpp.

Constructor & Destructor Documentation

◆ State() [1/2]

State ( )
inline

Construct a state instance.

Definition at line 48 of file ftn.hpp.

Referenced by FruitTreeNavigation::InitialSample().

◆ State() [2/2]

State ( const arma::colvec &  data)
inline

Construct a state instance from given data.

Parameters
dataData for the zero based index of the current node.

Definition at line 55 of file ftn.hpp.

Member Function Documentation

◆ Column() [1/2]

double Column ( ) const
inline

Get value of column index of the node.

Definition at line 67 of file ftn.hpp.

Referenced by FruitTreeNavigation::Sample().

◆ Column() [2/2]

double& Column ( )
inline

Modify value of column index of the node.

Definition at line 69 of file ftn.hpp.

◆ Data()

arma::vec& Data ( )
inline

Modify the state representation.

Definition at line 59 of file ftn.hpp.

◆ Row() [1/2]

double Row ( ) const
inline

Get value of row index of the node.

Definition at line 62 of file ftn.hpp.

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

◆ Row() [2/2]

double& Row ( )
inline

Modify value of row index of the node.

Definition at line 64 of file ftn.hpp.

Member Data Documentation

◆ dimension

constexpr size_t dimension = 2
static

Dimension of the encoded state.

Definition at line 72 of file ftn.hpp.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/methods/reinforcement_learning/environment/ftn.hpp