world

Documentation

Index

• Variables
• type Location
  • func NewLocation(ns, id string, lat, lon float64) (*Location, error)
  • func (l *Location) Id() string
  • func (l *Location) Lat() float64
  • func (l *Location) Lon() float64
  • func (l *Location) Ns() string
  • func (l *Location) SetNode(node *TreeNode)
  • func (l *Location) String() string
  • func (l *Location) Update(lat, lon float64) error
• type Namespace
  • func NewNamespace(name string) *Namespace
  • func (n *Namespace) DeleteLocation(id string)
  • func (n *Namespace) GetLocation(id string) (*Location, bool)
  • func (n *Namespace) QueryRange(lat1, lat2, lon1, lon2 float64) []*Location
  • func (n *Namespace) SaveLocation(id string, lat, lon float64) (*Location, error)
• type QuadTree
  • func NewQuadTree(lat1, lat2, lon1, lon2 float64) *QuadTree
  • func (q *QuadTree) Insert(location *Location) error
• type Stats
• type TreeNode
  • func NewTreeNode(lat1, lat2, lon1, lon2 float64, capacity int) *TreeNode
  • func (node *TreeNode) Delete(id string)
  • func (node *TreeNode) ForceDivide(level int)
  • func (node *TreeNode) QueryRange(lat1, lat2, lon1, lon2 float64) []*Location
• type World
  • func NewWorld() *World
  • func NewWorldFromBytes(buf []byte) *World
  • func (m *World) Delete(ns, locId string)
  • func (m *World) GetLocation(ns, id string) (Location, bool)
  • func (m *World) Merge(w *World)
  • func (m *World) QueryRange(ns string, lat1, lat2, lon1, lon2 float64) []*Location
  • func (m *World) Save(ns, locId string, lat, lon float64) error
  • func (m *World) ToBytes() []byte

Variables

var (
	ErrTreeLocationNil         = errors.New("insertion failed because location is nil")
	ErrTreeLocationOutOfBounds = errors.New("insertion failed because location is out of bounds")
)

var (
	ErrLocationRequiredId        = errors.New("location id is required")
	ErrLocationInvalidLatitude   = errors.New("invalid latitude")
	ErrLocationInvalidLongitude  = errors.New("invalid longitude")
	ErrLocationRequiredNamespace = errors.New("namespace is required")
)

var (
	ErrUnexpectedNilNamespace = errors.New("failed to create namespace")
)

Types

type Location

type Location struct {
	Node *TreeNode
	// contains filtered or unexported fields
}

func NewLocation

func NewLocation(ns, id string, lat, lon float64) (*Location, error)

func (*Location) Id

func (l *Location) Id() string

func (*Location) Lat

func (l *Location) Lat() float64

func (*Location) Lon

func (l *Location) Lon() float64

func (*Location) Ns

func (l *Location) Ns() string

func (*Location) SetNode

func (l *Location) SetNode(node *TreeNode)

func (*Location) String

func (l *Location) String() string

func (*Location) Update

func (l *Location) Update(lat, lon float64) error

type Namespace

type Namespace struct {
	Name string
	// contains filtered or unexported fields
}

func NewNamespace

func NewNamespace(name string) *Namespace

func (*Namespace) DeleteLocation

func (n *Namespace) DeleteLocation(id string)

func (*Namespace) GetLocation

func (n *Namespace) GetLocation(id string) (*Location, bool)

func (*Namespace) QueryRange

func (n *Namespace) QueryRange(lat1, lat2, lon1, lon2 float64) []*Location

func (*Namespace) SaveLocation

func (n *Namespace) SaveLocation(id string, lat, lon float64) (*Location, error)

type QuadTree

type QuadTree struct {
	Root *TreeNode
}

func NewQuadTree

func NewQuadTree(lat1, lat2, lon1, lon2 float64) *QuadTree

func (*QuadTree) Insert

func (q *QuadTree) Insert(location *Location) error

type Stats

type Stats struct {
	Locations int
	Grids     int
}

type TreeNode

type TreeNode struct {
	NE   *TreeNode
	NW   *TreeNode
	SE   *TreeNode
	SW   *TreeNode
	Lat1 float64
	Lat2 float64
	Lon1 float64
	Lon2 float64

	Objects   map[string]*Location
	Capacity  int
	IsDivided bool
	// contains filtered or unexported fields
}

func NewTreeNode

func NewTreeNode(lat1, lat2, lon1, lon2 float64, capacity int) *TreeNode

func (*TreeNode) Delete

func (node *TreeNode) Delete(id string)

func (*TreeNode) ForceDivide

func (node *TreeNode) ForceDivide(level int)

func (*TreeNode) QueryRange

func (node *TreeNode) QueryRange(lat1, lat2, lon1, lon2 float64) []*Location

type World

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

func NewWorld

func NewWorld() *World

func NewWorldFromBytes

func NewWorldFromBytes(buf []byte) *World

func (*World) Delete

func (m *World) Delete(ns, locId string)

func (*World) GetLocation

func (m *World) GetLocation(ns, id string) (Location, bool)

func (*World) Merge

func (m *World) Merge(w *World)

func (*World) QueryRange

func (m *World) QueryRange(ns string, lat1, lat2, lon1, lon2 float64) []*Location

func (*World) Save

func (m *World) Save(ns, locId string, lat, lon float64) error

Save a location to the world. If the location already exists, it will be updated.

func (*World) ToBytes

func (m *World) ToBytes() []byte