Struct HandRating 

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

Hand Ranking

Overview

this is used for holdem omaha and shortdeck there are 10 hand types:

• RoyalFlush
• StraightFlush
• Quads
• FullHouse
• Flush
• Straight
• Trips
• TwoPair
• Pair
• HighCard

Rank representation:

• Rank as index value
  • 0b0000 is Deuce and 0b1100 is Ace
• Combination of two ranks
  • nCr(13, 2) is 78 so the index of combination can be fitted in 7 bits
• Combination of three ranks
  • nCr(13, 3) is 286 so the index of combination can be fitted in 9 bits
• Combination of five ranks
  • we just use the 13 bit flags

Memory Layout:

u16

`RoyalFlush`/`StraightFlush`
[15, 0]:   1110ssss 00000000 // s: rank of highest card

`Quads`:
[15, 0]:   11100000 qqqqkkkk // q: rank of quads; k: rank of kicker

`FullHouse`:
[15, 0]:   11011111 ttttpppp // q: rank of trips; k: rank of pair
[15, 0]:   10111111 ttttpppp // shortdeck

`Flush`:
[15, 0]:   101rrrrr rrrrrrrr // r: set bit of 5 cards and zeros of the rest
[15, 0]:   111rrrrr rrrrrrrr // shortdeck

`Straight`:
[15, 0]:   10000000 0000ssss // s: rank of highest card

`Trips`:
[15, 0]:   0110tttt 0kkkkkkk // t: rank of trips; k: index of combination

`TwoPair`:
[15, 0]:   01000ppp ppppkkkk // p: index of combination; k: rank of kicker

`Pair`:
[15, 0]:   001ppppk kkkkkkkk // p: rank of pair; k: index of combination

`HighCard`:
[15, 0]:   000rrrrr rrrrrrrr // r: bit flags of 5 cards

Trait Implementations

impl Clone for HandRating

fn clone(&self) -> HandRating

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HandRating

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

Formats the value using the given formatter.

impl Default for HandRating

fn default() -> HandRating

Returns the “default value” for a type.

impl Display for HandRating

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

Formats the value using the given formatter.

impl From<HandRating> for HandType

fn from(hand_ranking: HandRating) -> Self

Extracts the categorical hand type from a HandRanking.

This implementation decodes the bit-packed HandRanking to determine the hand type. It uses bit masking to identify the hand category from the upper bits and additional bit checks to distinguish between hands that share the same mask (e.g., Flush vs FullHouse, Quads vs StraightFlush).

impl Ord for HandRating

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

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

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

impl Eq for HandRating

impl StructuralPartialEq for HandRating