Cardrank

https://pkg.go.dev/github.com/cardrank/cardrank
Admin
Cardrank is a Go library for working with playing cards, card decks, evaluating poker hand ranks,...
Tokens:46,425
Snippets:361
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Draw Output

Source: https://pkg.go.dev/github.com/cardrank/cardrank

This is an example output showing the cards drawn from a deck.

```text
Output:
[9♣ 6♥ Q♠ 3♠ J♠ 9♥ K♣]
```

--------------------------------

### Get Starting Eval Rank for Pocket Cards

Source: https://pkg.go.dev/github.com/cardrank/cardrank

StartingEvalRank returns the worst (highest) possible resulting 5-card rank for the given pocket cards. For example, a single King would be the highest non-Straight and non-Flush value between Pair and HighCard.

```go
func StartingEvalRank(pocket []Card) EvalRank
```

--------------------------------

### func HoldemStarting

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the starting Holdem pockets.

```APIDOC
## HoldemStarting

### Description
Returns the starting Holdem pockets as a map of expected values and evaluation ranks.

### Response
- **map[string]ExpValue** - Map of pocket strings to expected values
- **map[string]EvalRank** - Map of pocket strings to evaluation ranks
```

--------------------------------

### Example ExpValueCalc Output

Source: https://pkg.go.dev/github.com/cardrank/cardrank

This example shows the typical output format for an expected value calculation using ExpValueCalc.

```text
Output:
expected value: 75.6% (802371,13659/1070190)
```

--------------------------------

### Install cardrank

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Command to add the cardrank package to your Go project.

```bash
go get github.com/cardrank/cardrank
```

--------------------------------

### Holdem Evaluation Output Examples

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Sample output demonstrating the evaluation of Holdem hands.

```text
Output:
------ Holdem 1 ------
Board:    [J♠ T♠ 2♦ 2♠ Q♥]
Player 1: [6♦ 7♠] Pair, Twos, kickers Queen, Jack, Ten [2♦ 2♠ Q♥ J♠ T♠] [7♠ 6♦]
Player 2: [8♠ 4♣] Pair, Twos, kickers Queen, Jack, Ten [2♦ 2♠ Q♥ J♠ T♠] [8♠ 4♣]
Result:   Players 1, 2 push with Pair, Twos, kickers Queen, Jack, Ten
------ Holdem 2 ------
Board:    [8♠ 9♠ J♠ 9♣ T♠]
Player 1: [7♠ 6♦] Straight Flush, Jack-high, Bronze Fist [J♠ T♠ 9♠ 8♠ 7♠] [9♣ 6♦]
Player 2: [T♣ Q♠] Straight Flush, Queen-high, Silver Tongue [Q♠ J♠ T♠ 9♠ 8♠] [T♣ 9♣]
Result:   Player 2 wins with Straight Flush, Queen-high, Silver Tongue
------ Holdem 3 ------
Board:    [A♠ T♣ K♠ J♣ 6♥]
```

--------------------------------

### Get Example Hand Ranks

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns a slice of example hand ranks, ordered from lowest to highest for the type. Added in v0.15.1.

```go
func (typ Type) Examples() []Eval
```

--------------------------------

### Get Win description

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Retrieves the evaluation descriptions for a win.

```go
func (win *Win) Desc() []*EvalDesc
```

--------------------------------

### Get Stud Blinds

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the Stud blind names.

```go
func StudBlinds() []string
```

--------------------------------

### Get Win verb

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the verb associated with the win.

```go
func (win *Win) Verb() string
```

--------------------------------

### Create Starting ExpValue from Pocket Cards

Source: https://pkg.go.dev/github.com/cardrank/cardrank

StartingExpValue returns the initial expected value based on a player's pocket cards.

```go
func StartingExpValue(pocket []Card) *ExpValue
```

--------------------------------

### Get Deck

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns a new deck for the specified hand type.

```go
func (typ Type) Deck() *Deck
```

--------------------------------

### Get Expected Value as Percentage

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Percent calculates and returns the expected value as a percentage.

```go
func (expv *ExpValue) Percent() float64
```

--------------------------------

### Badugi Evaluation Output Examples

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Sample output demonstrating the evaluation of Badugi hands across multiple rounds.

