playing_cards

README

Playing Cards

Types for the Reduced French Tarot playing card deck.

Documentation

Index

• type Card
  • func (c Card) LaTeX() []byte
• type Deck
  • func CombineDecks(decks ...*Deck) *Deck
  • func NewDeck() *Deck
  • func NewDeckFromCards(cards ...Card) *Deck
  • func (d *Deck) Append(c *Deck)
  • func (d *Deck) Cut(idx int) ([]*Deck, error)
  • func (d *Deck) DealFromBottom(count int) ([]Card, error)
  • func (d *Deck) DealFromTop(count int) ([]Card, error)
  • func (d *Deck) Len() int
  • func (d *Deck) Shuffle()
• type Rank
  • func (r Rank) LaTeX() []byte
  • func (r Rank) String() string
• type Suit
  • func (s Suit) LaTeX() []byte

Types

type Card

type Card struct {
	Suit Suit
	Rank Rank
	Name string
}

func (Card) LaTeX

func (c Card) LaTeX() []byte

type Deck

type Deck []Card

func CombineDecks

func CombineDecks(decks ...*Deck) *Deck

func NewDeck

func NewDeck() *Deck

func NewDeckFromCards

func NewDeckFromCards(cards ...Card) *Deck

func (*Deck) Append

func (d *Deck) Append(c *Deck)

func (*Deck) Cut

func (d *Deck) Cut(idx int) ([]*Deck, error)

func (*Deck) DealFromBottom

func (d *Deck) DealFromBottom(count int) ([]Card, error)

func (*Deck) DealFromTop

func (d *Deck) DealFromTop(count int) ([]Card, error)

func (*Deck) Len

func (d *Deck) Len() int

func (*Deck) Shuffle

func (d *Deck) Shuffle()

type Rank

type Rank int

const (
	Joker Rank = iota
	Ace
	Duce
	Three
	Four
	Five
	Six
	Seven
	Eight
	Nine
	Ten
	Jack
	Knight
	Queen
	King
)

func (Rank) LaTeX

func (r Rank) LaTeX() []byte

func (Rank) String

func (r Rank) String() string

type Suit

type Suit int

const (
	Suitless Suit = iota
	Hearts
	Clubs
	Diamonds
	Spades
	Red
	Black
	Wands
	Cups
	Swords
	Pentacles
	MajorArcana
)

func (Suit) LaTeX

func (s Suit) LaTeX() []byte

LaTeX returns the LaTeX command that will print the symbol for this card's suit. For the standard deck of playing cards, the commands should work fine in base LaTeX. For the Tarot suits, however, the following packages will need to be included:

• esrelation
• fourier
• linearb
• MnSymbol