puzzles

Documentation

Overview

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

Index

• Constants
• Variables
• func DaysByYear(year string) []string
• func GetYears() []string
• func MakeName(year, puzzle string) (string, error)
• func Register(solver Solver)
• func UnregisterAllSolvers(tb testing.TB)
• type Day
  • func (i Day) String() string
• type Result
  • func Solve(solver Solver, input io.Reader, opts ...RunOption) (Result, error)
  • func (r Result) String() string
• type RunOption
  • func WithBenchmark() RunOption
  • func WithElapsed() RunOption
• type Solver
  • func GetSolver(year, day string) (Solver, error)
• type Year
  • func (i Year) String() string

Constants

const (

	// AOCSession env variable name.
	AOCSession = "AOC_SESSION"
)

Variables

var (
	// ErrInvalidPuzzleName means that such puzzle not exist.
	ErrInvalidPuzzleName = errors.New("invalid puzzle name")
	// ErrInvalidYear means that such year not exist.
	ErrInvalidYear = errors.New("invalid year")
	// ErrNotImplemented signal that puzzle in not implemented yet.
	ErrNotImplemented = errors.New("not implemented")
)

var (
	// ErrYearMissed returns when year is empty.
	ErrYearMissed = errors.New("empty puzzle year")
	// ErrDayMissed returns when day is empty.
	ErrDayMissed = errors.New("empty puzzle day")
	// ErrUnknownYear returns when no puzzle find for year.
	ErrUnknownYear = errors.New("unknown puzzle year")
	// ErrUnknownDay returns when no puzzle find for day.
	ErrUnknownDay = errors.New("unknown puzzle day")
)

Functions

func DaysByYear

func DaysByYear(year string) []string

DaysByYear returns a sorted list of the days of the registered puzzle solvers for passed year.

func GetYears

func GetYears() []string

GetYears returns list of available years for solvers.

func MakeName

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

MakeName builds puzzle name according to year and puzzle passed.

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 Day

type Day int

Day presents here for purpose of documentation.

const (
	Day01 Day // 1
	Day02     // 2
	Day03     // 3
	Day04     // 4
	Day05     // 5
	Day06     // 6
	Day07     // 7
	Day08     // 8
	Day09     // 9
	Day10     // 10
	Day11     // 11
	Day12     // 12
	Day13     // 13
	Day14     // 14
	Day15     // 15
	Day16     // 16
	Day17     // 17
	Day18     // 18
	Day19     // 19
	Day20     // 20
	Day21     // 21
	Day22     // 22
	Day23     // 23
	Day24     // 24
	Day25     // 25

)

func (Day) String

func (i Day) String() string

type Result

type Result struct {
	Year  string
	Name  string
	Part1 string
	Part2 string
	// contains filtered or unexported fields
}

Result represents puzzle solution result.

func Solve

func Solve(solver Solver, input io.Reader, opts ...RunOption) (Result, error)

Solve input to solve puzzle.

func (Result) String

func (r Result) String() string

type RunOption

type RunOption interface {
	Apply(opts *runParams)
}

RunOption provides run options pattern.

func WithBenchmark

func WithBenchmark() RunOption

WithBenchmark add benchmark metric to run options.

func WithElapsed

func WithElapsed() RunOption

WithElapsed add elapsed metric to run options.

type Solver

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

Solver represents solutions for puzzles methods.

func GetSolver

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

GetSolver returns registered solver by passed puzzle day.

type Year

type Year int

Year presents here for purpose of documentation.

const (
	Year2015 Year // 2015
	Year2016      // 2016
	Year2017      // 2017
	Year2018      // 2018
	Year2019      // 2019
	Year2020      // 2020
	Year2021      // 2021
	Year2022      // 2022
	Year2023      // 2023

)

func (Year) String

func (i Year) String() string