```text
Output:
------ Badugi 1 ------
Player 1: [K♥ J♣ A♥ Q♠] Queen, Jack, Ace-low [Q♠ J♣ A♥] [K♥]
Player 2: [7♣ 4♣ 5♠ 2♠] Four, Two-low [4♣ 2♠] [7♣ 5♠]
Result:   Player 1 wins with Queen, Jack, Ace-low
------ Badugi 2 ------
Player 1: [3♠ 3♦ T♠ Q♠] Ten, Three-low [T♠ 3♦] [Q♠ 3♠]
Player 2: [6♦ Q♣ 8♥ 6♣] Queen, Eight, Six-low [Q♣ 8♥ 6♦] [6♣]
Player 3: [Q♦ K♠ 8♣ A♥] King, Queen, Eight, Ace-low [K♠ Q♦ 8♣ A♥] []
Player 4: [K♦ T♦ 8♦ 4♥] Eight, Four-low [8♦ 4♥] [K♦ T♦]
Player 5: [J♦ 2♥ Q♥ 6♠] Jack, Six, Two-low [J♦ 6♠ 2♥] [Q♥]
Result:   Player 3 wins with King, Queen, Eight, Ace-low
------ Badugi 3 ------
Player 1: [K♠ Q♠ 4♣ J♦] Queen, Jack, Four-low [Q♠ J♦ 4♣] [K♠]
Player 2: [J♠ 3♣ 8♥ 2♠] Eight, Three, Two-low [8♥ 3♣ 2♠] [J♠]
Player 3: [3♠ T♠ 2♣ Q♦] Queen, Three, Two-low [Q♦ 3♠ 2♣] [T♠]
Player 4: [5♣ 5♥ T♦ 2♦] Five, Two-low [5♥ 2♦] [T♦ 5♣]
Player 5: [7♠ 3♥ 6♠ A♣] Six, Three, Ace-low [6♠ 3♥ A♣] [7♠]
Player 6: [4♠ 8♦ K♦ T♣] Ten, Eight, Four-low [T♣ 8♦ 4♠] [K♦]
Result:   Player 5 wins with Six, Three, Ace-low
------ Badugi 4 ------
Player 1: [6♠ K♥ A♣ 8♣] King, Six, Ace-low [K♥ 6♠ A♣] [8♣]
Player 2: [Q♥ 4♥ J♣ 5♥] Jack, Four-low [J♣ 4♥] [Q♥ 5♥]
Player 3: [2♣ 6♥ 5♣ Q♠] Queen, Six, Two-low [Q♠ 6♥ 2♣] [5♣]
Player 4: [9♠ J♥ K♠ J♠] Jack, Nine-low [J♥ 9♠] [K♠ J♠]
Player 5: [3♦ 4♦ K♣ 8♦] King, Three-low [K♣ 3♦] [8♦ 4♦]
Player 6: [T♣ Q♦ A♠ 7♥] Queen, Ten, Seven, Ace-low [Q♦ T♣ 7♥ A♠] []
Result:   Player 6 wins with Queen, Ten, Seven, Ace-low
------ Badugi 5 ------
Player 1: [3♦ 4♦ 5♦ J♣] Jack, Three-low [J♣ 3♦] [5♦ 4♦]
Player 2: [T♥ J♠ K♠ 2♣] Jack, Ten, Two-low [J♠ T♥ 2♣] [K♠]
Player 3: [A♣ 9♠ T♠ 3♠] Three, Ace-low [3♠ A♣] [T♠ 9♠]
Player 4: [7♦ 3♣ 8♠ 7♣] Eight, Seven, Three-low [8♠ 7♦ 3♣] [7♣]
Player 5: [5♣ Q♠ J♥ 2♠] Jack, Five, Two-low [J♥ 5♣ 2♠] [Q♠]
Player 6: [6♠ 7♠ 7♥ 2♥] Six, Two-low [6♠ 2♥] [7♥ 7♠]
Result:   Player 4 wins with Eight, Seven, Three-low
```

--------------------------------

### HoldemStarting Function Signature

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Function signature for HoldemStarting, which returns starting Holdem pockets and their evaluation ranks.

```go
func HoldemStarting() (map[string]ExpValue, map[string]EvalRank)
```

--------------------------------

### All: Get All Cards in Deck

Source: https://pkg.go.dev/github.com/cardrank/cardrank

All returns a copy of all cards currently in the deck without altering the deck's state.

```go
func (d *Deck) All() []Card
```

--------------------------------

### Get Card Suit Byte Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's suit as a byte. This is a compact representation of the suit.

```go
func (c Card) SuitByte() byte
```

--------------------------------

### Get Top Payout Proportion

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the proportion of paid rankings for the tournament payout table.

```go
func (typ Type) Top() float64
```

--------------------------------

