`poker`: The Poker Evaluation Crate

poker is a Rust crate for the speedy evaluation of poker hands. It it based on the treys Python package and the algorithms found within, with mild adaptations and some personal touches to try to make it as idiomatic as possible in Rust.

```rust use poker::{Evaluator, cards, Card};

fn main() { // Create a hand evaluator let eval = Evaluator::new();

// Generate a shuffled deck
let mut deck = Card::generate_shuffled_deck().to_vec();

// Deal a hand
let hand: Vec<Card> = deck.drain(..5).collect();

// Evaluate
let result = eval.evaluate(hand).expect("Couldn't evaluate hand!");

// Print the hand result
println!("{}", result);

} ```

Using `poker`

Add poker to the dependencies in your Cargo.toml file:

toml [dependencies] poker = "0.2"

Features

poker currently has one feature, depending on the rand crate, in order to shuffle generated decks. This can easily be disabled by disabling default features in your Cargo.toml file:

toml [dependencies] poker = { version = "0.2", default-features = false }

A Note on Performance

For readability, the #[inline] attribute has been removed from function declarations. In order to ensure rustc can make appropriate inlining and optimization decisions, remember to use link-time optimization in your release builds. This comes at the cost of slower compilation times. In your Cargo.toml:

```toml [profile.release]

...

lto = true # the default is false! ```

Examples

poker includes two fun builtin examples: poker-repl and jacks-or-better. poker-repl is a repl-like environment when you can evaluate different poker hands. jacks-or-better is a terminal re-creation of the Jacks or Better video poker game. Payouts based on this image. Rules for the game can be found here.

DISCLAIMER

The jacks-or-better example from the poker crate has themes of gambling using a currency called credits. This program is meant for example purposes only to illustrate one possible use of this library. There is no risk associated with running the example as it can be terminated and restarted at any time.

Please be aware of the possible financial risk of real gambling.

You can install these examples through cargo by running the following command:

```bash cargo install poker --example=poker-repl cargo install poker --example=jacks-or-better

Then you can run the programs, assuming they were installed somewhere in $PATH

poker-repl jacks-or-better ```

You can also run the examples through a cloned git repository.

bash git clone https://github.com/deus-x-mackina/poker cd poker cargo run --example=poker-repl cargo run --example=jacks-or-better

License

Licensed under the MIT license (LICENSE.txt or http://opensource.org/licenses/MIT).

poker: The Poker Evaluation Crate

Using poker