https://github.com/Google/hilbert

Go package for mapping values to and from space-filling curves, such as Hilbert and Peano curves.
https://github.com/Google/hilbert

go hilbert peano space-filling-curves

Last synced: about 2 months ago
JSON representation

Go package for mapping values to and from space-filling curves, such as Hilbert and Peano curves.

• Host: GitHub
• URL: https://github.com/Google/hilbert
• Owner: google
• License: apache-2.0
• Archived: true
• Created: 2015-08-06T15:50:00.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-09-21T12:58:36.000Z (about 2 years ago)
• Last Synced: 2024-06-18T15:32:18.753Z (3 months ago)
• Topics: go, hilbert, peano, space-filling-curves
• Language: Go
• Homepage:
• Size: 1.41 MB
• Stars: 277
• Watchers: 20
• Forks: 41
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hilbert [![Build Status](https://img.shields.io/travis/google/hilbert.svg)](https://travis-ci.org/google/hilbert) [![Coverage](https://img.shields.io/coveralls/google/hilbert.svg)](https://coveralls.io/github/google/hilbert) [![Report card](https://goreportcard.com/badge/github.com/google/hilbert)](https://goreportcard.com/report/github.com/google/hilbert) [![GoDoc](https://godoc.org/github.com/google/hilbert?status.svg)](https://godoc.org/github.com/google/hilbert) [![Libraries.io](https://img.shields.io/librariesio/github/google/hilbert.svg)](https://libraries.io/github/google/hilbert)

Go package for mapping values to and from space-filling curves, such as

[Hilbert](https://en.wikipedia.org/wiki/Hilbert_curve) and [Peano](https://en.wikipedia.org/wiki/Peano_curve) curves.

![Image of 8 by 8 Hilbert curve](images/hilbert.png)

[Documentation available here](https://godoc.org/github.com/google/hilbert)

*This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.*

 

## How to use

Install:

```bash

go get github.com/google/hilbert

```

Example:

```go

import "github.com/google/hilbert"

	

// Create a Hilbert curve for mapping to and from a 16 by 16 space.

s, err := hilbert.NewHilbert(16)

// Create a Peano curve for mapping to and from a 27 by 27 space.

//s, err := hilbert.NewPeano(27)

// Now map one dimension numbers in the range [0, N*N-1], to an x,y

// coordinate on the curve where both x and y are in the range [0, N-1].

x, y, err := s.Map(t)

// Also map back from (x,y) to t.

t, err := s.MapInverse(x, y)

```

## Demo

The demo directory contains an example on how to draw an images of Hilbert and Peano curves, as well

as animations of varying sizes for both.

```bash

go run $GOPATH/src/github.com/google/hilbert/demo/demo.go

```

and the following images are generated. 

Simple 8x8 Hibert curve:

![8x8 Hilbert curve image](images/hilbert.png)

Simple 9x9 Peano curve:

![9x9 Hilbert curve image](images/peano.png)

Animation of Hibert curve with N in the range 1..8:

![Hilbert curve animation](images/hilbert_animation.gif)

Animation of Peano curve with N in the range 1..6:

![Peano curve animation](images/peano_animation.gif)

## Licence (Apache 2)

```

Copyright 2015 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```