Struct World

pub struct World { /* private fields */ }

Implementations

impl World

pub fn new( grid: Vec<Vec<Tile>>, gem_positions: Vec<Position>, random_start_positions: Vec<Vec<Position>>, void_positions: Vec<Position>, exit_positions: Vec<Position>, walls_positions: Vec<Position>, source_positions: Vec<Position>, lasers_positions: Vec<Position>, ) -> Self

pub fn n_agents(&self) -> usize

pub fn n_laser_colours(&self) -> usize

pub fn seed(&mut self, seed: u64)

pub fn get_config(&self) -> WorldConfig

pub fn world_string(&self) -> String

The world string, taking into account the fact that some tiles may have changed (laser direction or colour).

pub fn agents(&self) -> &Vec<Agent>

pub fn agents_positions(&self) -> &Vec<Position>

pub fn gems_positions(&self) -> Vec<Position>

pub fn gems(&self) -> Vec<&Gem>

pub fn sources(&self) -> Vec<(Position, &LaserSource)>

pub fn lasers(&self) -> Vec<(Position, &Laser)>

pub fn set_exit_positions( &mut self, exits: Vec<Position>, ) -> Result<(), ParseError>

pub fn exits_positions(&self) -> Vec<Position>

pub fn n_gems(&self) -> usize

pub fn available_actions(&self) -> &Vec<Vec<Action>>

The available actions for each agent. The actions available to agent n are located in world.available_actions()[n].

pub fn available_joint_actions(&self) -> Vec<Vec<Action>>

Compute the available joint actions for all agents. The joint actions are all the possible combinations of the available actions for each agent. The result is a matrix of shape (x, n_agents) where x is the number of joint actions.

pub fn n_gems_collected(&self) -> usize

pub fn n_agents_arrived(&self) -> usize

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn walls(&self) -> Vec<Position>

pub fn starts(&self) -> Vec<Position>

pub fn possible_starts(&self) -> Vec<Vec<Position>>

pub fn void_positions(&self) -> Vec<Position>

pub fn all_states( &self, restrict_to_alive_agents: bool, ) -> impl Iterator<Item = WorldState> + '_

Iterator over all the possible states of the World. NOT YET TESTED

pub fn tiles(&self) -> Vec<(Position, &Tile)>

Creates an iterator over all tiles in the grid with their (i, j) coordinates

pub fn at(&self, pos: &Position) -> Option<&Tile>

pub fn at_mut(&mut self, pos: &Position) -> Option<&mut Tile>

pub fn reset(&mut self)

pub fn step( &mut self, actions: &[Action], ) -> Result<Vec<WorldEvent>, RuntimeWorldError>

Perform one step in the environment and return the corresponding reward.

pub fn get_state(&self) -> WorldState

pub fn set_state( &mut self, state: &WorldState, ) -> Result<Vec<WorldEvent>, RuntimeWorldError>

pub fn get_level(level: usize) -> Result<Self, ParseError>

pub fn from_file(file: &str) -> Result<Self, ParseError>

Trait Implementations

impl Clone for World

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<World> for PyWorld

fn from(world: World) -> Self

Converts to this type from the input type.

impl TryFrom<&str> for World

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(world_str: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for World

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(world_str: String) -> Result<Self, Self::Error>

Performs the conversion.