deck

Documentation

Overview

Package deck provides api for creating and using a deck of 24 cards.

Index

• Constants
• Variables
• func AreTheSameSuit(card1, card2 string) bool
• func HasHigherRank(card1, card2 string) bool
• type Deck
  • func New() *Deck
  • func (d *Deck) DrawCard() (string, error)
  • func (d *Deck) DrawNcards(n int) ([]string, error)
  • func (d *Deck) Shuffle()

Constants

const Size = 24

Size is the number of cards in a deck.

Variables

var (
	OrderedDeck []string
	Points      map[byte]int
)

OrderedDeck is the initial full ordered deck. Points is a map connecting each card with its points.

Functions

func AreTheSameSuit

func AreTheSameSuit(card1, card2 string) bool

AreTheSameSuit returns true if card1 and card2 are from the same suit.

func HasHigherRank

func HasHigherRank(card1, card2 string) bool

HasHigherRank returns true if the rank of card1 is higher than the rank of card2.

Types

type Deck

type Deck struct {
	Initial []string
	Current []string
}

Deck contains the original deck and the current one (after drawing cards).

func New

func New() *Deck

New creates and returns an ordered deck of cards.

func (*Deck) DrawCard

func (d *Deck) DrawCard() (string, error)

DrawCard returns the top card of the deck if it has any.

func (*Deck) DrawNcards

func (d *Deck) DrawNcards(n int) ([]string, error)

DrawNcards returns the top n cards if n <= the size of the current deck.

func (*Deck) Shuffle

func (d *Deck) Shuffle()

Shuffle shuffles the Initial deck and makes a copy of it in Current.