poker-hand-evaluator

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

poker-hand-evaluator

★ 11 Open GitHub ↗

A small poker hand evaluator written in Java. Implements a relatively fast 5-card hand evaluator for calculating the values of poker hands and comparing them.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Poker hand evaluator

This is a small poker hand evaluator I wrote for fun. It allows
you to work with poker cards and hands, especially to determine
the values of hands.

Note that there are much faster and more versatile evaluators
for different sizes of hands. This is just a small project of
mine, written for my own recreational purposes.

## How to use

Documentation: https://jmp.github.io/poker-hand-evaluator/

There are a couple of useful classes: `Card` and `Hand`.

## `Card` class

The `Card` class self-explanatory:

```java
// Create a king of clubs
Card kingOfClubs = new Card(Rank.KING, Suit.CLUBS);
```

A card can also be constructed from a string:

```java
// Create a king of clubs from a string
Card kingOfClubs = new Card("Kc");
```

## `Hand` class

The `Hand` is a collection of five cards:

```java
// Create a royal flush
var hand = new Hand(
    new Card(Rank.KING, Suit.CLUBS),
    new Card(Rank.QUEEN, Suit.CLUBS),
    new Card(Rank.JACK, Suit.CLUBS),
    new Card(Rank.TEN, Suit.CLUBS),
    new Card(Rank.ACE, Suit.CLUBS)
);
```

To evaluate a hand, use the `evaluate` method:

```java
int value = hand.evaluate();
```

The `evaluate` method returns the value of a hand as an integer
between 1 and 7462. The lower the value, the more valuable the hand.

The `fromString` method can be used to create a hand from a string:

```java
// Create a hand from a string
Hand hand = Hand.fromString("Kd 5s Jc Ah Qc");
```

## Credits

The evaluator implements Kevin Suffecool's 5-card hand evaluator,
with the perfect hash optimization by Paul Senzee.

poker-hand-evaluator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README