Struct PQLHiRating

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

Hand Ranking

Overview

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

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

with some variations of shortdeck the order of handtype can vary:

• FFH
  • Flush > FullHouse > Straight > Trips
• TS
  • Flush > FullHouse > Trips > Straight

Rank representation:

• Rank as index value
  • 0b0000 is Duece 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:

positive i16 values:

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

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

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

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

`Straight`:
[15, 0]:   000ssss0 00000000 // s: rank of highest card

negative i16 values:

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

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

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

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

Implementations

impl PQLHiRating

pub const MAX: Self

pub const MIN: Self

pub const fn new(i: HandRatingInt) -> Self

pub const fn to_i16(self) -> i16

pub fn to_hand_type(self, game: PQLGame) -> PQLHandType

pub fn to_hand_type_and_low_high_ranks( self, game: PQLGame, ) -> (PQLHandType, PQLRankSet, PQLRankSet)

Trait Implementations

impl Clone for PQLHiRating

fn clone(&self) -> PQLHiRating

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PQLHiRating

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

Formats the value using the given formatter.

impl Default for PQLHiRating

fn default() -> Self

Returns the “default value” for a type.

impl From<PQLHiRating> for VmStackValue

fn from(value: PQLHiRating) -> Self

Converts to this type from the input type.

impl Ord for PQLHiRating

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

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

fn partial_cmp(&self, other: &PQLHiRating) -> 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<'a> TryFrom<&'a VmValue> for &'a PQLHiRating

type Error = PQLError

The type returned in the event of a conversion error.

fn try_from(value: &'a VmValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut VmValue> for &'a mut PQLHiRating

type Error = PQLError

The type returned in the event of a conversion error.

fn try_from(value: &'a mut VmValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<VmStackValue> for PQLHiRating

type Error = TryIntoError<VmStackValue>

The type returned in the event of a conversion error.

fn try_from(value: VmStackValue) -> Result<Self, TryIntoError<VmStackValue>>

Performs the conversion.

impl Copy for PQLHiRating

impl Eq for PQLHiRating

impl StructuralPartialEq for PQLHiRating