### Get Stakes and Payout Details

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the paid levels as [low, high) ranges, the tournament table value per level, the calculated payouts per level, and the total amount paid, based on entries, buy-in, guaranteed amount, and rake.

```go
func (typ Type) Stakes(entries int, buyin, guaranteed int64, rake float64) ([][2]int, []float64, []int64, int64)
```

--------------------------------

### Get Maximum Entries for Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the maximum number of entries supported by the tournament payout table.

```go
func (typ Type) EntriesMax() int
```

--------------------------------

### Create new Win

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Initializes a new Win instance.

```go
func NewWin(evs []*Eval, order []int, pivot int, low, scoop bool, names []string) *Win
```

--------------------------------

### Run: Get Current Game Run

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Run returns the current game run, including an integer identifier and a pointer to the Run object.

```go
func (d *Dealer) Run() (int, *Run)
```

--------------------------------

### Initialize Package

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Initializes the tournament payout tables.

```go
func Init() error
```

--------------------------------

### Get Payout Amount by Level and Entries

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Calculates and returns the payout amount for a given level and number of entries from the tournament payout table.

```go
func (typ Type) Amount(level, entries int) float64
```

--------------------------------

### Get Eval Rank Name

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Use Name to retrieve the string name of an evaluation rank. Examples include 'StraightFlush' and 'FourOfAKind'.

```go
func (r EvalRank) Name() string
```

```text
StraightFlush
FourOfAKind
```

--------------------------------

### Build Configuration Tags

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Use Go build tags to optimize binary size and performance for different environments.

```bash
go build -tags portable
```

```bash
GOOS=js GOARCH=wasm go build -tags embedded
```

```bash
GOOS=js GOARCH=wasm go build -tags 'embedded noinit' -o cardrank.wasm
```

```bash
GOOS=js GOARCH=wasm go build -tags 'forcefat' -o cardrank.wasm
```

--------------------------------

### Get Card Suit Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's suit. The Suit type provides further details about the card's suit.

```go
func (c Card) Suit() Suit
```

--------------------------------

### Get Eval Rank Title

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Use Title to retrieve the display title of an evaluation rank. Examples include 'Straight Flush' and 'Four of a Kind'.

```go
func (r EvalRank) Title() string
```

```text
Straight Flush
Four of a Kind
```

--------------------------------

### Get Card Rune Representation Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's unicode playing card rune. This provides a visual representation of the card.

```go
func (c Card) Rune() rune
```

--------------------------------

### Manual Initialization with noinit

Source: https://pkg.go.dev/github.com/cardrank/cardrank

When using the noinit tag, manually initialize the package or register types.

```go
// Set DefaultCactus, DefaultRank based on available implementations:
cardrank.Init()
```

```go
// Set when using a third-party implementation, or experimenting with new
// Cactus implementations:
cardrank.RankCactus = cardrank.CactusFast

// Call RegisterDefaultTypes to register default types
if err := cardrank.RegisterDefaultTypes(); err != nil {
	panic(err)
}
```

--------------------------------

### Calculation Options

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configuration options for running calculations.

```go
type CalcOption func(interface{})
```

```go
func WithActive(active map[int]bool, folded bool) CalcOption
```

```go
func WithBoard(board []Card) CalcOption
```

```go
func WithDeep(deep bool) CalcOption
```

```go
func WithDiscard(discard bool) CalcOption
```

```go
func WithOpponents(opponents int) CalcOption
```

```go
func WithPocketsBoard(pockets [][]Card, board []Card) CalcOption
```

```go
func WithRuns(runs []*Run) CalcOption
```

--------------------------------

### Format: Implement fmt.Formatter Interface

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Format satisfies the fmt.Formatter interface, allowing the Dealer type to be formatted for output.

```go
func (d *Dealer) Format(f fmt.State, verb rune)
```

--------------------------------

### Create New Dealer Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Creates a new dealer for a provided deck and pocket count. Initializes the dealer with the specified game type description and deck.

```go
func NewDealer(desc TypeDesc, deck *Deck, count int) *Dealer
```

--------------------------------

### Get Type Description

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the description of the hand type. Added in v0.8.0.

```go
func (typ Type) Desc() TypeDesc
```

--------------------------------

### Get Deck Type

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the deck type for the hand. Added in v0.9.0.

```go
func (typ Type) DeckType() DeckType
```

--------------------------------

### Compare EvalRanks

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Demonstrates that EvalRank values are comparable and ordered.

```go
fmt.Printf("%t\n", cardrank.StraightFlush < cardrank.FullHouse)

// Output:
// true
```

--------------------------------

