aoc

Documentation

Overview

Package aoc provides some Advent of Code utilities.

Index

• func Abs(a int) int
• func GreatestCommonDivisor(a, b int) int
• func IndexAll(s string, search string) []int
• func IntToRune(i int) rune
• func IsRuneDecimal(r rune) bool
• func LeastCommonMultiple(numbers []int) int
• func ManhattanDistance(row, col int) int
• func MapKeysToSlice[K comparable, V any](m map[K]V) []K
• func MapValuesToSlice[K comparable, V any](m map[K]V) []V
• func Mod(d, m int) int
• func ReaderToInts(input io.Reader) []int
• func ReaderToString(input io.Reader) string
• func ReaderToStrings(input io.Reader) []string
• func RuneToInt(r rune) int
• func SliceToMap[K comparable, V any](s []K, f func(K) V) map[K]V
• func StringGroups(lines []string) [][]string
• func StringToInt(s string) int
• func StringsToInts(s []string) []int
• func Substring(s string, del string) string
• func TopologicalSort[K comparable](vertices []K, edgesFunc func(K) []K) []K
• func TryStringToInt(s string) (int, bool)
• type Board
  • func NewBoard[T any](positions map[Position]T) Board[T]
  • func ParseBoard[T any](lines []string, fn func(r rune, pos Position) T) Board[T]
  • func (b Board[T]) Contains(position Position) bool
  • func (b Board[T]) Get(pos Position) T
  • func (b Board[T]) String(f func(T) rune, missing rune) string
• type DAG
  • func NewDAG[K comparable, V any]() DAG[K, V]
  • func (g DAG[K, V]) AddEdge(from, to *DAGNode[K, V])
  • func (g DAG[K, V]) AddSimpleEdge(from, to K)
  • func (g DAG[K, V]) Edges(id K) []*DAGNode[K, V]
  • func (g DAG[K, V]) Node(id K) (*DAGNode[K, V], bool)
  • func (g DAG[K, V]) TopologicalSort() []K
• type DAGNode
• type Delimiter
  • func NewDelimiter(s, del string, opts ...DelimiterOption) Delimiter
  • func (d Delimiter) GetInt(i int) int
  • func (d Delimiter) GetInts() []int
  • func (d Delimiter) GetString(i int) string
  • func (d Delimiter) GetStrings() []string
  • func (d Delimiter) IsInt(i int) bool
  • func (d Delimiter) TryGetInt(i int) (int, bool)
• type DelimiterOption
  • func WithTrimSpace() DelimiterOption
• type Direction
  • func (d Direction) Rev() Direction
  • func (d Direction) String() string
  • func (d Direction) Turn(turn Direction) Direction
• type Location
  • func NewLocation(row, col int, dir Direction) Location
  • func (l Location) Move(d Direction, moves int) Location
  • func (l Location) Rev(moves int) Location
  • func (l Location) Straight(moves int) Location
  • func (l Location) String() string
  • func (l Location) Turn(d Direction, moves int) Location
• type Node
  • func NewNode[T any](data T) *Node[T]
  • func (n *Node[T]) Head() *Node[T]
  • func (n *Node[T]) InsertAfter(data T)
  • func (n *Node[T]) InsertHead(data T) *Node[T]
  • func (n *Node[T]) InsertTail(data T) *Node[T]
  • func (n *Node[T]) String() string
  • func (n *Node[T]) Tail() *Node[T]
• type Position
  • func NewPosition(row, col int) Position
  • func (p Position) Delta(row, col int) Position
  • func (p Position) Manhattan(p2 Position) int
  • func (p Position) ManhattanZero() int
  • func (p Position) Move(direction Direction, moves int) Position
  • func (p Position) String() string
• type PriorityQueue
  • func NewPriorityQueue[T comparable](comparator func(a, b T) int) PriorityQueue[T]
  • func (pq *PriorityQueue[T]) IsEmpty() bool
  • func (pq *PriorityQueue[T]) Len() int
  • func (pq *PriorityQueue[T]) Peek() T
  • func (pq *PriorityQueue[T]) Pop() T
  • func (pq *PriorityQueue[T]) Push(item T)

Functions

func Abs

func Abs(a int) int

Abs returns the absolute value.

func GreatestCommonDivisor

func GreatestCommonDivisor(a, b int) int

GreatestCommonDivisor returns the greatest common divisor of two numbers.

func IndexAll

func IndexAll(s string, search string) []int

IndexAll returns all the indices from a given string into a string.

func IntToRune

func IntToRune(i int) rune

IntToRune converts an int into a rune.

func IsRuneDecimal

func IsRuneDecimal(r rune) bool

IsRuneDecimal checks whether a rune is a decimal number.

