Enum myopic_core::castlezone::CastleZone

pub enum CastleZone {
    WK,
    WQ,
    BK,
    BQ,
}

Represents one of the four different areas on a chessboard where the special castling move can take place (two for each side).

Variants

WK

WQ

BK

BQ

Implementations

impl CastleZone

pub fn kingside(side: Side) -> CastleZone

Return the kingside zone for the given side.

pub fn queenside(side: Side) -> CastleZone

Return the queenside zone for the given side.

pub fn iter() -> impl Iterator<Item = CastleZone>

Create an iterator traversing all zones in order.

pub fn source_squares(self) -> BitBoard

Returns a set of exactly two squares which denote the required locations of the king and rook in order for the corresponding castle move to take place.

pub fn rook_data(self) -> (Piece, Square, Square)

Returns a triple containing the rook which moves in the corresponding castle move along with it's required start square followed by the square it will finish on.

pub fn king_data(self) -> (Piece, Square, Square)

Returns a triple containing the king which moves in the corresponding castle move along with it's required start square followed by the square it will finish on.

pub fn unoccupied_requirement(self) -> BitBoard

Returns a set containing the squares which are required to be free of any other pieces in order for the corresponding castle move to be legal.

pub fn uncontrolled_requirement(self) -> BitBoard

Returns a set containing the squares which are required to be free of enemy control in order for the corresponding castle move to be legal.

pub fn lift(self) -> CastleZoneSet

Lifts this zone to a set of one element.

Trait Implementations

impl Clone for CastleZone

fn clone(&self) -> CastleZone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CastleZone

impl Debug for CastleZone

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

Formats the value using the given formatter.

impl Eq for CastleZone

impl FromIterator<CastleZone> for CastleZoneSet

fn from_iter<T: IntoIterator<Item = CastleZone>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for CastleZone

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for CastleZone

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<CastleZone> for CastleZone

fn eq(&self, other: &CastleZone) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<CastleZone> for CastleZone

fn partial_cmp(&self, other: &CastleZone) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 Reflectable for CastleZone

A castle is reflected by it's side, i.e.

• WK <==> BK
• WQ <==> BQ

fn reflect(&self) -> Self

impl StructuralEq for CastleZone

impl StructuralPartialEq for CastleZone