Struct shogi_core::PartialPosition

#[repr(C)]
pub struct PartialPosition { /* private fields */ }

A position with its move sequence omitted.

This data is insufficient for complete legality checking (such as repetition checking), but in most cases it suffices. If you need a complete legality checking, use Position.

TODO: describe exactly when a position is considered valid

Implementations

impl PartialPosition

pub fn empty() -> Self

Returns an empty position.

pub fn startpos() -> Self

Returns the starting position of shogi.

#[no_mangle]

pub extern "C" fn PartialPosition_startpos(
    buf: &mut MaybeUninit<Self>
)

C interface of startpos.

#[export_name = "PartialPosition_side_to_move"]

pub extern "C" fn side_to_move(&self) -> Color

Finds which player is to move.

Examples:

let mut pos = PartialPosition::startpos();
assert_eq!(pos.side_to_move(), Color::Black);
pos.make_move(Move::Normal { from: Square::SQ_7G, to: Square::SQ_7F, promote: false }).unwrap();
assert_eq!(pos.side_to_move(), Color::White);

pub fn side_to_move_set(&mut self, side: Color)

Sets which player is to move.

#[export_name = "PartialPosition_hand_of_a_player"]

pub extern "C" fn hand_of_a_player(&self, color: Color) -> Hand

Returns the Hand of a player.

pub fn hand_of_a_player_mut(&mut self, color: Color) -> &mut Hand

Gives the reference to the hand of the specified player.

This function makes no guarantee about the consistency of the position. Users should have a good reason when using it. Exported for parsers.

pub fn hand(&self, piece: Piece) -> Option<u8>

Returns how many pieces of piece are in hand.

If piece is not a valid piece in hand, this method returns None.

#[export_name = "PartialPosition_ply"]

pub extern "C" fn ply(&self) -> u16

Finds how many moves were made.

pub fn ply_set(&mut self, ply: u16) -> bool

Sets how many moves are made. Returns whether this operation was successful. This operation succeeds iff ply != 0.

pub fn piece_at(&self, square: Square) -> Option<Piece>

Returns the Piece on the designated Square.

Examples:

let pos = PartialPosition::startpos();
let black_rook = pos.piece_at(Square::SQ_2H);
assert_eq!(black_rook, Some(Piece::B_R));
let vacant = pos.piece_at(Square::SQ_3H);
assert_eq!(vacant, None);

#[no_mangle]

pub extern "C" fn PartialPosition_piece_at(
    &self,
    square: Square
) -> OptionPiece

C interface to PartialPosition::piece_at.

pub fn piece_set(&mut self, square: Square, piece: Option<Piece>)

Place a piece on a square.

This function makes no guarantee about the consistency of the position. Users should have a good reason when using it. Exported for parsers.

#[export_name = "PartialPosition_occupied_bitboard"]

pub extern "C" fn occupied_bitboard(&self) -> Bitboard

Finds the subset of squares with a piece.

Since: 0.1.4

#[export_name = "PartialPosition_vacant_bitboard"]

pub extern "C" fn vacant_bitboard(&self) -> Bitboard

Finds the subset of squares with no pieces.

#[export_name = "PartialPosition_player_bitboard"]

pub extern "C" fn player_bitboard(&self, color: Color) -> Bitboard

Finds the subset of squares where a piece of the specified player is placed.

#[export_name = "PartialPosition_piece_bitboard"]

pub extern "C" fn piece_bitboard(&self, piece: Piece) -> Bitboard

Finds the subset of squares where a piece is placed.

Examples:

let pos = PartialPosition::startpos();
let black_rook = pos.piece_bitboard(Piece::B_R);
assert_eq!(black_rook, Bitboard::single(Square::SQ_2H));
let white_rook = pos.piece_bitboard(Piece::W_R);
assert_eq!(white_rook, Bitboard::single(Square::SQ_8B));

#[export_name = "PartialPosition_piece_kind_bitboard"]

pub extern "C" fn piece_kind_bitboard(
    &self,
    piece_kind: PieceKind
) -> Bitboard

Finds the subset of squares where a PieceKind is placed.

Examples:

let pos = PartialPosition::startpos();
let rooks = pos.piece_kind_bitboard(PieceKind::Rook);
assert_eq!(rooks, Bitboard::single(Square::SQ_2H) | Bitboard::single(Square::SQ_8B));

pub fn last_move(&self) -> Option<Move>

Returns the last move, if it exists.

Examples:

use shogi_core::PartialPosition;
assert_eq!(PartialPosition::startpos().last_move(), None);

pub fn last_compact_move(&self) -> Option<CompactMove>

Returns the last move, if it exists.

Examples:

use shogi_core::PartialPosition;
assert_eq!(PartialPosition::startpos().last_compact_move(), None);

#[no_mangle]

pub extern "C" fn PartialPosition_last_compact_move(
    &self
) -> OptionCompactMove

C interface to PartialPosition::last_compact_move.

pub fn king_position(&self, color: Color) -> Option<Square>

pub fn make_move(&mut self, mv: Move) -> Option<()>

Makes a move. Note that this function will never check legality.

Returns Some(()) if the given move makes sense, i.e., moves a piece to another square or drops a piece on a vacant square.

If it returns None, it is guaranteed that self is not modified.

#[export_name = "PartialPosition_make_compact_move"]

pub extern "C" fn make_compact_move(&mut self, mv: CompactMove) -> bool

Makes a move. This function is a C-compatible counterpart of make_move. Note that this function will never check legality.

Returns true if the given move makes sense, i.e., moves a piece to another square or drops a piece on a vacant square.

If it returns false, it is guaranteed that self is not modified.

pub fn to_sfen<W: Write>(&self, sink: &mut W) -> FmtResult

Write the current position in SFEN notation.

pub fn to_sfen_owned(&self) -> String

Available on crate feature alloc only.

Returns the SFEN representation of the current position.

Examples:

let pos = PartialPosition::startpos();
let s = pos.to_sfen_owned();
assert_eq!(
    s,
    "lnsgkgsnl/1r5b1/ppppppppp/9/9/9/PPPPPPPPP/1B5R1/LNSGKGSNL b - 1",
);

#[export_name = "PartialPosition_to_sfen_c"]

pub unsafe extern "C" fn to_sfen_c(&self, ptr: *mut u8)

C interface of to_sfen.

Safety

This function writes to ptr at most 139 (= 129 + 1 + 1 + 1 + 0 + 1 + 5 + 1) bytes. Caller should ensure that ptr has enough space for that.

Trait Implementations

impl Clone for PartialPosition

fn clone(&self) -> PartialPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartialPosition

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

Formats the value using the given formatter.

impl Default for PartialPosition

fn default() -> Self

Returns the “default value” for a type.

impl Hash for PartialPosition

Available on crate feature hash only.

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 PartialPosition

Available on crate feature ord only.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PartialPosition> for PartialPosition

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

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

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

This method tests for !=.

impl PartialOrd<PartialPosition> for PartialPosition

Available on crate feature ord only.

fn partial_cmp(&self, other: &Self) -> 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 Eq for PartialPosition

impl StructuralEq for PartialPosition

impl StructuralPartialEq for PartialPosition