maze

Documentation

Index

• type Cell
  • func (c Cell) Has(d direction.Direction) bool
• type Chooser
  • func Backtrack() Chooser
• type Maze
• type Middleware
• type Randomizer
• type Service
  • func New(middleware ...Middleware) Service

Types

type Cell

type Cell struct {
	Next []direction.Direction `json:"next"`
}

func (Cell) Has

func (c Cell) Has(d direction.Direction) bool

type Chooser

type Chooser interface {
	Choose(int) int
}

Chooser interface is the interface that the cell picking algorithm should implement

func Backtrack

func Backtrack() Chooser

Backtrack returns a backtrack algorithm implementation

type Maze

type Maze struct {
	Width    int         `json:"width"`
	Height   int         `json:"height"`
	Grid     grid        `json:"grid"`
	Entrance point.Point `json:"entrance"`
	Exit     point.Point `json:"exit"`
}

Maze internal structure

type Middleware

type Middleware func(Service) Service

Middleware wraps the Service and performs actions before the implementation is called

type Randomizer

type Randomizer interface {
	Int() int
	Intn(int) int
	Perm(int) []int
}

Randomizer abstracts the rand.Rand functions needed, for easier testing

type Service

type Service interface {
	Generate(width, height int, seed int64, algorithm Chooser) Maze
}

Service interface exposes the generator service

func New

func New(middleware ...Middleware) Service

New returns a Service implementation