Package rawgeo

import "a4.io/rawgeo"

Overview
Index
Subdirectories

Overview

Index

Variables
type Point
func NewPointFromGeohash(id, geohash string) *Point
func (p *Point) DistanceFrom(point *Point) float64
type RawGeo
func New(path string) (*RawGeo, error)
func (rg *RawGeo) Close() error
func (rg *RawGeo) Destroy() error
func (rg *RawGeo) Index(point *Point) error
func (rg *RawGeo) Query(lat, lng, radius float64) ([]*Point, error)

Package files

rawgeo.go

Variables

var (
    Log               = log.New()
    ErrNotFound       = errors.New("key does not exist")
    ErrMissingID      = errors.New("missing ID")
    ErrInvalidLatLong = errors.New("invalid lat/long")
)

type Point

type Point struct {
    ID      string
    Geohash string

    // These fields are computed query time and will be ignored when indexing
    Distance float64
    Lat, Lng float64
}

func NewPointFromGeohash

func NewPointFromGeohash(id, geohash string) *Point

func (*Point) DistanceFrom

func (p *Point) DistanceFrom(point *Point) float64

Implements the equirectangular approximation from www.movable-type.co.uk/scripts/latlong.html (Pythagoras’ theorem on an equirectangular projection)

Returns the approximate distance in meters

type RawGeo

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

func New

func New(path string) (*RawGeo, error)

New initializes/loads a `RawGeo` index at the given path

func (*RawGeo) Close

func (rg *RawGeo) Close() error

Close gracefully closes the opened index

func (*RawGeo) Destroy

func (rg *RawGeo) Destroy() error

Destroy will try to remove the index file

func (*RawGeo) Index

func (rg *RawGeo) Index(point *Point) error

Put index the given entry in the given index (you have to care about duplicate IDs)

func (*RawGeo) Query

func (rg *RawGeo) Query(lat, lng, radius float64) ([]*Point, error)

Query will returns all the points found in the given radius (in meters) sorted by distance to the query

Subdirectories

Name	Synopsis

example

a4.io/rawgeo

RawGeo

Features