ale-sys 0.1.2

Rust bindings to the Arcade Learning Environment
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

/* *****************************************************************************
 * A.L.E (Arcade Learning Environment)
 * Copyright (c) 2009-2013 by Yavar Naddaf, Joel Veness, Marc G. Bellemare and
 *   the Reinforcement Learning and Artificial Intelligence Laboratory
 * Released under the GNU General Public License; see License.txt for details.
 *
 * Based on: Stella  --  "An Atari 2600 VCS Emulator"
 * Copyright (c) 1995-2007 by Bradford W. Mott and the Stella team
 *
 * *****************************************************************************
 *  common_constants.h
 *
 *  Defines a set of constants used by various parts of the player agent code
 *
 **************************************************************************** */

#ifndef __CONSTANTS_H__
#define __CONSTANTS_H__

#include <cassert>
#include <vector>
#include <valarray>
#include <cstdlib>

#include "../emucore/m6502/src/bspf/src/bspf.hxx"

namespace ale {

// Define actions
enum Action {
  PLAYER_A_NOOP          = 0,
  PLAYER_A_FIRE          = 1,
  PLAYER_A_UP            = 2,
  PLAYER_A_RIGHT         = 3,
  PLAYER_A_LEFT          = 4,
  PLAYER_A_DOWN          = 5,
  PLAYER_A_UPRIGHT       = 6,
  PLAYER_A_UPLEFT        = 7,
  PLAYER_A_DOWNRIGHT     = 8,
  PLAYER_A_DOWNLEFT      = 9,
  PLAYER_A_UPFIRE        = 10,
  PLAYER_A_RIGHTFIRE     = 11,
  PLAYER_A_LEFTFIRE      = 12,
  PLAYER_A_DOWNFIRE      = 13,
  PLAYER_A_UPRIGHTFIRE   = 14,
  PLAYER_A_UPLEFTFIRE    = 15,
  PLAYER_A_DOWNRIGHTFIRE = 16,
  PLAYER_A_DOWNLEFTFIRE  = 17,
  PLAYER_B_NOOP          = 18,
  PLAYER_B_FIRE          = 19,
  PLAYER_B_UP            = 20,
  PLAYER_B_RIGHT         = 21,
  PLAYER_B_LEFT          = 22,
  PLAYER_B_DOWN          = 23,
  PLAYER_B_UPRIGHT       = 24,
  PLAYER_B_UPLEFT        = 25,
  PLAYER_B_DOWNRIGHT     = 26,
  PLAYER_B_DOWNLEFT      = 27,
  PLAYER_B_UPFIRE        = 28,
  PLAYER_B_RIGHTFIRE     = 29,
  PLAYER_B_LEFTFIRE      = 30,
  PLAYER_B_DOWNFIRE      = 31,
  PLAYER_B_UPRIGHTFIRE   = 32,
  PLAYER_B_UPLEFTFIRE    = 33,
  PLAYER_B_DOWNRIGHTFIRE = 34,
  PLAYER_B_DOWNLEFTFIRE  = 35,
  RESET                  = 40, // MGB: Use SYSTEM_RESET to reset the environment.
  UNDEFINED              = 41,
  RANDOM                 = 42,
  SAVE_STATE             = 43,
  LOAD_STATE             = 44,
  SYSTEM_RESET           = 45,
  LAST_ACTION_INDEX      = 50
};

#define PLAYER_A_MAX (18)
#define PLAYER_B_MAX (36)

std::string action_to_string(Action a);

//  Define datatypes
typedef std::vector<Action> ActionVect;

// mode type
typedef unsigned game_mode_t;
typedef std::vector<game_mode_t> ModeVect;

// difficulty type
typedef unsigned difficulty_t;
typedef std::vector<difficulty_t> DifficultyVect;

// reward type for RL interface
typedef int reward_t;

// Other constant values
#define RAM_LENGTH 128

}  // namespace ale

#endif  // __CONSTANTS_H__