radix

Documentation

Overview

Package radix implements a radix tree for storing a collection of strings processing

Index

• Variables
• type Tree
  • func New(numCategories int) (Tree, error)

Variables

var ErrCannotCreateNode = errors.New("radix: no node created")

ErrCannotCreateNode is an error we get when insert somehow fails

var ErrInvalidCategoryCount = errors.New("radix: invalid category count")

ErrInvalidCategoryCount is an error for when the number of categories this tree should count is invalid

var ErrOutOfBoundsCategory = errors.New("radix: out of bounds category")

ErrOutOfBoundsCategory is an errror for when the category we want to increment is out of bounds

Types

type Tree

type Tree interface {
	Insert(needle string, category int) error
	Find(needle string) ([]int, bool)
	GetTotals() []int
	CategoryCount() int
	UniqueWords() int
}

Tree represents how we can interface with our specialized radix tree

func New

func New(numCategories int) (Tree, error)

New creates a new instance of a radix tree