Struct tools_2048::Game

pub struct Game { /* private fields */ }

A struct that represents the 2048 game.

Implementations

impl Game

pub fn new(size: usize) -> Result<Self, Error>

Creates a new game of 2048.

Arguments

• n: The size of the board (nxn). Must be at least 4.

Returns

• Ok(Game): The game was created successfully.
• Err(Error): The game was not created successfully.

Errors

• Error::InvalidSize: The size of the board is invalid (less than 4).

pub fn from_existing(board: &[Vec<u64>], score: u64) -> Result<Self, Error>

Creates a game of 2048 from an existing board.

Arguments

• board: The board to use.
• score: The score of the game.

Returns

• Ok(Game): The game was created successfully.
• Err(Error): The game was not created successfully.

Errors

• Error::InvalidSize: The size of the board is invalid. Must be at least 4.
• Error::InvalidBoard: The board is invalid. Must be quadratic.
• Error::InvalidValue: The board contains invalid values. Must be 0 or powers of 2 (except 1).

pub fn board(&self) -> &Vec<Vec<u64>>

Returns the reference to the board.

Returns

• &Vec<Vec<u64>>: The reference to the board.

pub fn result(&self) -> GameResult

Returns the result of the game.

Returns

• Result::Victory: The game is won, 2048 was reached.
• Result::Pending: The game is in progress, 2048 is not reached yet.
• Result::Loss: The game is over, 2048 was not reached.

pub fn score(&self) -> u64

Returns the score of the game.

Returns

• u64: The score of the game.

pub fn size(&self) -> usize

Returns the size of the board.

Returns

• usize: The size of the board. The board is usizexusize.

pub fn state(&self) -> GameState

Returns the state of the game.

Returns

• State::InProgress: The game is in progress.
• State::GameOver: The game is over.

pub fn make_move(&mut self, direction: GameMove) -> bool

Make a move in the game.

Arguments

• direction: The direction to move in.

Returns

• true - The move was successful.
• false - The move was invalid/impossible.

pub fn find_best_move(&self, depth: usize) -> Result<GameMove, Error>

Find the best move to make based on the current board state. Based on Monte Carlo algorithm (randomized guessing). Uses multiple threads to speed up the process.

Arguments

• depth - The number of simulated games to play to determine the best move. Recommended value is 1000.

Returns

• Ok(GameMove) - The best move to make.
• Err(Error) - There are no valid moves left.

Errors

• Error::NoValidMove - There are no valid moves left.

Trait Implementations

impl Debug for Game

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Game

fn default() -> Self

Returns the “default value” for a type.

impl Display for Game

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.