func LeastCommonMultiple

func LeastCommonMultiple(numbers []int) int

LeastCommonMultiple returns the least common multiple from a list of numbers.

func ManhattanDistance

func ManhattanDistance(row, col int) int

ManhattanDistance returns the manhattan distance.

func MapKeysToSlice

func MapKeysToSlice[K comparable, V any](m map[K]V) []K

MapKeysToSlice converts the maps keys to a slice.

func MapValuesToSlice

func MapValuesToSlice[K comparable, V any](m map[K]V) []V

MapValuesToSlice converts the map values to a slice.

func Mod

func Mod(d, m int) int

Mod returns the modulo.

func ReaderToInts

func ReaderToInts(input io.Reader) []int

ReaderToInts converts optimistically an io.Reader into a slice of strings.

func ReaderToString

func ReaderToString(input io.Reader) string

ReaderToString converts an io.Reader into a string.

func ReaderToStrings

func ReaderToStrings(input io.Reader) []string

ReaderToStrings converts an io.Reader into a slice of strings.

func RuneToInt

func RuneToInt(r rune) int

RuneToInt converts a rune into an int.

func SliceToMap

func SliceToMap[K comparable, V any](s []K, f func(K) V) map[K]V

SliceToMap converts a slice into a map.

func StringGroups

func StringGroups(lines []string) [][]string

StringGroups returns groups of lines inputs that are not separated by empty lines.

For example:

0, 1, 2

foo bar

Returns {"0, 1, 2"} and {"foo", "bar"}

func StringToInt

func StringToInt(s string) int

StringToInt is an optimistic conversion from a string to an int.

func StringsToInts

func StringsToInts(s []string) []int

StringsToInts is an optimistic conversion from a slice of strings to a slice of ints.

func Substring

func Substring(s string, del string) string

Substring returns the substring from a given delimiter.

func TopologicalSort

func TopologicalSort[K comparable](vertices []K, edgesFunc func(K) []K) []K

TopologicalSort applies the topological sort algorithm based on vertices and a way to compute the edges.

func TryStringToInt

func TryStringToInt(s string) (int, bool)

TryStringToInt tries to convert a string into an int.

Types

type Board

type Board[T any] struct {
	Positions map[Position]T
	MinRows   int
	MinCols   int
	MaxRows   int
	MaxCols   int
}

func NewBoard

func NewBoard[T any](positions map[Position]T) Board[T]

NewBoard creates a board from a list of positions.

func ParseBoard

func ParseBoard[T any](lines []string, fn func(r rune, pos Position) T) Board[T]

ParseBoard parses a board and maps it to a map of Position.

func (Board[T]) Contains

func (b Board[T]) Contains(position Position) bool

Contains checks whether a position is inside a board.

func (Board[T]) Get

func (b Board[T]) Get(pos Position) T

Get returns the value at a give position.

func (Board[T]) String

func (b Board[T]) String(f func(T) rune, missing rune) string

String returns the board representation.

type DAG

type DAG[K comparable, V any] struct {
	// contains filtered or unexported fields
}

DAG is the representation of a directed acyclic graph.

func NewDAG

func NewDAG[K comparable, V any]() DAG[K, V]

NewDAG returns a new DAG.

func (DAG[K, V]) AddEdge

func (g DAG[K, V]) AddEdge(from, to *DAGNode[K, V])

AddEdge adds a new edge.

func (DAG[K, V]) AddSimpleEdge

func (g DAG[K, V]) AddSimpleEdge(from, to K)

AddSimpleEdge adds a simple edge, without the DAGNode.

func (DAG[K, V]) Edges

func (g DAG[K, V]) Edges(id K) []*DAGNode[K, V]

Edges returns the children from an id.

func (DAG[K, V]) Node

func (g DAG[K, V]) Node(id K) (*DAGNode[K, V], bool)

Node returns a node from an id.

func (DAG[K, V]) TopologicalSort

func (g DAG[K, V]) TopologicalSort() []K

TopologicalSort applies the topological sort algorithm on a DAG.

type DAGNode

type DAGNode[K comparable, V any] struct {
	Id   K
	Data V
}

DAGNode is a DAG node.

type Delimiter

type Delimiter struct {
	// contains filtered or unexported fields
}

Delimiter implementation.

func NewDelimiter

func NewDelimiter(s, del string, opts ...DelimiterOption) Delimiter

NewDelimiter creates a new input delimiter logic.

func (Delimiter) GetInt

func (d Delimiter) GetInt(i int) int

GetInt returns the int at a given index with an optimistic conversion.

func (Delimiter) GetInts

func (d Delimiter) GetInts() []int

GetInts returns all the ints found with an optimistic conversion.

