API

Suit

Encode a suit as a 2-bit value (low bits of a UInt8):

• 0 = ♣ (clubs)
• 1 = ♢ (diamonds)
• 2 = ♡ (hearts)
• 3 = ♠ (spades)

Suits have global constant bindings: ♣, ♢, ♡, ♠.

Card

Encode a playing card as a 6-bit integer (low bits of a UInt8):

• low bits represent rank from 0 to 15
• high bits represent suit (♣, ♢, ♡ or ♠)

Ranks are assigned as follows:

• numbered cards (2 to 10) have rank equal to their number
• jacks, queens and kings have ranks 11, 12 and 13
• there are low and high aces with ranks 1 and 14, 0 is for Joker
• there are low and high jokers with ranks 0 and 15

This allows any of the standard orderings of cards ranks to be achieved simply by choosing which aces to use.

There are a total of 64 possible card values with this scheme, represented by UInt8 values 0x00 through 0x3f.

suit(::Card)

The suit of a card

rank(::Card)

The rank of a card

high_value(::Card)
high_value(::Rank)

The high rank value. For example:

• Rank(1) -> 14 (use low_value for the low Ace value.)
• Rank(5) -> 5

low_value(::Card)
low_value(::Rank)

The low rank value. For example:

• Rank(1) -> 1 (use high_value for the high Ace value.)
• Rank(5) -> 5

color(::Card)

A Symbol (:red, or :black) indicating the color of the suit or card.

full_deck

A vector of a cards containing a full deck

ranks

A Tuple of ranks 1:13.

suits

A Tuple of all suits

Deck

Deck of cards (backed by a Vector{Card})

ordered_deck

An ordered Deck of cards.

pop!(deck::Deck, n::Int = 1)
pop!(deck::Deck, card::Card)

Remove n cards from the deck. or Remove card from the deck.

shuffle!

Shuffle the deck! Optionally accepts an AbstractRNG to seed the shuffle.