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

//! Provides common Tic Tac Toe logic and artificial intelligence algorithms.
//!
//! # Examples
//! The example below creates a Tic Tac Toe game and two AI opponents to play
//! the game.
//! ```
//! use open_ttt_lib::{ai, game};
//!
//! fn main() -> Result<(), Box<game::Error>> {
//!     // Create a game and two AI opponents to play the game.
//!     let mut game = game::Game::new();
//!
//!     // Rando picks random positions.
//!     let rando = ai::Opponent::new(1.0);
//!     // The flawless opponent cannot loose: it fully evaluates every possible
//!     // move and countermove to pick the best position.
//!     let flawless_ai = ai::Opponent::new(0.0);
//!
//!     // Have the opponents take turns making moves until the game is over.
//!     loop {
//!         match game.state() {
//!             game::State::PlayerXMove => {
//!                 println!("Rando playing as X turn:");
//!                 game.do_move(rando.get_move(&game).unwrap())?;
//!             }
//!             game::State::PlayerOMove => {
//!                 println!("Flawless AI playing as O turn:");
//!                 game.do_move(flawless_ai.get_move(&game).unwrap())?;
//!             }
//!             game::State::PlayerXWin(_) => {
//!                 println!("Game Over: Rando playing as X wins!");
//!                 break;
//!             }
//!             game::State::PlayerOWin(_) => {
//!                 println!("Game Over: Flawless AI playing as O wins!");
//!                 break;
//!             }
//!             game::State::CatsGame => {
//!                 println!("Game Over: cat's game.");
//!                 break;
//!             }
//!         };
//!
//!         // Print the game's the board.
//!         println!("{}", game.board());
//!     }
//!
//!     Ok(())
//! }
//! ```

#![doc(html_root_url = "https://docs.rs/open_ttt_lib/0.1.0")]

pub mod ai;
pub mod board;
pub mod game;

// Ensure the examples in the README file also work as expected.
extern crate doc_comment;
doc_comment::doctest!("../README.md", examples_in_readme);