grid

Documentation

Index

• Variables
• func Print[T rune | byte](g Grid[T])
• func PrintFunc[T any](g Grid[T], f func(T) rune)
• type Grid
  • func FromGridSize[T, O any](other Grid[O]) Grid[T]
  • func NewGridSize[T any](cols, rows int) Grid[T]
  • func (g Grid[T]) Cells() []T
  • func (g Grid[T]) Fill(t T)
  • func (g Grid[T]) FilterValid(idxs []Index) []Index
  • func (g Grid[T]) Get(i Index) T
  • func (g Grid[T]) IndexedCells() []IndexedCell[T]
  • func (g Grid[T]) IndexedCellsByColumn() []IndexedCell[T]
  • func (g Grid[T]) Indexes() []Index
  • func (g Grid[T]) LenCols() int
  • func (g Grid[T]) Lookup(i Index) (T, bool)
  • func (g Grid[T]) Set(i Index, t T)
  • func (g Grid[T]) Transpose() Grid[T]
• type Index
  • func Adjacent(i Index) []Index
  • func AdjacentNoDiagonal(i Index) []Index
  • func FlipDir(dir Index) Index
  • func I(x, y int) Index
  • func (i Index) Add(i2 Index) Index
  • func (i Index) Sub(i2 Index) Index
• type IndexedCell

Variables

var (
	Up    = Index{0, -1}
	Down  = Index{0, 1}
	Left  = Index{-1, 0}
	Right = Index{1, 0}
)

Functions

func Print

func Print[T rune | byte](g Grid[T])

func PrintFunc

func PrintFunc[T any](g Grid[T], f func(T) rune)

Types

type Grid

type Grid[T any] [][]T

func FromGridSize

func FromGridSize[T, O any](other Grid[O]) Grid[T]

func NewGridSize

func NewGridSize[T any](cols, rows int) Grid[T]

func (Grid[T]) Cells

func (g Grid[T]) Cells() []T

Cells of the grid in row-major order.

func (Grid[T]) Fill

func (g Grid[T]) Fill(t T)

func (Grid[T]) FilterValid

func (g Grid[T]) FilterValid(idxs []Index) []Index

func (Grid[T]) Get

func (g Grid[T]) Get(i Index) T

Get returns the value at i if i is within the bounds of the grid, otherwise the zero value for T. To test if i is valid use Lookup instead.

func (Grid[T]) IndexedCells

func (g Grid[T]) IndexedCells() []IndexedCell[T]

Cells of the grid in row-major order.

func (Grid[T]) IndexedCellsByColumn

func (g Grid[T]) IndexedCellsByColumn() []IndexedCell[T]

Cells of the grid in column-major order.

func (Grid[T]) Indexes

func (g Grid[T]) Indexes() []Index

func (Grid[T]) LenCols

func (g Grid[T]) LenCols() int

func (Grid[T]) Lookup

func (g Grid[T]) Lookup(i Index) (T, bool)

func (Grid[T]) Set

func (g Grid[T]) Set(i Index, t T)

func (Grid[T]) Transpose

func (g Grid[T]) Transpose() Grid[T]

type Index

type Index struct{ X, Y int }

func Adjacent

func Adjacent(i Index) []Index

func AdjacentNoDiagonal

func AdjacentNoDiagonal(i Index) []Index

func FlipDir

func FlipDir(dir Index) Index

func I

func I(x, y int) Index

func (Index) Add

func (i Index) Add(i2 Index) Index

func (Index) Sub

func (i Index) Sub(i2 Index) Index

type IndexedCell

type IndexedCell[T any] struct {
	Idx   Index
	Value T
}