Struct MctsTreeNode 

pub struct MctsTreeNode<'a, T: Board>(pub NodeRef<'a, MctsNode<T>>);

Tuple Fields

0: NodeRef<'a, MctsNode<T>>

Implementations

impl<'a, T: Board> MctsTreeNode<'a, T>

pub fn get_best_child(&self) -> Option<MctsTreeNode<'a, T>>

Returns the child of the given node that is considered the most promising, based on win rate.

Examples found in repository

examples/tic_tac_toe.rs (line 31)

fn main() {
    // Create a new Tic-Tac-Toe board
    let board = TicTacToeBoard::default();

    // Create a new MCTS search instance
    let mut mcts = MonteCarloTreeSearch::builder(board)
        .with_alpha_beta_pruning(false)
        .with_random_generator(CustomNumberGenerator::default())
        .build();

    // Run the search for 20,000 iterations
    mcts.iterate_n_times(20000);

    // Print the chances
    let root = mcts.get_root();
    for node in root.children() {
        println!(
            "Move: {:?} = {:.2?}%",
            node.value().prev_move,
            node.value().wins_rate() * 100.0
        );
    }

    // Get the most promising move
    let best_move_node = root.get_best_child().unwrap();
    let best_move = best_move_node.value().prev_move;

    println!("The best move is: {:?}", best_move);
    assert_eq!(best_move, Some(4));
}

Methods from Deref<Target = NodeRef<'a, MctsNode<T>>>

pub fn id(&self) -> NodeId

Returns the ID of this node.

pub fn tree(&self) -> &'a Tree<T>

Returns the tree owning this node.

pub fn value(&self) -> &'a T

Returns the value of this node.

Examples found in repository

examples/tic_tac_toe.rs (line 25)

fn main() {
    // Create a new Tic-Tac-Toe board
    let board = TicTacToeBoard::default();

    // Create a new MCTS search instance
    let mut mcts = MonteCarloTreeSearch::builder(board)
        .with_alpha_beta_pruning(false)
        .with_random_generator(CustomNumberGenerator::default())
        .build();

    // Run the search for 20,000 iterations
    mcts.iterate_n_times(20000);

    // Print the chances
    let root = mcts.get_root();
    for node in root.children() {
        println!(
            "Move: {:?} = {:.2?}%",
            node.value().prev_move,
            node.value().wins_rate() * 100.0
        );
    }

    // Get the most promising move
    let best_move_node = root.get_best_child().unwrap();
    let best_move = best_move_node.value().prev_move;

    println!("The best move is: {:?}", best_move);
    assert_eq!(best_move, Some(4));
}

pub fn parent(&self) -> Option<NodeRef<'a, T>>

Returns the parent of this node.

pub fn prev_sibling(&self) -> Option<NodeRef<'a, T>>

Returns the previous sibling of this node.

pub fn next_sibling(&self) -> Option<NodeRef<'a, T>>

Returns the next sibling of this node.

pub fn first_child(&self) -> Option<NodeRef<'a, T>>

Returns the first child of this node.

pub fn last_child(&self) -> Option<NodeRef<'a, T>>

Returns the last child of this node.

pub fn has_siblings(&self) -> bool

Returns true if this node has siblings.

pub fn has_children(&self) -> bool

Returns true if this node has children.

pub fn ancestors(&self) -> Ancestors<'a, T>

Returns an iterator over ancestors.

pub fn prev_siblings(&self) -> PrevSiblings<'a, T>

Returns an iterator over previous siblings.

pub fn next_siblings(&self) -> NextSiblings<'a, T>

Returns an iterator over next siblings.

pub fn first_children(&self) -> FirstChildren<'a, T>

Returns an iterator over first children.

pub fn last_children(&self) -> LastChildren<'a, T>

Returns an iterator over last children.

pub fn children(&self) -> Children<'a, T>

Returns an iterator over children.

Examples found in repository

examples/tic_tac_toe.rs (line 22)

fn main() {
    // Create a new Tic-Tac-Toe board
    let board = TicTacToeBoard::default();

    // Create a new MCTS search instance
    let mut mcts = MonteCarloTreeSearch::builder(board)
        .with_alpha_beta_pruning(false)
        .with_random_generator(CustomNumberGenerator::default())
        .build();

    // Run the search for 20,000 iterations
    mcts.iterate_n_times(20000);

    // Print the chances
    let root = mcts.get_root();
    for node in root.children() {
        println!(
            "Move: {:?} = {:.2?}%",
            node.value().prev_move,
            node.value().wins_rate() * 100.0
        );
    }

    // Get the most promising move
    let best_move_node = root.get_best_child().unwrap();
    let best_move = best_move_node.value().prev_move;

    println!("The best move is: {:?}", best_move);
    assert_eq!(best_move, Some(4));
}

pub fn traverse(&self) -> Traverse<'a, T>

Returns an iterator which traverses the subtree starting at this node.

pub fn descendants(&self) -> Descendants<'a, T>

Returns an iterator over this node and its descendants.

Trait Implementations

impl<'a, T: Board> Deref for MctsTreeNode<'a, T>

type Target = NodeRef<'a, MctsNode<T>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Board> DerefMut for MctsTreeNode<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: Board> From<NodeRef<'a, MctsNode<T>>> for MctsTreeNode<'a, T>

fn from(node: NodeRef<'a, MctsNode<T>>) -> Self

Converts to this type from the input type.

impl<'a, T: Board> Into<NodeRef<'a, MctsNode<T>>> for MctsTreeNode<'a, T>

fn into(self) -> NodeRef<'a, MctsNode<T>>

Converts this type into the (usually inferred) input type.