resolve claims from govet and golint

Author: koron

.gitignore

@@ -0,0 +1,2 @@
+/tags
+/tmp/

ternary.go

@@ -1,25 +1,31 @@
 package trie
 
+// TernaryTrie provides ternary trie-tree.
 type TernaryTrie struct {
 	root TernaryNode
 }
 
+// NewTernaryTrie creates a ternary trie-tree.
 func NewTernaryTrie() *TernaryTrie {
 	return &TernaryTrie{}
 }
 
+// Root returns the root node of the trie-tree.
 func (t *TernaryTrie) Root() Node {
 	return &t.root
 }
 
+// Get returns a node for key k.
 func (t *TernaryTrie) Get(k string) Node {
 	return Get(t, k)
 }
 
+// Put puts a pair of key and value to trie-tree.
 func (t *TernaryTrie) Put(k string, v interface{}) Node {
 	return Put(t, k, v)
 }
 
+// Size counts nodes in the trie-tree.
 func (t *TernaryTrie) Size() int {
 	count := 0
 	EachDepth(t, func(Node) bool {
@@ -29,6 +35,7 @@ func (t *TernaryTrie) Size() int {
 	return count
 }
 
+// Balance balances all nodes of trie-tree in each layers.
 func (t *TernaryTrie) Balance() {
 	EachDepth(t, func(n Node) bool {
 		n.(*TernaryNode).Balance()
@@ -37,17 +44,20 @@ func (t *TernaryTrie) Balance() {
 	t.root.Balance()
 }
 
+// TernaryNode provides node of ternary trie-tree.
 type TernaryNode struct {
 	label      rune
 	firstChild *TernaryNode
 	low, high  *TernaryNode
 	value      interface{}
 }
 
+// NewTernaryNode creates a node instance.
 func NewTernaryNode(l rune) *TernaryNode {
 	return &TernaryNode{label: l}
 }
 
+// Get returns a child node for k.
 func (n *TernaryNode) Get(k rune) Node {
 	curr := n.firstChild
 	for curr != nil {
@@ -62,6 +72,7 @@ func (n *TernaryNode) Get(k rune) Node {
 	return nil
 }
 
+// Dig digs a node for k. it returns node and a flag for whether dig or not.
 func (n *TernaryNode) Dig(k rune) (node Node, isnew bool) {
 	curr := n.firstChild
 	if curr == nil {
@@ -87,14 +98,17 @@ func (n *TernaryNode) Dig(k rune) (node Node, isnew bool) {
 	}
 }
 
+// FirstChild returns first child node.
 func (n *TernaryNode) FirstChild() *TernaryNode {
 	return n.firstChild
 }
 
+// HasChildren returns the node hash any children or not.
 func (n *TernaryNode) HasChildren() bool {
 	return n.firstChild != nil
 }
 
+// Size counts descended nodes.
 func (n *TernaryNode) Size() int {
 	if n.firstChild == nil {
 		return 0
@@ -107,6 +121,7 @@ func (n *TernaryNode) Size() int {
 	return count
 }
 
+// Each enumerates descended nodes.
 func (n *TernaryNode) Each(proc func(Node) bool) {
 	var f func(*TernaryNode) bool
 	f = func(n *TernaryNode) bool {
@@ -120,18 +135,22 @@ func (n *TernaryNode) Each(proc func(Node) bool) {
 	f(n.firstChild)
 }
 
+// RemoveAll removes all descended nodes.
 func (n *TernaryNode) RemoveAll() {
 	n.firstChild = nil
 }
 
+// Label returns a label rune.
 func (n *TernaryNode) Label() rune {
 	return n.label
 }
 
+// Value returns a value for the node.
 func (n *TernaryNode) Value() interface{} {
 	return n.value
 }
 
+// SetValue set a value for the node.
 func (n *TernaryNode) SetValue(v interface{}) {
 	n.value = v
 }
@@ -150,6 +169,7 @@ func (n *TernaryNode) children() []*TernaryNode {
 	return children
 }
 
+// Balance balances all descended nodes.
 func (n *TernaryNode) Balance() {
 	if n.firstChild == nil {
 		return
@@ -171,11 +191,10 @@ func balance(nodes []*TernaryNode, s, e int) *TernaryNode {
 	} else if count == 2 {
 		nodes[s].high = nodes[s+1]
 		return nodes[s]
-	} else {
-		mid := (s + e) / 2
-		n := nodes[mid]
-		n.low = balance(nodes, s, mid)
-		n.high = balance(nodes, mid+1, e)
-		return n
 	}
+	mid := (s + e) / 2
+	n := nodes[mid]
+	n.low = balance(nodes, s, mid)
+	n.high = balance(nodes, mid+1, e)
+	return n
 }

ternary_test.go

@@ -7,10 +7,10 @@ import (
 
 func assertNilBoth(t *testing.T, n *TernaryNode) {
 	if n.low != nil {
-		t.Errorf("low node has value", &n.low)
+		t.Errorf("low node has value: %+v", &n.low)
 	}
 	if n.high != nil {
-		t.Errorf("high node has value", &n.high)
+		t.Errorf("high node has value: %+v", &n.high)
 	}
 }
 

trie.go

@@ -4,17 +4,20 @@ import (
 	"container/list"
 )
 
+// Trie provides accessors for trie-tree
 type Trie interface {
 	Root() Node
 	Get(string) Node
 	Put(string, interface{}) Node
 	Size() int
 }
 
+// NewTrie creates a new Trie instance.
 func NewTrie() Trie {
 	return NewTernaryTrie()
 }
 
+// Get gets a node for k as key.
 func Get(t Trie, k string) Node {
 	if t == nil {
 		return nil
@@ -29,6 +32,7 @@ func Get(t Trie, k string) Node {
 	return n
 }
 
+// Put puts a pair of key and value then returns the node for it.
 func Put(t Trie, k string, v interface{}) Node {
 	if t == nil {
 		return nil
@@ -41,6 +45,7 @@ func Put(t Trie, k string, v interface{}) Node {
 	return n
 }
 
+// EachDepth enumerates nodes in trie for depth.
 func EachDepth(t Trie, proc func(Node) bool) {
 	if t == nil {
 		return
@@ -54,6 +59,7 @@ func EachDepth(t Trie, proc func(Node) bool) {
 	r.Each(f)
 }
 
+// EachWidth enumerates nodes in trie for width.
 func EachWidth(t Trie, proc func(Node) bool) {
 	if t == nil {
 		return
@@ -74,19 +80,39 @@ func EachWidth(t Trie, proc func(Node) bool) {
 	}
 }
 
+// Node provides accessors for nodes of trie-tree
 type Node interface {
+
+	// Get returns a child node for k.
 	Get(k rune) Node
+
+	// Dig digs a node for k. it returns node and a flag for whether dig or
+	// not.
 	Dig(k rune) (Node, bool)
+
+	// HasChildren returns the node hash any children or not.
 	HasChildren() bool
+
+	// Size counts descended nodes.
 	Size() int
+
+	// Each enumerates descended nodes.
 	Each(func(Node) bool)
+
+	// RemoveAll removes all descended nodes.
 	RemoveAll()
 
+	// Label returns a label rune.
 	Label() rune
+
+	// Value returns a value for the node.
 	Value() interface{}
+
+	// SetValue set a value for the node.
 	SetValue(v interface{})
 }
 
+// Children returns all children of the node.
 func Children(n Node) []Node {
 	children := make([]Node, n.Size())
 	idx := 0