### Init Function Signature

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Function signature for Init, which initializes package-level default variables. Must be called manually if the 'noinit' build tag is used.

```go
func Init()
```

--------------------------------

### Get Eval Type Name

Source: https://pkg.go.dev/github.com/cardrank/cardrank

The Name method returns the string name of an EvalType.

```go
func (typ EvalType) Name() string
```

--------------------------------

### Street: Get Current Street Number

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Street returns the number of the current street.

```go
func (d *Dealer) Street() int
```

--------------------------------

### Create New Type Description

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Initializes a new type description. Must be registered with RegisterType before use.

```go
func NewType(id string, typ Type, name string, opts ...TypeOption) (*TypeDesc, error)
```

--------------------------------

### NextId: Get Next Street ID

Source: https://pkg.go.dev/github.com/cardrank/cardrank

NextId returns the identifier for the next street.

```go
func (d *Dealer) NextId() byte
```

--------------------------------

### Format Win

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Satisfies the fmt.Formatter interface for Win.

```go
func (win *Win) Format(f fmt.State, verb rune)
```

--------------------------------

### Set Video definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Video definitions for a type description.

```go
func WithVideo(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### Name: Get Current Street Name

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Name returns the name of the current street.

```go
func (d *Dealer) Name() string
```

--------------------------------

### Implement fmt.Formatter for ExpValue

Source: https://pkg.go.dev/github.com/cardrank/cardrank

The Format method satisfies the fmt.Formatter interface for ExpValue.

```go
func (expv *ExpValue) Format(f fmt.State, verb rune)
```

--------------------------------

### Id: Get Current Street ID

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Id returns the identifier for the current street.

```go
func (d *Dealer) Id() byte
```

--------------------------------

### Get Title of Tournament Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the title of the tournament payout table.

```go
func (typ Type) Title() string
```

--------------------------------

### Set Short definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Short definitions for a type description.

```go
func WithShort(opts ...StreetOption) TypeOption
```

--------------------------------

### Get Street Descriptions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns a slice of street descriptions for the hand type. Added in v0.9.0.

```go
func (typ Type) Streets() []StreetDesc
```

--------------------------------

### Get Type ID

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the unique identifier string for the hand type. Added in v0.9.0.

```go
func (typ Type) Id() string
```

--------------------------------

### Implement fmt.Formatter for EvalType

Source: https://pkg.go.dev/github.com/cardrank/cardrank

The Format method satisfies the fmt.Formatter interface for EvalType.

```go
func (typ EvalType) Format(f fmt.State, verb rune)
```

--------------------------------

### Retrieve Default Types

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the default type descriptions which are automatically registered unless the noinit tag is used.

```go
func DefaultTypes() []TypeDesc
```

--------------------------------

### Get Eval Type Byte Representation

Source: https://pkg.go.dev/github.com/cardrank/cardrank

The Byte method returns the byte representation of an EvalType.

```go
func (typ EvalType) Byte() byte
```

--------------------------------

### Implement fmt.Formatter Interface

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Satisfies the fmt.Formatter interface, allowing the Type to be formatted using fmt.Printf verbs.

```go
func (typ Type) Format(f fmt.State, verb rune)
```

--------------------------------

### Inactive: Get Inactive Positions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Inactive returns a slice of integers representing the inactive positions.

```go
func (d *Dealer) Inactive() []int
```

--------------------------------

### Get Name of Tournament Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the name of the tournament payout table type.

```go
func (typ Type) Name() string
```

--------------------------------

### Run Management

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Structures and methods for managing poker runs.

```go
type Run struct {
	Discard []Card
	Pockets [][]Card
	Hi      []Card
	Lo      []Card
}
```

```go
func NewRun(count int) *Run
```

```go
func (run *Run) CalcStart(low bool) (*Odds, *Odds)
```

```go
func (run *Run) Dupe() *Run
```

--------------------------------

### Get Max Players

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the maximum number of players supported for this hand type. Added in v0.8.0.

```go
func (typ Type) Max() int
```

--------------------------------

### Create New EvalFunc

Source: https://pkg.go.dev/github.com/cardrank/cardrank

New creates a new evaluation function for a given EvalType, board configuration, and options for normalization and lowball play.

```go
func (typ EvalType) New(board int, normalize, low bool) EvalFunc
```

--------------------------------

### Set Swap definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Swap definitions for a type description.

```go
func WithSwap(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### Get Pocket Discard Count

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the total number of pocket cards discarded for the type. Added in v0.9.0.

```go
func (typ Type) PocketDiscard() int
```

--------------------------------

### Deck Management Methods

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Methods for manipulating and querying card deck states.

```go
func (d *Deck) Limit(limit int)
```

```go
func (d *Deck) Remaining() int
```

```go
func (d *Deck) Reset()
```

```go
func (d *Deck) Shuffle(shuffler Shuffler, shuffles int)
```

--------------------------------

### Get Pocket Card Count

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the total number of pocket cards dealt for the type. Added in v0.9.0.

```go
func (typ Type) Pocket() int
```

--------------------------------

### Get Board Discard Count

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the total number of board cards discarded for a given hand type.

```go
func (typ Type) BoardDiscard() int
```

--------------------------------

### Create New Shuffled Dealer Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Creates a new deck and dealer, shuffling the deck multiple times. Returns the dealer with the created deck and pocket count.

```go
func NewShuffledDealer(desc TypeDesc, shuffler Shuffler, shuffles, count int) *Dealer
```

--------------------------------

### Get Card Rank Byte Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's rank as a byte. This is a compact representation of the rank.

```go
func (c Card) RankByte() byte
```

--------------------------------

### Error Handling

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Custom error types and constants for the package.

```go
type Error string
```

```go
const (
	// ErrInvalidId is the invalid id error.
	ErrInvalidId Error = "invalid id"
	// ErrMismatchedIdAndType is the mismatched id and type error.
	ErrMismatchedIdAndType Error = "mismatched id and type"
	// ErrInvalidCard is the invalid card error.
	ErrInvalidCard Error = "invalid card"
	// ErrInvalidType is the invalid type error.
	ErrInvalidType Error = "invalid type"
)
```

```go
func (err Error) Error() string
```

--------------------------------

### StartingEvalRank

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Determines the worst possible 5-card rank for a given pocket of cards.

```APIDOC
## StartingEvalRank

### Description
StartingEvalRank returns the worst (highest) possible resulting 5-card rank for the pocket. For example, a single King would be the highest non-Straight and non-Flush value between Pair and HighCard.

### Signature
```go
func StartingEvalRank(pocket []Card) EvalRank
```

### Parameters
- **pocket** ([]Card) - A slice of cards representing the pocket.

### Returns
- **EvalRank** - The worst possible resulting 5-card rank.
```

--------------------------------

### Get Entries Column Title

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the column title for a given number of entries in the tournament payout table.

```go
func (typ Type) EntriesTitle(entries int) string
```

--------------------------------

### Table Management

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Functions for initializing and registering tournament payout tables.

```APIDOC
## func Init

### Description
Initializes the tournament payout tables.

### Response
- **Returns** (error) - Returns an error if initialization fails.

## func Register

### Description
Registers a new payout table type.

### Parameters
- **typ** (Type) - The type identifier.
- **t** (*Table) - The table structure to register.

### Response
- **Returns** (error) - Returns an error if registration fails.
```

--------------------------------

### Get Entries Column for Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the number of entries for a specific column in the tournament payout table.

```go
func (typ Type) Entries(entries int) int
```

--------------------------------

### PocketUp: Get Number of Pocket Cards to Turn Up

Source: https://pkg.go.dev/github.com/cardrank/cardrank

PocketUp returns the number of pocket cards to be turned up on the current street.

```go
func (d *Dealer) PocketUp() int
```

--------------------------------

### PocketDraw: Get Number of Pocket Cards to Draw

Source: https://pkg.go.dev/github.com/cardrank/cardrank

PocketDraw returns the number of pocket cards that can be drawn on the current street.

```go
func (d *Dealer) PocketDraw() int
```

--------------------------------

### TypeOption Configuration API

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configuration options for creating custom game types.

```APIDOC
## TypeOption Configuration API

### Description
Provides a set of functional options to configure custom card game types when creating `TypeDesc` objects.

### Type `TypeOption`

These functions return `TypeOption` values that can be passed to `NewType` to customize game rules and properties.

#### Specific Game Variants:

- **`WithBadugi(opts ...StreetOption) TypeOption`**: Configures options for Badugi.
- **`WithCourchevel(low bool, opts ...StreetOption) TypeOption`**: Configures options for Courchevel (lowball variant possible).
- **`WithDallas(low bool, opts ...StreetOption) TypeOption`**: Configures options for Dallas (lowball variant possible).
- **`WithDallasDouble(opts ...StreetOption) TypeOption`**: Configures options for Dallas Double.
- **`WithDouble(opts ...StreetOption) TypeOption`**: Configures options for a generic double game.
- **`WithDraw(low bool, opts ...StreetOption) TypeOption`**: Configures options for a draw game (lowball variant possible).
- **`WithFusion(low bool, opts ...StreetOption) TypeOption`**: Configures options for Fusion (lowball variant possible).
- **`WithHoldem(low bool, opts ...StreetOption) TypeOption`**: Configures options for Texas Hold'em (lowball variant possible).
- **`WithHouston(low bool, opts ...StreetOption) TypeOption`**: Configures options for Houston (lowball variant possible).
- **`WithJakarta(opts ...StreetOption) TypeOption`**: Configures options for Jakarta.
- **`WithKuhn(opts ...StreetOption) TypeOption`**: Configures options for Kuhn Poker.
- **`WithLeduc(opts ...StreetOption) TypeOption`**: Configures options for Leduc Hold'em.
- **`WithLowball(multi bool, opts ...StreetOption) TypeOption`**: Configures options for a generic lowball game (multi-hand possible).
- **`WithManila(opts ...StreetOption) TypeOption`**: Configures options for Manila.
- **`WithOmaha(low bool, opts ...StreetOption) TypeOption`**: Configures options for Omaha (lowball variant possible).
- **`WithOmahaDouble(opts ...StreetOption) TypeOption`**: Configures options for Omaha Double.
- **`WithOmahaFive(low bool, opts ...StreetOption) TypeOption`**: Configures options for Five Card Omaha (lowball variant possible).
- **`WithOmahaSix(low bool, opts ...StreetOption) TypeOption`**: Configures options for Six Card Omaha (lowball variant possible).
- **`WithRazz(opts ...StreetOption) TypeOption`**: Configures options for Razz.
- **`WithRiver(low bool, opts ...StreetOption) TypeOption`**: Configures options for a game variant focused on the river card (lowball variant possible).
- **`WithRoyal(opts ...StreetOption) TypeOption`**: Configures options for Royal.
- **`WithShort(opts ...StreetOption) TypeOption`**: Configures options for Short Deck.
- **`WithShowtime(low bool, opts ...StreetOption) TypeOption`**: Configures options for Showtime (lowball variant possible).
- **`WithSoko(low bool, opts ...StreetOption) TypeOption`**: Configures options for Soko (lowball variant possible).
- **`WithSpanish(opts ...StreetOption) TypeOption`**: Configures options for Spanish 21.
- **`WithStud(low bool, opts ...StreetOption) TypeOption`**: Configures options for a generic Stud game (lowball variant possible).
- **`WithStudFive(low bool, opts ...StreetOption) TypeOption`**: Configures options for Five Card Stud (lowball variant possible).
- **`WithSwap(low bool, opts ...StreetOption) TypeOption`**: Configures options for Swap (lowball variant possible).
- **`WithVideo(low bool, opts ...StreetOption) TypeOption`**: Configures options for Video Poker (lowball variant possible).

#### General Options:

- **`StreetOption`**: This type likely represents options applicable to streets, such as number of cards, discards, etc. Specific functions for creating `StreetOption` are not detailed here but are expected to exist.
```

--------------------------------

### Pocket: Get Number of Pocket Cards to Deal

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Pocket returns the number of pocket cards to be dealt on the current street.

```go
func (d *Dealer) Pocket() int
```

--------------------------------

### Set Soko definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Soko definitions for a type description.

```go
func WithSoko(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### Get Level (Row) Title

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the title for a given level (row) in the tournament payout table. Added in v0.14.1.

```go
func (typ Type) LevelTitle(level int) string
```

--------------------------------

### Set Stud definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Stud definitions for a type description.

```go
func WithStud(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### Result Handling

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Structures and methods for dealer evaluation results.

```go
type Result struct {
	Evals   []*Eval
	HiOrder []int
	HiPivot int
	LoOrder []int
	LoPivot int
}
```

```go
func NewResult(typ Type, run *Run, active map[int]bool, calc bool) *Result
```

```go
func (res *Result) Win(names ...string) (*Win, *Win)
```

--------------------------------

### Get Card Suit Index Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's suit index, typically from 0 (Spades) to 3 (Clubs).

```go
func (c Card) SuitIndex() int
```

--------------------------------

### Create Poker Variant Evaluators

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Factory functions for creating specific poker game evaluators.

```go
func NewBadugiEval(normalize bool) EvalFunc
```

```go
func NewCactusEval(board int, normalize, low bool) EvalFunc
```

```go
func NewEval(f RankFunc) EvalFunc
```

```go
func NewHighEval() EvalFunc
```

```go
func NewHybridEval(normalize, low bool) EvalFunc
```

```go
func NewJacksOrBetterEval(normalize bool) EvalFunc
```

```go
func NewLowballEval(normalize bool) EvalFunc
```

```go
func NewMaxEval(f RankFunc, maximum EvalRank, low bool) EvalFunc
```

```go
func NewModifiedEval(hi RankFunc, base Rank, inv func(EvalRank) EvalRank, normalize, low bool) EvalFunc
```

```go
func NewOmahaEval(hi RankFunc, base Rank, inv func(EvalRank) EvalRank, normalize, low bool) EvalFunc
```

```go
func NewRazzEval(normalize bool) EvalFunc
```

```go
func NewSokoEval(normalize, low bool) EvalFunc
```

--------------------------------

### Type Description Options

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Functional options for configuring game types.

```go
type TypeOption func(*TypeDesc)
func WithBadugi(opts ...StreetOption) TypeOption
func WithCourchevel(low bool, opts ...StreetOption) TypeOption
func WithDallas(low bool, opts ...StreetOption) TypeOption
func WithDallasDouble(opts ...StreetOption) TypeOption
func WithDouble(opts ...StreetOption) TypeOption
func WithDraw(low bool, opts ...StreetOption) TypeOption
func WithFusion(low bool, opts ...StreetOption) TypeOption
func WithHoldem(low bool, opts ...StreetOption) TypeOption
func WithHouston(low bool, opts ...StreetOption) TypeOption
func WithJakarta(opts ...StreetOption) TypeOption
func WithKuhn(opts ...StreetOption) TypeOption
func WithLeduc(opts ...StreetOption) TypeOption
func WithLowball(multi bool, opts ...StreetOption) TypeOption
func WithManila(opts ...StreetOption) TypeOption
func WithOmaha(low bool, opts ...StreetOption) TypeOption
func WithOmahaDouble(opts ...StreetOption) TypeOption
func WithOmahaFive(low bool, opts ...StreetOption) TypeOption
func WithOmahaSix(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### Get Card Rank Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's rank. The Rank type provides further details about the card's rank.

```go
func (c Card) Rank() Rank
```

--------------------------------

### Create New ExpValue

Source: https://pkg.go.dev/github.com/cardrank/cardrank

NewExpValue creates and initializes a new ExpValue struct for a given number of opponents.

```go
func NewExpValue(opponents int) *ExpValue
```

--------------------------------

### Get Card Index Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's unique index within a standard deck. This is a simple integer representation.

```go
func (c Card) Index() int
```

--------------------------------

### Formatter Methods

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Methods for the Formatter type to combine cards, format output, and retrieve unused ranks or suits.

```go
func (v Formatter) Combine() Card
```

```go
func (v Formatter) Format(f fmt.State, verb rune)
```

```go
func (v Formatter) Ranks() []Rank
```

```go
func (v Formatter) Suits() []Suit
```

--------------------------------

### Set Spanish definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Spanish definitions for a type description.

```go
func WithSpanish(opts ...StreetOption) TypeOption
```

--------------------------------

### Set Razz definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Razz definitions for a type description.

```go
func WithRazz(opts ...StreetOption) TypeOption
```

--------------------------------

### Result: Get Current Game Result

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Result returns the current game result, including an integer identifier and a pointer to the Result object.

```go
func (d *Dealer) Result() (int, *Result)
```

--------------------------------

### PocketDiscard: Get Number of Pocket Cards to Discard

Source: https://pkg.go.dev/github.com/cardrank/cardrank

PocketDiscard returns the number of cards to be discarded before dealing pocket cards on the current street.

```go
func (d *Dealer) PocketDiscard() int
```

--------------------------------

### Set Showtime definitions

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Configures Showtime definitions for a type description.

```go
func WithShowtime(low bool, opts ...StreetOption) TypeOption
```

--------------------------------

### EvalFunc Type and Constructors

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Documentation for the EvalFunc type and its various constructor functions.

```APIDOC
## EvalFunc Type

### Description
Represents a function that evaluates card hands.

### Constructors
- `NewBadugiEval(normalize bool) EvalFunc`: Creates a new Badugi evaluation function.
- `NewCactusEval(board int, normalize, low bool) EvalFunc`: Creates a new Cactus evaluation function.
- `NewEval(f RankFunc) EvalFunc`: Creates a new generic evaluation function.
- `NewHighEval() EvalFunc`: Creates a new high-only evaluation function.
- `NewHybridEval(normalize, low bool) EvalFunc`: Creates a new hybrid evaluation function.
- `NewJacksOrBetterEval(normalize bool) EvalFunc`: Creates a new Jacks or Better evaluation function.
- `NewLowballEval(normalize bool) EvalFunc`: Creates a new lowball evaluation function.
- `NewMaxEval(f RankFunc, maximum EvalRank, low bool) EvalFunc`: Creates a new maximum evaluation function.
- `NewModifiedEval(hi RankFunc, base Rank, inv func(EvalRank) EvalRank, normalize, low bool) EvalFunc`: Creates a new modified evaluation function.
- `NewOmahaEval(hi RankFunc, base Rank, inv func(EvalRank) EvalRank, normalize, low bool) EvalFunc`: Creates a new Omaha evaluation function.
- `NewRazzEval(normalize bool) EvalFunc`: Creates a new Razz evaluation function.
- `NewSokoEval(normalize, low bool) EvalFunc`: Creates a new Soko evaluation function.
- `NewSplitEval(hi, lo RankFunc, maximum EvalRank) EvalFunc`: Creates a new split evaluation function.
```

--------------------------------

### Get Card Rank Index (0-12) Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's rank index, typically from 0 (Ace) to 12 (King).

```go
func (c Card) RankIndex() int
```

--------------------------------

### Run Type and Eval Method

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Documentation for the Run type and its Eval method.

```APIDOC
## func (*Run) Eval ¶
```
func (run *Run) Eval(typ Type, active map[int]bool, calc bool) []*Eval
```

Eval returns the evals for the run.
```

--------------------------------

### Get Max Level Title for Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the title for the maximum level (row) in the tournament payout table. Added in v0.14.1.

```go
func (typ Type) MaxLevelTitle(level int) string
```

--------------------------------

### Table Management

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Functions for registering and loading tournament payout tables.

```APIDOC
## Register

### Description
Registers a tournament payout table.

### Parameters
- **typ** (Type) - Table type
- **t** (*Table) - Table instance

## LoadBytes

### Description
Loads CSV formatted tournament payout table from a byte buffer.

### Parameters
- **name** (string) - Table name
- **top** (float64) - Proportion of paid rankings
- **buf** ([]byte) - CSV data

### Response
- **(*Table, error)** - The loaded table or an error
```

--------------------------------

### Get Level (Row) from Payout Table

Source: https://pkg.go.dev/github.com/cardrank/cardrank/paycalc

Returns the level (row index) for a given rank in the tournament payout table. Added in v0.14.1.

```go
func (typ Type) Level(level int) int
```

--------------------------------

### Shuffler Interface

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Documentation for the Shuffler interface.

```APIDOC
## type Shuffler
```
type Shuffler interface {
	Shuffle(n int, swap func(int, int))
}
```

Shuffler is an interface for a deck shuffler. Compatible with math/rand.Rand's Shuffle method.
```

--------------------------------

### Get Expected Value as Float64

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Float64 returns the expected value as a floating-point number. Note: The documentation mentions Float32, but the function signature is Float64.

```go
func (expv *ExpValue) Float64() float64
```

--------------------------------

### StreetOption Type

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Documentation for the StreetOption type.

```APIDOC
## type StreetOption
```
type StreetOption func(int, *StreetDesc)
```

StreetOption is a street option.
```

--------------------------------

### Get Current Board Size Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the number of board cards to be dealt on the current street. This is relevant for games like Texas Hold'em.

```go
func (d *Dealer) Board() int
```

--------------------------------

### Rank Management

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Definitions and helper methods for card ranks.

```go
type Rank uint8
```

```go
const (
	Ace Rank = 12 - iota
	King
	Queen
	Jack
	Ten
	Nine
	Eight
	Seven
	Six
	Five
	Four
	Three
	Two
)
```

```go
func RankFromRune(r rune) Rank
```

```go
func (rank Rank) Byte() byte
```

```go
func (rank Rank) Index() int
```

```go
func (rank Rank) Name() string
```

```go
func (rank Rank) PluralName() string
```

```go
func (rank Rank) StraightFlushName() string
```

```go
func (rank Rank) String() string
```

--------------------------------

### Get Ace-Low Card Rank Index Go

Source: https://pkg.go.dev/github.com/cardrank/cardrank

Returns the card's Ace-low index. Useful for comparisons where Ace is considered the lowest rank.

```go
func (c Card) AceRank() int
```

--------------------------------

### NewDeck: Create a Standard French Deck

Source: https://pkg.go.dev/github.com/cardrank/cardrank

NewDeck creates a standard French deck of 52 unshuffled cards.

```go
func NewDeck() *Deck
```
Tokens:
Raw