README
¶
Go-bktree
https://travis-ci.org/bahadrix/go-bktree.svg?branch=master Go-bktree provides an implementation of BK-tree.
Fork Info
Forked from github.com/hjr265/go-bktree. Following features added:
- Saving and reading from file via Protocol Buffers serialization.
- Payload type converted to bytes instead of string. This way any other distance can be calculated like Hamming Distance.
Installation
Install Go-bktree using the go get command:
$ go get github.com/bahadrix/go-bktree
The only dependency is the Go distribution itself.
Documentation
Contributing
Contributions are welcome.
License
Go-bktree is available under the BSD (3-Clause) License.
Documentation
¶
Overview ¶
Package bktree provides an implementation of BK-tree (http://en.wikipedia.org/wiki/BK-tree).
A BK-tree is a metric tree suggested by Walter Austin Burkhard and Robert M. Keller specifically adapted to discrete metric spaces.
Package model is a generated protocol buffer package.
It is generated from these files:
model.proto
It has these top-level messages:
Node
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BKTree ¶
type BKTree struct {
Metric Metric // Metric function, required
// contains filtered or unexported fields
}
BKTree represents a BK-tree with a given metric function.
func (*BKTree) ReadFromFile ¶
Reads data from file and deserialize into tree
type Metric ¶
The Metric type is a function used by BK-tree instances to measure the distance between two given strings.
type Node ¶
type Node struct {
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
Children map[int64]*Node `` /* 137-byte string literal not displayed */
}
protoc model.proto --go_out=.
func (*Node) Descriptor ¶
func (*Node) GetChildren ¶
func (*Node) ProtoMessage ¶
func (*Node) ProtoMessage()
Source Files