Struct magpie::othello::Position

pub struct Position(/* private fields */);

Represents a single position on a 8x8 board as a u64.

Unlike the similar Bitboard which places no restrictions on the bits it represents, this struct represents exactly a single set bit.

Bitboard representations are quite inconvenient in some contexts which is why some convenience functions are provided to convert between different formats. In these contexts, MSB denotes A1 while LSB denotes H8, as can be seen in the graphic below.

    A    B    C    D    E    F    G    H
  +----+----+----+----+----+----+----+----+
1 | 00 | 01 | 02 | 03 | 04 | 05 | 06 | 07 |
  +----+----+----+----+----+----+----+----+
2 | 08 | 09 | 10 | 11 | 12 | 13 | 14 | 15 |
  +----+----+----+----+----+----+----+----+
3 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 |
  +----+----+----+----+----+----+----+----+
4 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 |
  +----+----+----+----+----+----+----+----+
5 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 |
  +----+----+----+----+----+----+----+----+
6 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 |
  +----+----+----+----+----+----+----+----+
7 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 |
  +----+----+----+----+----+----+----+----+
8 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
  +----+----+----+----+----+----+----+----+

Implementations

impl Position

pub fn raw(self) -> u64

Retrieves the underlying u64.

Examples

use magpie::othello::Position;

let p: Position = (1 << 32).try_into().unwrap();
assert_eq!(p.raw(), (1 << 32));

pub fn rank(self) -> u8

Calculates the zero-indexed rank the position is referring to.

How ranks and files are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let rank_and_file = (3, 4);
let p = Position::try_from(rank_and_file).unwrap();
assert_eq!(p.rank(), rank_and_file.0);
assert_eq!(p.file(), rank_and_file.1);

pub fn file(self) -> u8

Calculates the zero-indexed file the position is referring to.

How ranks and files are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let rank_and_file = (3, 4);
let p = Position::try_from(rank_and_file).unwrap();
assert_eq!(p.rank(), rank_and_file.0);
assert_eq!(p.file(), rank_and_file.1);

pub fn to_notation(self) -> String

Calculates a human-readable board position.

How board positions are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let notation = "A1";
let p = Position::try_from(notation).unwrap();
assert_eq!(p.to_notation().to_lowercase(), notation.to_lowercase());

Trait Implementations

impl BitAnd<Bitboard> for Position

type Output = Bitboard

The resulting type after applying the & operator.

fn bitand(self, Bitboard: Bitboard) -> Self::Output

Performs the & operation.

impl BitAnd<Position> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

fn bitand(self, Position: Position) -> Self::Output

Performs the & operation.

impl BitAnd<Position> for u64

type Output = u64

The resulting type after applying the & operator.

fn bitand(self, Position: Position) -> Self::Output

Performs the & operation.

impl BitAnd for Position

type Output = Position

The resulting type after applying the & operator.

fn bitand(self, Position: Position) -> Self::Output

Performs the & operation.

impl BitAndAssign<Bitboard> for Position

fn bitand_assign(&mut self, Bitboard: Bitboard)

Performs the &= operation.

impl BitAndAssign<Position> for Bitboard

fn bitand_assign(&mut self, Position: Position)

Performs the &= operation.

impl BitAndAssign<Position> for u64

fn bitand_assign(&mut self, Position: Position)

Performs the &= operation.

impl BitOr<Bitboard> for Position

type Output = Bitboard

The resulting type after applying the | operator.

fn bitor(self, Bitboard: Bitboard) -> Self::Output

Performs the | operation.

impl BitOr<Position> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

fn bitor(self, Position: Position) -> Self::Output

Performs the | operation.

impl BitOr<Position> for u64

type Output = u64

The resulting type after applying the | operator.

fn bitor(self, Position: Position) -> Self::Output

Performs the | operation.

impl BitOrAssign<Position> for Bitboard

fn bitor_assign(&mut self, Position: Position)

Performs the |= operation.

impl BitOrAssign<Position> for u64

fn bitor_assign(&mut self, Position: Position)

Performs the |= operation.

impl BitXor<Bitboard> for Position

type Output = Bitboard

The resulting type after applying the ^ operator.

fn bitxor(self, Bitboard: Bitboard) -> Self::Output

