puzzles

Documentation

Overview

Package puzzles declares common interface for puzzle solutions and functionality for register and run them.

Index

• Variables
• func GetYears() []string
• func MakeName(year string, puzzle string) (string, error)
• func NamesByYear(year string) []string
• func Register(solver Solver)
• func UnregisterAllSolvers(tb testing.TB)
• type Result
  • func Run(solver Solver, input io.Reader) (Result, error)
• type Solver
  • func GetSolver(year string, name string) (Solver, error)

Variables

var (
	// ErrInvalidPzzlName means that such puzzle not exist.
	ErrInvalidPzzlName = errors.New("invalid puzzle name")
	// ErrInvalidYear means that such year not exist.
	ErrInvalidYear = errors.New("invalid year")
)

var ErrNotImplemented = errors.New("not implemented")

ErrNotImplemented signal that puzzle in not implemented yet.

Functions

func GetYears

func GetYears() []string

GetYears returns list of available years for solvers.

func MakeName

func MakeName(year string, puzzle string) (string, error)

MakeName builds puzzle name according to year and puzzle passed.

func NamesByYear

func NamesByYear(year string) []string

NamesByYear returns a sorted list of the names of the registered puzzle solvers for passed year.

func Register

func Register(solver Solver)

Register makes a puzzle solver available by the provided name. If Register is called twice with the same name or if solver is nil, it panics.

func UnregisterAllSolvers

func UnregisterAllSolvers(tb testing.TB)

UnregisterAllSolvers cleans up registered solvers. Use for testing only.

Types

type Result

type Result struct {
	Year  string
	Name  string
	Part1 string
	Part2 string
}

Result represents puzzle solution result.

func Run

func Run(solver Solver, input io.Reader) (Result, error)

Run uses solver of puzzle and path to input.

type Solver

type Solver interface {
	Part1(input io.Reader) (string, error)
	Part2(input io.Reader) (string, error)
	Name() string
	Year() string
}

Solver represents solutions for puzzles methods.

func GetSolver

func GetSolver(year string, name string) (Solver, error)

GetSolver returns registered solver by passed puzzle name.