Struct Rank16

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

Rank Set

A compact bit-set representation for storing multiple ranks using a single u16. Each bit represents whether a specific rank is present in the set. Supports efficient set operations like union, intersection, and membership testing.

Memory Layout:

[15, 0]:   xxxAKQJT 98765432  // x: unused

Examples

use open_pql::{Rank::*, Rank16};

let mut ranks = Rank16::default();
ranks.set(RA);
ranks.set(RK);

assert!(ranks.contains_rank(RA));
assert_eq!(ranks.count(), 2);

Implementations

impl Rank16

pub const fn from_u16(v: u16) -> Self

Constructs Rank16 from u16

Examples

use open_pql::{Rank, Rank16};

let i: u16 = 0b0011;
let ranks: Rank16 = Rank16::from_u16(i);

assert_eq!(ranks, Rank16::from([Rank::R2, Rank::R3].as_ref()));

pub const fn to_u16(self) -> u16

Returns the inner u16

Examples

use open_pql::Rank16;

let i: u16 = 0b0011;
let ranks: Rank16 = Rank16::from_u16(i);

assert_eq!(i, ranks.to_u16());

pub const fn is_empty(self) -> bool

Checks whether all rank masks are unset

Examples

use open_pql::{Rank, Rank16};

let ranks: Rank16 = Rank16::from(Rank::RA);

assert!(!ranks.is_empty());

pub const fn set(&mut self, r: Rank)

Mark a Rank

Examples

use open_pql::{Rank, Rank16};

let mut ranks: Rank16 = Rank16::default();
ranks.set(Rank::RA);

assert_eq!(ranks, Rank16::from(Rank::RA));

pub const fn unset(&mut self, r: Rank)

Unmark a Rank

Examples

use open_pql::{Rank, Rank16};

let mut ranks: Rank16 = Rank16::from(Rank::RA);
ranks.unset(Rank::RA);

assert_eq!(ranks, Rank16::default());

pub const fn contains_rank(self, r: Rank) -> bool

Checks whether a Rank is marked

Examples

use open_pql::{Rank, Rank16};

let ranks: Rank16 = Rank16::from(Rank::RA);

assert!(ranks.contains_rank(Rank::RA));
assert!(!ranks.contains_rank(Rank::RK));

pub const fn count(self) -> PQLCardCount

Returns the number of marked ranks

Examples

use open_pql::{Rank, Rank16};

let ranks: Rank16 = Rank16::from(Rank::RA);

assert_eq!(ranks.count(), 1);

pub const fn min_rank(self) -> Option<Rank>

Returns smallest Rank in the set

pub const fn max_rank(self) -> Option<Rank>

Returns largest Rank in the set

pub fn nth_rank(self, n: u8) -> Option<Rank>

Returns n-th Rank in the set

pub const fn higher_of(r: Self) -> Self

Returns all higher ranks than the max rank in the set

Trait Implementations

impl BitAnd for Rank16

type Output = Rank16

The resulting type after applying the & operator.

fn bitand(self, rhs: Rank16) -> Rank16

Performs the & operation.

impl BitAndAssign for Rank16

fn bitand_assign(&mut self, rhs: Rank16)

Performs the &= operation.

impl BitOr for Rank16

type Output = Rank16

The resulting type after applying the | operator.

fn bitor(self, rhs: Rank16) -> Rank16

Performs the | operation.

impl BitOrAssign for Rank16

fn bitor_assign(&mut self, rhs: Rank16)

Performs the |= operation.

impl Clone for Rank16

fn clone(&self) -> Rank16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rank16

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

Formats the value using the given formatter.

impl Default for Rank16

fn default() -> Rank16

Returns the “default value” for a type.

impl From<&[Card]> for Rank16

fn from(cs: &[Card]) -> Self

Converts to this type from the input type.

impl From<&[Rank]> for Rank16

fn from(rs: &[Rank]) -> Self

Converts to this type from the input type.

impl From<Card64> for Rank16

fn from(c: Card64) -> Self

Converts to this type from the input type.

impl From<Rank> for Rank16

fn from(r: Rank) -> Self

Converts to this type from the input type.

impl From<Rank16> for VmStackValue

fn from(value: PQLRankSet) -> Self

Converts to this type from the input type.

impl Hash for Rank16

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 Not for Rank16

type Output = Rank16

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Rank16

fn cmp(&self, other: &Rank16) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Rank16

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Rank16

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Rank16

impl Eq for Rank16

impl StructuralPartialEq for Rank16