Function Name | Argument Types | Return Type | Description |
---|---|---|---|
bestHiRating | TPlayer, TStreet | TBoolean | Returns true if no other hand has a better hi on the given street. For instance, where p1='AK', p2='JT', board='AsKsQhJdTc', bestHiRating(p1, flop) is true, bestHiRating(p2, turn) is false, and bestHiRating(p2, river) is true. |
bestLoRating | TPlayer, TStreet | TBoolean | Returns true if we have a lo and no other hand has a better lo on the given street. For instance, in stud-8 where p1='2356798', p2='23568qa', bestLoRating(p1, fifth) is true, bestHiRating(p1, sixth) is true, and bestHiRating(p1, seventh) is false. |
boardAllowsMadeLo | TStreet | TBoolean | Returns true if a made low is possible on the given street. |
boardHasOneDistinctLoCard | TStreet | TBoolean | Returns true if there is exactly one distinct lo card on the given street. |
boardHasTwoDistinctLoCards | TStreet | TBoolean | Returns true if there are exactly two distinct lo cards on the given street. |
boardInRange | TBoardRange | TBoolean | Returns true if the board is in the given range. For instance, if the board is 'AsKdJhKc3s', then boardInRange('AKK') is false, boardInRange('AKJ3K') is false, and boardInRange('KJAK3') is true. Note that card order is only relevant on the turn and river. |
boardLoCardCount | TStreet | TCardCount | Returns the number of distinct lo cards on the board for the given street without regard to suit. For instance, if the board is 'Ks8c7c7s2d', distinctLoBoardCardCount(flop) = 2, distinctLoBoardCardCount(turn) = 2, and distinctLoBoardCardCount(river) = 3 |
boardRanks | TStreet | TRankSet | Returns the ranks that are on the board for the given street |
boardSuitCount | TStreet | TCardCount | Flop games only. Returns the number of different suits on the board for a given street. For instance, if board='KsJsTc9d8s', boardSuitCount(flop) = 2, boardSuitCount(turn) = 3, and boardSuitCount(river) = 4 |
cardsPlay | TPlayer, TStreet | TCardCount | Returns the number of cards (2, 1, or 0) in a player's hold'em hand that play on the turn or river. For instance, on KsJsTd4c2d with KdJd 2 cards play on the river, whereas with Kd3c only one card plays on the river (the king). If a card is duplicated on the board, it is not considered to play; on AsKsQdJdTc with JhTh 0 cards play on the river. |
duplicatedBoardRanks | TStreet | TRankSet | Returns a set of all ranks that are duplicated on the given street. |
duplicatedHandRanks | TPlayer, TStreet | TRankSet | Returns a set of all ranks that appear more than once for the given player on the given street. For flop games, the answer will be the same for all streets. |
equity | TPlayer, TStreet | TEquity | Short for HvHEquity |
exactFlopHandCategory | TPlayer, TFlopHandCategory | TBoolean | Evaluates to true if a player has a particular flop hand category. See flopHandCategory(). |
exactHandType | TPlayer, TStreet, THandType | TBoolean | Evaluates to true if a player has a certain type of hand on a given street. For instance, exactHandType(playerOne, flop, pair) evaluates to true if player one has a pair on the flop. |
fiveCardHiHandNumber | TPlayer, TStreet | TInteger | Returns a number between 1 and and 7,462 for a given player and street based on the absolute strength of the best 5-card hand. For instance, if player one holds AsKs and the board is QsJsTs, this returns 1, whereas Ks9s would return 2, 9s8s would return 3, As9s would return 4, and so on. |
flopHandCategory | TPlayer | TFlopHandCategory | Returns the flop hand category for a particular player. This gives more specific information than the handType function. For instance, if P1 has AK on a JJ4 flop, his handType on the flop is one pair (jacks), but his flopHandCategory is nothing, since he missed the flop |
flushingBoard | TStreet | TBoolean | Flop games only. Evaluates to true if a flush is possible. With a board of ks7d4s7s3s, flushingBoard(flop) is false, flushingBoard(turn) is true and flushingBoard(river) is true. |
fourFlush | TPlayer, TStreet | TBoolean | Flop games only. Given a player and a street (one of flop or turn), evaluates to true if the player has at least one four flush. For example, fourFlush(p1, flop) would return true for a holdem hand of AhKh and a board of JhTh9s. Note that for hold'em, at least one of the player's cards must play. |
fractionalRiverEquity | TPlayer | TFraction | Returns the fraction of the pot a player wins on the river, such as 2/3 or 1/4 |
handBoardIntersections | TPlayer, TStreet | TCardCount | Flop games only. Computes the number of cards in a player's hand that have the same rank as a card on the board. If p1='AsKd' and the board is '2d8s9dAhKs', then boardIntersections(p1, flop) = 0, boardIntersections(p1, turn) = 1, and boardIntersections(p1, river) = 2. |
handRanking | TPlayer | THandRanking | Returns a handRanking for the default (full-ring) ranking. See handRankingFor(). |
handRankingFor | TPlayer, TString | THandRanking | Returns a hand ranking between 1 and 100 for a given ranking name with 1 being the best. For instance, in hold'em, handRankingFor(p1, '10h') = 1 if p1 = 'AA', and handRanking(p1, '10h') = 100 if p1='7s2c' |
handRanks | TPlayer, TStreet | TRankSet | Returns the hand ranks for the given player on the given street. For flop games, the answer will be the same for all streets. |
handType | TPlayer, TStreet | THandType | Gives the hand type for a given player and street. For instance, given playerOne='KsKhJdJs2c6d9h', handType(playerOne, fifth) evaluates to pair |
hasSecondBoardRank | TPlayer, TStreet | TBoolean | Returns true if the given player has the second-highest board rank on the given street. Returns false if only one rank on the board. |
hasTopBoardRank | TPlayer, TStreet | TBoolean | Returns true if the given player has at least one card matching the largest rank on the board for the given street. |
hiRating | TPlayer, TStreet | THiRating | Hi and hi/lo games only. Returns a rating indicating the relative strength of the best hi hand. Useful for comparing hand strengths throughout a hand. This rating has no meaning on its own - as such it is only useful when compared to other hands in the same game. For instance, in stud, where p1='2s5s9stsjdQsAh', and p2='7h7d9c9d3s3c3d', hiRating(p1, fifth) < hiRating (p2, fifth), hiRating(p1, sixth) > hiRating(p2, sixth), and hiRating(p1, seventh) < hiRating(p2, seventh). |
HvHEquity | TPlayer, TStreet | TEquity | Flop games only. Computes exact hand vs. hand equity for a given player on a given street. For example, HvHEquity(playerOne, flop) gives the equity for playerOne's hand on the flop vs. every one else's hand on the flop. |
HvPerceivedRangeEquity | TPlayer, TStreet, TRange | TEquity | Computes the randomized heads-up hand vs. range equity on the given street for the given player against a perceived range using max 10000 trials and max 10 seconds. For instance, HvPerceivedRangeEquity(p1, flop, 'AA-TT') gives the equity for the specific hand dealt to p1 on the flop against the range 'AA-TT'. For flop games, the random hands and complete board are generated, the board is trimmed to the appropriate size for the given street, and a hand vs. range simulation is performed. |
HvREquity | TPlayer, TStreet | TEquity | Computes the randomized hand vs. range equity on the given street for the given player using max 10000 trials and max 10 seconds. For instance, HvREquity(p1, flop) gives the equity for the specific hand dealt to p1 on the flop against the ranges given for every other player. For flop games, the random hands and complete board are generated, the board is trimmed to the appropriate size for the given street, and a hand vs. range simulation is performed. For stud games, each player is dealt a hand in their range, then cards are added to bring their hand size up to the given street, with face-up cards for street 4-6 and face down for street 7. Then, a hand vs range simulation is performed with the specified player's hand vs the opponents hand ranges with the additional up-cards added. |
inRange | TPlayer, TRange | TBoolean | Evaluates to true if the hand dealt to a certain player falls within a given range. For instance, given playerOne = 'KK', inRange(playerOne, 'K*') evaluates to true, while inRange(playerOne, 'QJ') evaluates to false. Range weights (aka 'AK@10,AQ@2') are ignored in this function. |
intersectingHandRanks | TPlayer, TStreet | TRankSet | Returns a RankSet of all ranks in the given player's hand that match the board on the given street. |
loRating | TPlayer, TStreet | TLoRating | Lo and hi/lo games only. Returns a rating indicating the relative strength of the best lo hand. If no lo is possible, a rating lower than all other low ratings is returned. Useful for comparing hand strengths throughout a hand. This rating has no meaning on its own - as such it is only useful when compared to other hands in the same game. For instance, in stud8, where p1='Ac3c5c7c8c9c2c', and p2='As3s5s7sTc2sJs', loRating(p1, fifth) > loRating (p2, fifth), loRating(p1, sixth) < loRating(p2, sixth), and loRating(p1, seventh) = loRating(p2, seventh). |
madeLo | TPlayer, TStreet | TBoolean | Given a player and a street (one of flop, turn, or river), evaluates to true if the player made a lo. For example, madeLo(p1, flop) would return true where p1='A399' and board='7s6c4d' |
maxRank | TRankSet | TRank | Returns the maximum rank in a set. Will fail on an empty rank set. |
minEquity | TPlayer, TStreet, TDouble | TBoolean | Synonym for minHVHEquity. |
minFlopHandCategory | TPlayer, TFlopHandCategory | TBoolean | Evaluates to true if a player has a certain minimum type of flop hand category. See flopHandCategory(). |
minHandType | TPlayer, TStreet, THandType | TBoolean | Evaluates to true if a player has a certain minimum type of hand on a given street. For instance, minHandType(playerOne, flop, pair) evaluates to true if player one has at least a pair on the flop. |
minHiRating | TPlayer, TStreet, THiRating | TBoolean | Returns true if the player equals or beats the given hand rating on the given street. For instance, minHiRating(player, flop, someHandRating) |
minHvHEquity | TPlayer, TStreet, TDouble | TBoolean | Flop games only. Evaluates to true if a player has a certain minimum amount of hand vs. hand equity on a given street. For instance, minHVHEquity(playerOne, flop, 0.5) evaluates to true if player one's hand has at least 50% equity on the flop against the other hands dealt on the flop. |
minHvPerceivedRangeEquity | TPlayer, TStreet, TRange, TDouble | TBoolean | Returns true if a certain player has a minimium amount of equity vs. a perceived range. See HvPerceivedRangeEquity |
minHvREquity | TPlayer, TStreet, TDouble | TBoolean | Evaluates to true if a player has a certain minimum amount of hand vs. hand equity on a given street. For instance, minHvREquity(playerOne, flop, 0.5) evaluates to true if player one's hand has at least 50% equity on the flop against the other hand ranges (not hands) on the flop. |
minLoRating | TPlayer, TStreet, TLoRating | TBoolean | Returns true if the player equals or beats the given hand rating on the given street. For instance, minLoRating(player, flop, someHandRating) |
minOutsToHandType | TPlayer, TStreet, THandType, TInteger | TBoolean | Flop games only. Given a player, a street (one of flop or turn), a handType, and a number of outs, evaluates to true if the player has at least that many outs to make the given hand type. See outsToHandType. |
minRank | TRankSet | TRank | Returns the minimum rank in a set. Will fail on an empty rank set. |
monotoneBoard | TStreet | TBoolean | Flop games only. Returns true if the board has only one suit. Equivalent to 'suitCount(street) = 1' |
nonIntersectingHandRanks | TPlayer, TStreet | TRankSet | Returns a RankSet of all ranks in the given player's hand that do not match the board on the given street. |
nthRank | TInteger, TRankSet | TRank | Returns rank number N from a rank set, starting from the top. For instance, if the board is 'AsKdJh', then nthRank(1, boardRanks(flop)) = toRank('A'), nthRank(2, boardRanks(flop)) == toRank('K'), and nthRank(3, boardRanks(flop)) = toRank('J') |
nutHi | TPlayer, TStreet | TBoolean | Flop games only. Evaluates to true if a given player has the nuts on a given street. For instance, nutHi(p1, flop) returns true for p1='Qs5s', board='JsKsAs'. It is assumed that any dead cards are known (so that nutHi(p1, flop) for p1='As2s', board='KsQsJs' is false, but adding dead='Ts' would make it true). |
nutHiForHandType | TPlayer, TStreet | TBoolean | Flop games only. Returns true if the given player has the best possible hand for his hand type. For instance, nutHiForHandType(p1, flop) returns true for p1 = AsKh and flop = AdTd2d because p1 has the best possible hand with handType onepair. |
nutHiOuts | TPlayer, TStreet | TCardCount | Flop games only. Returns the number of nut hi outs on the given street. For instance, in hold'em with p1='KsJs' and board='QdTd4c', nutHiOuts(p1, flop) = 6. |
nutLo | TPlayer, TStreet | TBoolean | Flop games only. Given a player and a street (one of flop, turn, or river), evaluates to true if the player made the lo. For example, nutLo(p1, flop) would return true where p1='A399' and board='7s6c2d', but false for board='7s6c2d3h' |
nutLoOuts | TPlayer, TStreet | TCardCount | Flop games only. Returns the number of nut lo outs on the given street. For instance, in omaha hi/lo with p1='A299' and board='Qd8c4c8d', nutLoOuts(p1, turn) = 15. |
outsToHandType | TPlayer, TStreet, THandType | TCardCount | Flop games only. Given a player, a street (one of flop or turn), and a handType, evaluates to the number of cards that would give the player that hand type on the next card that is better than the current hand. For example, outsToHandType(p1, flop, straight) with p1='JsTh' and board='9h8s2c' would evaluate to 8 (if 7s were a dead card, it would evaluate to 7 instead of 8.). outsToHandType(p1, turn, straight) with p1='Th9h' and board='8h7h2c3c' would evaluate to 6 (because two of the 'straight' outs gives straight-flush instead of straight). outsToHandType(p1, flop, straight) with p1='Td9d' and board ='8d7d2d' evaluates to 0, because p1 already beats a straight. |
overpair | TPlayer, TStreet | TBoolean | Returns true if the given player's hand has at least two cards of the same rank that are larger than the largest rank on the board. |
pairedBoard | TStreet | TBoolean | Flop games only. Evaluates to true if at least two cards have the same rank on the board. With a board of ks7d4c7h3s, pairedBoard(flop) is false, pairedBoard(turn) is true and pairdBoard(river) is true. |
pocketPair | TPlayer | TBoolean | Returns true if the given player's hand has at least two cards of the same rank. |
rainbowBoard | TStreet | TBoolean | Flop games only. Evaluates to true if no suit is repeated on the board. With a board of ks7d4c7s3s, rainbowBoard(flop) is true, but rainbowBoard(turn) is false. |
rankCount | TRankSet | TCardCount | Returns the number of ranks in a RankSet |
rateHiHand | TString | THiRating | Given a string of five cards, returns a Hi rating that can be used to compare with other Hi ratings |
rateLoHand | TString | TLoRating | Given a string of five cards, returns a Lo rating that can be used to compare with other Lo ratings rateLoHand uses the rules of the game in determining the lo. . |
riverCard | TCard | Returns the card on the river | |
riverEquity | TPlayer | TEquity | Computes hand vs. hand equity after the last card has been dealt. |
scoops | TPlayer | TBoolean | scoops(playerOne) evaluates to true if playerOne wins the entire pot. |
straightBoard | TStreet | TBoolean | Flop games only. Evaluates to true if a straight is possible. With a board of Js9s2c8d7s, straightBoard(flop) is false, straightBoard(turn) is true, and straightBoard(river) is true. |
threeFlush | TPlayer, TStreet | TBoolean | Flop games only. Given a player and a street, evaluates to true if the player has at least one three-flush. For example, threeFlush(p1, flop) would return true for a holdem hand of AhKh and a board of Jh2c3d. Note that for hold'em, at least one of the player's cards must play. |
tiesHi | TPlayer | TBoolean | tiesHi(playerOne) evaluates to true if playerOne ties for the high half of the pot with at least one other player. |
tiesLo | TPlayer | TBoolean | tiesLo(playerOne) evaluates to true if playerOne ties for the low half of the pot with at least one other player. |
toCard | TString | TCard | Parses a single card string into a Card. For instance, toCard('As') |
toRank | TString | TRank | Given a rank string, such as 'A', returns a Rank. |
toString | Type | TString | Returns the string representation of the argument passed. |
turnCard | TCard | Returns the card on the turn | |
twoToneBoard | TStreet | TBoolean | Flop games only. Returns true if the board has exactly two suits. Equivalent to 'suitCount(street) = 2' |
upCard | TPlayer, TStreet | TCard | Returns the up-card for the given player and street. |
winningHandType | THandType | Returns the hand type of the winning hand. For instance, winningHandType() with a board of 'KsQsJs2c4d' and handone='KK' and handtwo='5s6s' would evaluate to flush. | |
winsHi | TPlayer | TBoolean | winsHi(playerOne) evaluates to true if playerOne wins the entire high half of the pot. |
winsLo | TPlayer | TBoolean | winsLo(playerOne) evaluates to true if playerOne wins the entire low half of the pot. |
Click here to return to the main documentation page
Contact us · | Privacy Policy · | Blog | Follow @propokertools |