Performs the ^ operation.

impl BitXor<Position> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

fn bitxor(self, Position: Position) -> Self::Output

Performs the ^ operation.

impl BitXor<Position> for u64

type Output = u64

The resulting type after applying the ^ operator.

fn bitxor(self, Position: Position) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<Position> for Bitboard

fn bitxor_assign(&mut self, Position: Position)

Performs the ^= operation.

impl BitXorAssign<Position> for u64

fn bitxor_assign(&mut self, Position: Position)

Performs the ^= operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl From<Position> for Bitboard

fn from(position: Position) -> Self

Converts to this type from the input type.

impl From<Position> for u64

fn from(position: Position) -> Self

Converts to this type from the input type.

impl Hash for Position

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Position

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Bitboard> for Position

fn eq(&self, b: &Bitboard) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Position> for Bitboard

fn eq(&self, b: &Position) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Position> for u64

fn eq(&self, b: &Position) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u64> for Position

fn eq(&self, b: &u64) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Position

fn eq(&self, b: &Position) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Bitboard> for Position

fn partial_cmp(&self, b: &Bitboard) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Position> for Bitboard

fn partial_cmp(&self, b: &Position) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Position> for u64

fn partial_cmp(&self, b: &Position) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<u64> for Position

fn partial_cmp(&self, b: &u64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for Position

fn partial_cmp(&self, b: &Position) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Shl<i128> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: i128) -> Self::Output

Performs the << operation.

impl Shl<i16> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: i16) -> Self::Output

Performs the << operation.

impl Shl<i32> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: i32) -> Self::Output

Performs the << operation.

impl Shl<i64> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: i64) -> Self::Output

Performs the << operation.

impl Shl<i8> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: i8) -> Self::Output

Performs the << operation.

impl Shl<isize> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: isize) -> Self::Output

Performs the << operation.

impl Shl<u128> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: u128) -> Self::Output

Performs the << operation.

impl Shl<u16> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: u16) -> Self::Output

Performs the << operation.

impl Shl<u32> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: u32) -> Self::Output

Performs the << operation.

impl Shl<u64> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: u64) -> Self::Output

Performs the << operation.

impl Shl<u8> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: u8) -> Self::Output

Performs the << operation.

impl Shl<usize> for Position

type Output = Position

The resulting type after applying the << operator.

fn shl(self, b: usize) -> Self::Output

Performs the << operation.

impl ShlAssign<i128> for Position

fn shl_assign(&mut self, b: i128)

Performs the <<= operation.

impl ShlAssign<i16> for Position

fn shl_assign(&mut self, b: i16)

Performs the <<= operation.

impl ShlAssign<i32> for Position

fn shl_assign(&mut self, b: i32)

Performs the <<= operation.

impl ShlAssign<i64> for Position

fn shl_assign(&mut self, b: i64)

Performs the <<= operation.

impl ShlAssign<i8> for Position

fn shl_assign(&mut self, b: i8)

Performs the <<= operation.

impl ShlAssign<isize> for Position

fn shl_assign(&mut self, b: isize)

Performs the <<= operation.

impl ShlAssign<u128> for Position

fn shl_assign(&mut self, b: u128)

Performs the <<= operation.

impl ShlAssign<u16> for Position

fn shl_assign(&mut self, b: u16)

Performs the <<= operation.

impl ShlAssign<u32> for Position

fn shl_assign(&mut self, b: u32)

Performs the <<= operation.

impl ShlAssign<u64> for Position

fn shl_assign(&mut self, b: u64)

Performs the <<= operation.

impl ShlAssign<u8> for Position

fn shl_assign(&mut self, b: u8)

Performs the <<= operation.

impl ShlAssign<usize> for Position

fn shl_assign(&mut self, b: usize)

Performs the <<= operation.

impl Shr<i128> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: i128) -> Self::Output

Performs the >> operation.

impl Shr<i16> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: i16) -> Self::Output

Performs the >> operation.

impl Shr<i32> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: i32) -> Self::Output

Performs the >> operation.

impl Shr<i64> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: i64) -> Self::Output

Performs the >> operation.

impl Shr<i8> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: i8) -> Self::Output

Performs the >> operation.

impl Shr<isize> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: isize) -> Self::Output

