README

========================================================================
    POKER Hand Distribution parsing and creation
========================================================================

Contains classes for creating hand distributions for Texas Hold'em, Omaha.

Holdem code was written by James Devlin (http://www.codingthewheel.com/archives/multiway-ranged-isometric-equity-calculation-in-poker-1/)
Omaha code is written by Atin M (atinm.dev@gmail.com)

Syntax
======
Holdem Syntax
///////////////////////////////////////////////////////////////////////////////
// The parsing code allows you to specify a Texas Hold'em starting hand devoid
// of specific suit information -- for example, "AKs" for Ace King suited or
// "T9o" for Ten Nine offsuit or "33" for pair of threes. A given
// hand boils down to N *specific* hands, for example, AKs consists of:
//
//          - AsKs
//          - AhKh
//          - AdKd
//          - AcKc
//
// An hand can also include range information. For example:
//
//          - A2s+
//          - 77+
//          - JJ-88
//          - T8o-64o
//
///////////////////////////////////////////////////////////////////////////////

Omaha Syntax
///////////////////////////////////////////////////////////////////////////////
// Single hands
// To specify a single hand for example type AsQc7h3d
//
// All combos of a hand
// To get all 16 combos of a hand, for example an A, K, Q and a J, enter
// AKQJ without suits.
//
// Suits
// To specify suited cards, enclosing them in square brackets, e.g. [AK]xx will
// give all hands containing suited AK and two other cards.
// [AK][AK] will give A's and K's double suited. [JT][98] will give double
// suited JT98 hands.
// [XXX]X will give all hands with three of a suit.
// [X][X][X][X] will give all hands with four different suits (rainbox).
// To specify off-suit cards, enclose one of the cards in square brackets, e.g.
// [A]KQJ will give all hands with an A of a different suit from all other cards.
// [Ah]KQJ will give all hands with an Ah and all other cards of a different suit.
//
// Pairs
// QQxx will give all hands containing two queens
// [QT+][QT+] double suited queens with two other T+ cards.
//
// Card types
// x = random, all ranks, 2..A
// 2 .. T J Q K A
// [] = group suited cards
//
// Ranges from high to low ranks, e.g. for each of the four cards, you can
// enter a range, e.g. K-Txxx would give Txxx, Jxxx Qxxx, Kxxx, Axxx.
//
// Ranges can be combined for all four cards, e.g. 3+9-7Q+K-T where first card is 3 or
// better, second card is between 7-9, third card is greater than or equal to Q, and
// the fourth cards is between T and K.
//
// Percentile (todo)
// 15% would give the top 15% of hands (ProPokerTools ranking).
// 10-25% would give the top 10% to 25% of hands (ProPokerTools ranking).
//
///////////////////////////////////////////////////////////////////////////////