README
¶
Radix
Package radix implement a radix tree in go. It is expected that the keys are in UTF-8 (i.e. go runes), and that insertion and lookup is far more common than deletion.
Use godoc tool to have a full documentation of the package.
Quick usage
go get github.com/js-arias/radix
The main data structure is Radix, that is initialized with New, e.g.
import "github.com/js-arias/radix"
var r = radix.New()
The implementation of radix is private. To access data use:
func (r *Radix) Insert(key string, value interface{}) error
Insert a value in the radix. It returns an error if the key is already in use.
func (r *Radix) Set(key string, value interface{}) error
Set provides a more flexible way to add data to the radix, as it reset a value if the key is already in use, or creates a new key if it is not already in the radix (as Insert).
func (r *Radix) Lookup(key string) interface{}
Searches for a particular key.
func (r *Radix) Prefix(key string) *list.List
Return all elements that has key as its prefix.
func (r *Radix) Delete(key string) interface{}
Removes an element from the radix, and returns it.
The radix can be navigated using an iterator that scan the radix in alphabetical order:
for it := r.Iterator(); it != nil; it.Next() {
// do something with it.Value or it.Key
}
Authorship and license
Copyright (c) 2013, J. Salvador Arias jsalarias@csnat.unt.edu.ar All rights reserved. Distributed under BSD2 license that can be found in the LICENSE file.
Documentation
¶
Overview ¶
Package radix implement a radix tree. It is expected that the keys are in UTF-8 (i.e. go runes), and that insertion and lookup is far more common than deletion.
Index ¶
- type Iterator
- type Radix
- func (rad *Radix) Delete(key string) interface{}
- func (rad *Radix) Insert(key string, value interface{}) error
- func (rad *Radix) Iterator() *Iterator
- func (rad *Radix) Lookup(key string) interface{}
- func (rad *Radix) Prefix(prefix string) *list.List
- func (rad *Radix) Set(key string, value interface{}) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Iterator ¶
type Iterator struct {
// Key of the element
Key string
// Value assigned to current element
Value interface{}
// contains filtered or unexported fields
}
Iterator is an iterator of a Radix Tree.
It is useful for navigating the radix in alphabetical order:
for it := r.Iterator(); it != nil; it.Next() {
// do something with it.Value or it.Key
}
type Radix ¶
type Radix struct {
// contains filtered or unexported fields
}
Radix is a radix tree.
func (*Radix) Insert ¶
Insert put a value in the radix. It returns an error if the given key is already in use.
func (*Radix) Iterator ¶
Iterator returns a new iterator for a given Radix tree. If the tree is empty, a nil Iterator will be return.
Source Files