Struct chess::MoveGen [−] [src]

pub struct MoveGen { /* fields omitted */ }

The move generation iterator

This structure enumerates moves slightly slower than board.enumerate_moves(...), but has some extra features, such as:

  • Being an iterator
  • Not requiring you to create a buffer
  • Only iterating moves that match a certain pattern
  • Being iterable multiple times (such as, iterating once for all captures, then iterating again for all quiets)
  • Doing as little work early on as possible, so that if you are not going to look at every move, the struture moves faster
  • Being able to iterate pseudo legal moves, while keeping the (nearly) free legality checks in place

Examples

use chess::MoveGen;
use chess::Board;
use chess::EMPTY;
use chess::construct;

// always remember to call construct!
construct();

// create a board with the initial position
let board = Board::from_fen("rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1".to_owned()).unwrap();

// create an iterable
let mut iterable = MoveGen::new(board, true);

// make sure .len() works.
assert_eq!(iterable.len(), 20); // the .len() function does *not* consume the iterator

// lets iterate over targets.
let targets = board.color_combined(!board.side_to_move());
iterable.set_iterator_mask(targets);

// count the number of targets
let mut count = 0;
for x in &mut iterable {
    count += 1;
    // This move captures one of my opponents pieces (with the exception of en passant)
}

// now, iterate over the rest of the moves
iterable.set_iterator_mask(!EMPTY);
for x in &mut iterable {
    count += 1;
    // This move does not capture anything
}

// make sure it works
assert_eq!(count, 20);

Methods

impl MoveGen
[src]

Create a new MoveGen structure, specifying whether or not you want legal or pseudo_legal moves

Note the board.legal_quick() function, which checks the legality of pseudo_legal moves generated specifically by this structure. That way, if you call MoveGen::new(board, false), but you want to check legality later, you can call board.legal_quick(...) on that chess move, without the full expense of the board.legal(...) function.

Never, ever, iterate any moves that land on the following squares

Never, ever, iterate this move

For now, Only iterate moves that land on the following squares Note: Once iteration is completed, you can pass in a mask of ! EMPTY to get the remaining moves, or another mask

Fastest perft test with this structure

Trait Implementations

impl ExactSizeIterator for MoveGen
[src]

Give the exact length of this iterator

Unstable (exact_size_is_empty)

Returns whether the iterator is empty. Read more

impl Iterator for MoveGen
[src]

The type of the elements being iterated over.

Give a size_hint to some functions that need it

Find the next chess move.

Consumes the iterator, counting the number of iterations and returning it. Read more

Consumes the iterator, returning the last element. Read more

Returns the nth element of the iterator. Read more

Takes two iterators and creates a new iterator over both in sequence. Read more

'Zips up' two iterators into a single iterator of pairs. Read more

Takes a closure and creates an iterator which calls that closure on each element. Read more

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

Creates an iterator that both filters and maps. Read more

Creates an iterator which gives the current iteration count as well as the next value. Read more

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

Creates an iterator that [skip()]s elements based on a predicate. Read more

Creates an iterator that yields elements based on a predicate. Read more

Creates an iterator that skips the first n elements. Read more

Creates an iterator that yields its first n elements. Read more

An iterator adaptor similar to [fold()] that holds internal state and produces a new iterator. Read more

Creates an iterator that works like map, but flattens nested structure. Read more

Creates an iterator which ends after the first None. Read more

Do something with each element of an iterator, passing the value on. Read more

Borrows an iterator, rather than consuming it. Read more

Transforms an iterator into a collection. Read more

Consumes an iterator, creating two collections from it. Read more

An iterator adaptor that applies a function, producing a single, final value. Read more

Tests if every element of the iterator matches a predicate. Read more

Tests if any element of the iterator matches a predicate. Read more

Searches for an element of an iterator that satisfies a predicate. Read more

Searches for an element in an iterator, returning its index. Read more

Searches for an element in an iterator from the right, returning its index. Read more

Returns the maximum element of an iterator. Read more

Returns the minimum element of an iterator. Read more

Returns the element that gives the maximum value from the specified function. Read more

Unstable (iter_max_by)

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

Returns the element that gives the minimum value from the specified function. Read more

Unstable (iter_min_by)

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

Reverses an iterator's direction. Read more

Converts an iterator of pairs into a pair of containers. Read more

Creates an iterator which clone()s all of its elements. Read more

Repeats an iterator endlessly. Read more

Sums the elements of an iterator. Read more

Iterates over the entire iterator, multiplying all the elements Read more

Lexicographically compares the elements of this Iterator with those of another. Read more

Lexicographically compares the elements of this Iterator with those of another. Read more

Determines if the elements of this Iterator are equal to those of another. Read more

Determines if the elements of this Iterator are unequal to those of another. Read more

Determines if the elements of this Iterator are lexicographically less than those of another. Read more

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more