https://github.com/s0rg/array2d

Generic 2D array
https://github.com/s0rg/array2d

2d-array generic golang

Last synced: 3 months ago
JSON representation

Generic 2D array

• Host: GitHub
• URL: https://github.com/s0rg/array2d
• Owner: s0rg
• License: mit
• Created: 2022-11-25T14:11:51.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-02T19:13:22.000Z (almost 2 years ago)
• Last Synced: 2025-01-18T05:31:07.667Z (5 months ago)
• Topics: 2d-array, generic, golang
• Language: Go
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PkgGoDev](https://pkg.go.dev/badge/github.com/s0rg/array2d)](https://pkg.go.dev/github.com/s0rg/array2d)

[![License](https://img.shields.io/github/license/s0rg/array2d)](https://github.com/s0rg/array2d/blob/master/LICENSE)

[![Go Version](https://img.shields.io/github/go-mod/go-version/s0rg/array2d)](go.mod)

[![Tag](https://img.shields.io/github/v/tag/s0rg/array2d?sort=semver)](https://github.com/s0rg/array2d/tags)

[![CI](https://github.com/s0rg/array2d/workflows/ci/badge.svg)](https://github.com/s0rg/array2d/actions?query=workflow%3Aci)

[![Go Report Card](https://goreportcard.com/badge/github.com/s0rg/array2d)](https://goreportcard.com/report/github.com/s0rg/array2d)

[![Maintainability](https://api.codeclimate.com/v1/badges/54e42106bc739ae75de9/maintainability)](https://codeclimate.com/github/s0rg/array2d/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/54e42106bc739ae75de9/test_coverage)](https://codeclimate.com/github/s0rg/array2d/test_coverage)

![Issues](https://img.shields.io/github/issues/s0rg/array2d)

# array2d

Generic 2D array

# features

- zero-alloc

- 100% test coverage

# example

```go

import (

    "fmt"

    "github.com/s0rg/array2d"

)

func main() {

    // create new 2D array with given type and dimensions (width x height)

    a := array2d.New[int](15, 20)

    // fill with ones

    a.Fill(func() (value int) {

        return 1

    })

    // set value at given coords

    a.Set(1, 2, 100)

    // get values

    t1, ok := a.Get(1, 1)

    if !ok {

        panic("nothing at 1x1")

    }

    t2, ok := a.Get(1, 2)

    if !ok {

        panic("nothing at 1x2")

    }

    fmt.Println(t1, t2) // should print: 1, 100

}

```

# benchmarks

```

goos: linux

goarch: amd64

pkg: github.com/s0rg/array2d

cpu: AMD Ryzen 5 5500U with Radeon Graphics

BenchmarkArray/Set-12           1000000000         1.002 ns/op        0 B/op          0 allocs/op

BenchmarkArray/Get-12           927178446          1.250 ns/op        0 B/op          0 allocs/op

BenchmarkArray/Iter-12          39491674           30.68 ns/op        0 B/op          0 allocs/op

BenchmarkArray/Fill-12          20840200           56.84 ns/op        0 B/op          0 allocs/op

PASS

ok      github.com/s0rg/array2d 4.897s

```