Performs the >> operation.

impl Shr<u128> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: u128) -> Self::Output

Performs the >> operation.

impl Shr<u16> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: u16) -> Self::Output

Performs the >> operation.

impl Shr<u32> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: u32) -> Self::Output

Performs the >> operation.

impl Shr<u64> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: u64) -> Self::Output

Performs the >> operation.

impl Shr<u8> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: u8) -> Self::Output

Performs the >> operation.

impl Shr<usize> for Position

type Output = Position

The resulting type after applying the >> operator.

fn shr(self, b: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<i128> for Position

fn shr_assign(&mut self, b: i128)

Performs the >>= operation.

impl ShrAssign<i16> for Position

fn shr_assign(&mut self, b: i16)

Performs the >>= operation.

impl ShrAssign<i32> for Position

fn shr_assign(&mut self, b: i32)

Performs the >>= operation.

impl ShrAssign<i64> for Position

fn shr_assign(&mut self, b: i64)

Performs the >>= operation.

impl ShrAssign<i8> for Position

fn shr_assign(&mut self, b: i8)

Performs the >>= operation.

impl ShrAssign<isize> for Position

fn shr_assign(&mut self, b: isize)

Performs the >>= operation.

impl ShrAssign<u128> for Position

fn shr_assign(&mut self, b: u128)

Performs the >>= operation.

impl ShrAssign<u16> for Position

fn shr_assign(&mut self, b: u16)

Performs the >>= operation.

impl ShrAssign<u32> for Position

fn shr_assign(&mut self, b: u32)

Performs the >>= operation.

impl ShrAssign<u64> for Position

fn shr_assign(&mut self, b: u64)

Performs the >>= operation.

impl ShrAssign<u8> for Position

fn shr_assign(&mut self, b: u8)

Performs the >>= operation.

impl ShrAssign<usize> for Position

fn shr_assign(&mut self, b: usize)

Performs the >>= operation.

impl TryFrom<&str> for Position

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

Constructs a position from human-readable notation.

Returns an error if the notation is invalid.

The conversion is case-insensitive.

How board positions are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let notation = "A1";
let p = Position::try_from(notation).unwrap();
assert_eq!(p.to_notation().to_lowercase(), notation.to_lowercase());

type Error = PositionError

The type returned in the event of a conversion error.

impl TryFrom<(u8, u8)> for Position

fn try_from(pair: (u8, u8)) -> Result<Self, Self::Error>

Constructs a position from a zero-indexed rank and file pair.

Returns an error if either the rank or file does not fit into a 8x8 board.

How ranks and files are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let rank_and_file = (3, 4);
let p = Position::try_from(rank_and_file).unwrap();
assert_eq!(p.rank(), rank_and_file.0);
assert_eq!(p.file(), rank_and_file.1);

type Error = PositionError

The type returned in the event of a conversion error.

impl TryFrom<Bitboard> for Position

fn try_from(bitboard: Bitboard) -> Result<Self, Self::Error>

Constructs a position from a Bitboard.

Returns an error if the Bitboard does not have exactly one bit set.

Examples

use magpie::othello::{Bitboard, Position};

let bitboard = Bitboard::from(1 << 32);
let p = Position::try_from(bitboard).unwrap();
assert_eq!(p.raw(), bitboard);

type Error = PositionError

The type returned in the event of a conversion error.

impl TryFrom<String> for Position

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

Constructs a position from human-readable notation.

Returns an error if the notation is invalid.

The conversion is case-insensitive.

How board positions are represented can be found in the top-level documentation for Position.

Examples

use magpie::othello::Position;

let notation = "A1";
let p = Position::try_from(notation).unwrap();
assert_eq!(p.to_notation().to_lowercase(), notation.to_lowercase());

type Error = PositionError

The type returned in the event of a conversion error.

impl TryFrom<u64> for Position

fn try_from(bitboard: u64) -> Result<Self, Self::Error>

Constructs a position from a u64.

Returns an error if the u64 does not have exactly one bit set.

Examples

use magpie::othello::Position;

let num = 1 << 32;
let p = Position::try_from(num).unwrap();
assert_eq!(p.raw(), num);

type Error = PositionError

The type returned in the event of a conversion error.

impl Copy for Position

impl Eq for Position