Documentation

The Rank of a playing Card

>>> allRanks
[Two,Three,Four,Five,Six,Seven,Eight,Nine,Ten,Jack,Queen,King,Ace]

The Suit of a playing Card

>>> allSuits
[Club,Diamond,Heart,Spade]

>>> suitToUnicode <$> [Club, Diamond, Heart, Spade]
"\9827\9830\9829\9824"
>>> suitFromUnicode . suitToUnicode <$> [Club, Diamond, Heart, Spade]
[Just Club,Just Diamond,Just Heart,Just Spade]

>>> suitFromUnicode <$> ['♣', '♦', '♥', '♠']
[Just Club,Just Diamond,Just Heart,Just Spade]

\s -> suitFromUnicode (suitToUnicode s) == Just s

Representation of a playing card.

All cards in a Deck

>>> length allCards
52

Hole represents a player's hole cards in a game of Texas Hold'Em

Returns a Hole if the incoming Cards are unique, else Nothing. Note that mkHole automatically normalises the order of the given Cards. See Hole for details.

\c1 c2 -> mkHole c1 c2 == mkHole c2 c1

\c1 c2 -> (c1 /= c2) ==> isJust (mkHole c1 c2)

All possible valid Holes (the Holes are already normalised).

>>> length allCards * length allCards
2704
>>> length allHoles
1326
>>> Data.List.nub allHoles == allHoles
True
>>> pretty $ take 10 allHoles
[AsAh, AsAd, AhAd, AsAc, AhAc, AdAc, AsKs, AhKs, AdKs, AcKs]

A ShapedHole is the Suit-normalised representation of a poker Hole. For example, the Hole "King of Diamonds, 5 of Hearts" is often referred to as "King-5 offsuit".

To construct a ShapedHole, see mkPair, mkOffsuit, and mkSuited'.

>>> "22p" :: ShapedHole
Pair Two
>>> "A4o" :: ShapedHole
UnsafeOffsuit Ace Four
>>> "KJs" :: ShapedHole
UnsafeSuited King Jack

Build a pair ShapedHole from the given Rank

Returns an offsuit ShapedHole if the incoming Ranks are unique, else Nothing. Note that the internal representation of ShapedHole is normalised:

\r1 r2 -> mkOffsuit r1 r2 == mkOffsuit r2 r1

Returns a suited ShapedHole if the incoming Ranks are unique, else Nothing. Note that mkSuited normalises the order of the incoming Ranks.

\r1 r2 -> mkSuited r1 r2 == mkSuited r2 r1

>>> length allShapedHoles
169
>>> Data.List.nub allShapedHoles == allShapedHoles
True
>>> pretty $ take 15 allShapedHoles
[AAp, AKs, AQs, AJs, ATs, A9s, A8s, A7s, A6s, A5s, A4s, A3s, A2s, AKo, KKp]

>>> holeToShapedHole "AcKd"
UnsafeOffsuit Ace King
>>> holeToShapedHole "AcKc"
UnsafeSuited Ace King
>>> holeToShapedHole "AcAs"
Pair Ace

A Deck of Cards

A unshuffled Deck with all Cards

>>> freshDeck == unsafeDeck allCards
True

The input Cards are not checked in any way.

>>> fmap holeToShortTxt . shapedHoleToHoles $ "55p"
["5d5c","5h5c","5s5c","5h5d","5s5d","5s5h"]
>>> fmap holeToShortTxt . shapedHoleToHoles $ "97o"
["9c7d","9c7h","9c7s","9d7c","9d7h","9d7s","9h7c","9h7d","9h7s","9s7c","9s7d","9s7h"]
>>> fmap holeToShortTxt . shapedHoleToHoles $ "QTs"
["QcTc","QdTd","QhTh","QsTs"]

>>> rankToChr <$> allRanks
"23456789TJQKA"

>>> map (fromJust . chrToRank) "23456789TJQKA"
[Two,Three,Four,Five,Six,Seven,Eight,Nine,Ten,Jack,Queen,King,Ace]
>>> chrToRank 'x'
Nothing

\r -> chrToRank (rankToChr r) == Just r

>>> suitToChr <$> allSuits
"cdhs"

>>> map (fromJust . chrToSuit) "cdhs"
[Club,Diamond,Heart,Spade]
>>> chrToSuit 'x'
Nothing

\s -> chrToSuit (suitToChr s) == Just s

>>> cardToShortTxt "Ac"
"Ac"

>>> cardFromShortTxt "Ac"
Just (Card {rank = Ace, suit = Club})

\c -> cardFromShortTxt (cardToShortTxt c) == Just c

>>> shapedHoleToShortTxt (mkPair Ace)
"AAp"
>>> shapedHoleToShortTxt <$> (mkOffsuit Ace King)
Just "AKo"
>>> shapedHoleToShortTxt <$> (mkSuited Ace King)
Just "AKs"

>>> holeToShortTxt "AcKd"
"AcKd"

First Rank should > than second Rank

First Rank should be > than second Rank

Unsafely create a new Hole. The first Card should be > than the second. See mkHole for a safe way to create a Hole.

>>> holeFromShortTxt "AcKd"
Just (UnsafeHole (Card {rank = Ace, suit = Club}) (Card {rank = King, suit = Diamond}))
>>> ("KdAc" :: Hole) == "AcKd"
True

\h -> holeFromShortTxt (holeToShortTxt h) == Just h