card

Documentation

Index

• Constants
• Variables
• type Card
  • func FromString(s string) *Card
  • func New(v RANK, s SUIT) *Card
  • func (c *Card) Connected(a *Card) bool
  • func (c *Card) String() string
• type RANK
• type SUIT

Constants

const (
	NumSuit  = 4
	NumRanks = 13
	NumCards = 4 * 13
)

Go does not have variant types :(

const (
	// Nil is used to check for uninitialised ranks
	Nil = RANK("")
	// Two Rank constant
	Two = RANK("2")
	// Three Rank constant
	Three = RANK("3")
	// Four Rank constant
	Four = RANK("4")
	// Five Rank constant
	Five = RANK("5")
	// Six Rank constant
	Six = RANK("6")
	// Seven Rank constant
	Seven = RANK("7")
	// Eight Rank constant
	Eight = RANK("8")
	// Nine Rank constant
	Nine = RANK("9")
	// Ten Rank constant
	Ten = RANK("T")
	// Jack Rank constant
	Jack = RANK("J")
	// Queen Rank constant
	Queen = RANK("Q")
	// King Rank constant
	King = RANK("K")
	// Ace Rank constant
	Ace = RANK("A")
)

const (
	// Clubs Suit constant
	Clubs = SUIT("C")
	// Diamonds Suit constant
	Diamonds = SUIT("D")
	// Hearts Suit constant
	Hearts = SUIT("H")
	// Spades Suit constant
	Spades = SUIT("S")
)

Variables

var RankIndexes = map[RANK]int{
	Two:   0,
	Three: 1,
	Four:  2,
	Five:  3,
	Six:   4,
	Seven: 5,
	Eight: 6,
	Nine:  7,
	Ten:   8,
	Jack:  9,
	Queen: 10,
	King:  11,
	Ace:   12,
}

RankIndexes ...

var Ranks = []RANK{
	Two,
	Three,
	Four,
	Five,
	Six,
	Seven,
	Eight,
	Nine,
	Ten,
	Jack,
	Queen,
	King,
	Ace,
}

Ranks is a slice of all ranks

var SuitIndexes = map[SUIT]int{
	Clubs:    0,
	Diamonds: 1,
	Hearts:   2,
	Spades:   3,
}

SuitIndexes ...

var Suits = []SUIT{
	Clubs,
	Diamonds,
	Hearts,
	Spades,
}

Suits is a slice of all suits

Types

type Card

type Card struct {
	Rank RANK
	Suit SUIT
}

Card is the type that represents a playing card

func FromString

func FromString(s string) *Card

FromString converts a string into a card struct representation

func New

func New(v RANK, s SUIT) *Card

New creates a new instance of the card object

func (*Card) Connected

func (c *Card) Connected(a *Card) bool

Connected returns true if the given card is adjacent (connected in a straight) to the current card, includes K <-> A, A <-> 2

func (*Card) String

func (c *Card) String() string

String representation of a card

type RANK

type RANK string

RANK represents a card rank "2" -> "A"

type SUIT

type SUIT string

SUIT represents one of the four suits