func (Delimiter) GetString

func (d Delimiter) GetString(i int) string

GetString returns the string at a given index.

func (Delimiter) GetStrings

func (d Delimiter) GetStrings() []string

GetStrings returns all the strings found.

func (Delimiter) IsInt

func (d Delimiter) IsInt(i int) bool

IsInt checks whether the value at a given index is an int.

func (Delimiter) TryGetInt

func (d Delimiter) TryGetInt(i int) (int, bool)

TryGetInt returns the int at a given index.

type DelimiterOption

type DelimiterOption func(options *delimiterOptions)

DelimiterOption holds the Delimiter options.

func WithTrimSpace

func WithTrimSpace() DelimiterOption

WithTrimSpace applies strings.trimSpace on each string.

type Direction

type Direction int

Direction enum

const (
	Up Direction = iota
	Down
	Left
	Right

	UpLeft
	UpRight
	DownLeft
	DownRight
)

func (Direction) Rev

func (d Direction) Rev() Direction

Rev reverses the current direction.

func (Direction) String

func (d Direction) String() string

String implements strings.Stringer.

func (Direction) Turn

func (d Direction) Turn(turn Direction) Direction

Turn turns left or right.

type Location

type Location struct {
	Pos Position
	Dir Direction
}

Location represents a given position and direction.

func NewLocation

func NewLocation(row, col int, dir Direction) Location

NewLocation creates a new location.

func (Location) Move

func (l Location) Move(d Direction, moves int) Location

Move moves in a given direction.

func (Location) Rev

func (l Location) Rev(moves int) Location

Rev moves in the reverse direction.

func (Location) Straight

func (l Location) Straight(moves int) Location

Straight moves in the current direction.

func (Location) String

func (l Location) String() string

String implements strings.Stringer.

func (Location) Turn

func (l Location) Turn(d Direction, moves int) Location

Turn turns left or right.

type Node

type Node[T any] struct {
	Data     T
	Previous *Node[T]
	Next     *Node[T]
}

Node is a linked list node.

func NewNode

func NewNode[T any](data T) *Node[T]

NewNode returns a new node.

func (*Node[T]) Head

func (n *Node[T]) Head() *Node[T]

Head returns the head.

func (*Node[T]) InsertAfter

func (n *Node[T]) InsertAfter(data T)

InsertAfter insers a node after the current one.

func (*Node[T]) InsertHead

func (n *Node[T]) InsertHead(data T) *Node[T]

InsertHead inserts a node to the head and return the head.

func (*Node[T]) InsertTail

func (n *Node[T]) InsertTail(data T) *Node[T]

InsertTail inserts a node to the tail and return the tail.

func (*Node[T]) String

func (n *Node[T]) String() string

String implements strings.Stringer.

func (*Node[T]) Tail

func (n *Node[T]) Tail() *Node[T]

Tail returns the tail.

type Position

type Position struct {
	Row int
	Col int
}

Position represents a given position (row/col)

func NewPosition

func NewPosition(row, col int) Position

NewPosition creates a new position.

func (Position) Delta

func (p Position) Delta(row, col int) Position

Delta returns a new position from a row delta and col delta.

func (Position) Manhattan

func (p Position) Manhattan(p2 Position) int

Manhattan returns the manhattan distance.

func (Position) ManhattanZero

func (p Position) ManhattanZero() int

ManhattanZero returns the manhattan distance from the zero position.

func (Position) Move

func (p Position) Move(direction Direction, moves int) Position

Move moves into a given direction and a certain number of times.

func (Position) String

func (p Position) String() string

String implements strings.Stringer.

type PriorityQueue

type PriorityQueue[T comparable] struct {
	// contains filtered or unexported fields
}

PriorityQueue is a priority queue implementation.

func NewPriorityQueue

func NewPriorityQueue[T comparable](comparator func(a, b T) int) PriorityQueue[T]

NewPriorityQueue creates a new PriorityQueue using a comparator.

func (*PriorityQueue[T]) IsEmpty

func (pq *PriorityQueue[T]) IsEmpty() bool

IsEmpty checks if the priority queue is empty.

func (*PriorityQueue[T]) Len

func (pq *PriorityQueue[T]) Len() int

Len returns the number of elements in the priority queue.

func (*PriorityQueue[T]) Peek

func (pq *PriorityQueue[T]) Peek() T

Peek returns the top element of the priority queue without removing it.

func (*PriorityQueue[T]) Pop

func (pq *PriorityQueue[T]) Pop() T

Pop removes and returns the top element from the priority queue.

func (*PriorityQueue[T]) Push

func (pq *PriorityQueue[T]) Push(item T)

Push pushes a new item.