- update documentation, closes #73

README.md

@@ -592,7 +592,7 @@ func main() {
 }
 ```
 
-Extending the red-black tree's functionality  has been demonstrated in the following [example](https://github.com/emirpasic/gods/blob/master/examples/redblacktreeextended.go).
+Extending the red-black tree's functionality  has been demonstrated in the following [example](https://github.com/emirpasic/gods/blob/master/examples/redblacktreeextended/redblacktreeextended.go).
 
 #### AVLTree
 

examples/README.md

@@ -0,0 +1,29 @@
+# GoDS (Go Data Structures)
+
+Various examples on how to use data structures.
+
+## Examples
+
+- [ArrayList](https://github.com/emirpasic/gods/blob/master/examples/arraylist/arraylist.go)
+- [ArrayStack](https://github.com/emirpasic/gods/blob/master/examples/arraystack/arraystack.go)
+- [AVLTree](https://github.com/emirpasic/gods/blob/master/examples/avltree/avltree.go)
+- [BinaryHeap](https://github.com/emirpasic/gods/blob/master/examples/binaryheap/binaryheap.go)
+- [BTree](https://github.com/emirpasic/gods/blob/master/examples/btree/btree.go)
+- [Custom Comparator](https://github.com/emirpasic/gods/blob/master/examples/customcomparator/customcomparator.go)
+- [DoublyLinkedList](https://github.com/emirpasic/gods/blob/master/examples/doublylinkedlist/doublylinkedlist.go)
+- [EnumerableWithIndex](https://github.com/emirpasic/gods/blob/master/examples/enumerablewithindex/enumerablewithindex.go)
+- [EnumerableWithKey](https://github.com/emirpasic/gods/blob/master/examples/enumerablewithkey/enumerablewithkey.go)
+- [HashBidiMap](https://github.com/emirpasic/gods/blob/master/examples/hashbidimap/hashbidimap.go)
+- [HashMap](https://github.com/emirpasic/gods/blob/master/examples/hashmap/hashmap.go)
+- [HashSet](https://github.com/emirpasic/gods/blob/master/examples/hashset/hashset.go)
+- [IteratorWithIndex](https://github.com/emirpasic/gods/blob/master/examples/iteratorwithindex/iteratorwithindex.go)
+- [iteratorwithkey](https://github.com/emirpasic/gods/blob/master/examples/iteratorwithkey/iteratorwithkey.go)
+- [IteratorWithKey](https://github.com/emirpasic/gods/blob/master/examples/linkedliststack/linkedliststack.go)
+- [RedBlackTree](https://github.com/emirpasic/gods/blob/master/examples/redblacktree/redblacktree.go)
+- [RedBlackTreeExtended](https://github.com/emirpasic/gods/blob/master/examples/redblacktreeextended/redblacktreeextended.go)
+- [Serialization](https://github.com/emirpasic/gods/blob/master/examples/serialization/serialization.go)
+- [SinglyLinkedList](https://github.com/emirpasic/gods/blob/master/examples/singlylinkedlist/singlylinkedlist.go)
+- [Sort](https://github.com/emirpasic/gods/blob/master/examples/sort/sort.go)
+- [TreeBidiMap](https://github.com/emirpasic/gods/blob/master/examples/treebidimap/treebidimap.go)
+- [TreeMap](https://github.com/emirpasic/gods/blob/master/examples/treemap/treemap.go)
+- [TreeSet](https://github.com/emirpasic/gods/blob/master/examples/treeset/treeset.go)

examples/arraylist/arraylist.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"github.com/emirpasic/gods/lists/arraylist"
@@ -10,7 +10,7 @@ import (
 )
 
 // ArrayListExample to demonstrate basic usage of ArrayList
-func ArrayListExample() {
+func main() {
 	list := arraylist.New()
 	list.Add("a")                         // ["a"]
 	list.Add("c", "b")                    // ["a","c","b"]

examples/arraystack/arraystack.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/stacks/arraystack"
 
 // ArrayStackExample to demonstrate basic usage of ArrayStack
-func ArrayStackExample() {
+func main() {
 	stack := arraystack.New() // empty
 	stack.Push(1)             // 1
 	stack.Push(2)             // 1, 2

examples/avltree/avltree.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 )
 
 // AVLTreeExample to demonstrate basic usage of AVLTree
-func AVLTreeExample() {
+func main() {
 	tree := avl.NewWithIntComparator() // empty(keys are of type int)
 
 	tree.Put(1, "x") // 1->x

examples/binaryheap/binaryheap.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"github.com/emirpasic/gods/trees/binaryheap"
@@ -10,7 +10,7 @@ import (
 )
 
 // BinaryHeapExample to demonstrate basic usage of BinaryHeap
-func BinaryHeapExample() {
+func main() {
 
 	// Min-heap
 	heap := binaryheap.NewWithIntComparator() // empty (min-heap)

examples/btree/btree.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 )
 
 // BTreeExample to demonstrate basic usage of BTree
-func BTreeExample() {
+func main() {
 	tree := btree.NewWithIntComparator(3) // empty (keys are of type int)
 
 	tree.Put(1, "x") // 1->x

examples/customcomparator/customcomparator.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -33,7 +33,7 @@ func byID(a, b interface{}) int {
 }
 
 // CustomComparatorExample to demonstrate basic usage of CustomComparator
-func CustomComparatorExample() {
+func main() {
 	set := treeset.NewWith(byID)
 
 	set.Add(User{2, "Second"})

examples/doublylinkedlist/doublylinkedlist.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	dll "github.com/emirpasic/gods/lists/doublylinkedlist"
@@ -10,7 +10,7 @@ import (
 )
 
 // DoublyLinkedListExample to demonstrate basic usage of DoublyLinkedList
-func DoublyLinkedListExample() {
+func main() {
 	list := dll.New()
 	list.Add("a")                         // ["a"]
 	list.Append("b")                      // ["a","b"] (same as Add())

examples/enumerablewithindex/enumerablewithindex.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -18,7 +18,7 @@ func printSet(txt string, set *treeset.Set) {
 }
 
 // EnumerableWithIndexExample to demonstrate basic usage of EnumerableWithIndex
-func EnumerableWithIndexExample() {
+func main() {
 	set := treeset.NewWithIntComparator()
 	set.Add(2, 3, 4, 2, 5, 6, 7, 8)
 	printSet("Initial", set) // [ 2 3 4 5 6 7 8 ]

examples/enumerablewithkey/enumerablewithkey.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -18,7 +18,7 @@ func printMap(txt string, m *treemap.Map) {
 }
 
 // EunumerableWithKeyExample to demonstrate basic usage of EunumerableWithKey
-func EunumerableWithKeyExample() {
+func main() {
 	m := treemap.NewWithStringComparator()
 	m.Put("g", 7)
 	m.Put("f", 6)

examples/hashbidimap/hashbidimap.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/maps/hashbidimap"
 
 // HashBidiMapExample to demonstrate basic usage of HashMap
-func HashBidiMapExample() {
+func main() {
 	m := hashbidimap.New() // empty
 	m.Put(1, "x")          // 1->x
 	m.Put(3, "b")          // 1->x, 3->b (random order)

examples/hashmap/hashmap.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/maps/hashmap"
 
 // HashMapExample to demonstrate basic usage of HashMap
-func HashMapExample() {
+func main() {
 	m := hashmap.New() // empty
 	m.Put(1, "x")      // 1->x
 	m.Put(2, "b")      // 2->b, 1->x  (random order)

examples/hashset/hashset.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/sets/hashset"
 
 // HashSetExample to demonstrate basic usage of HashSet
-func HashSetExample() {
+func main() {
 	set := hashset.New()   // empty (keys are of type int)
 	set.Add(1)             // 1
 	set.Add(2, 2, 3, 4, 5) // 3, 1, 2, 4, 5 (random order, duplicates ignored)

examples/iteratorwithindex/iteratorwithindex.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 )
 
 // IteratorWithIndexExample to demonstrate basic usage of IteratorWithIndex
-func IteratorWithIndexExample() {
+func main() {
 	set := treeset.NewWithStringComparator()
 	set.Add("a", "b", "c")
 	it := set.Iterator()

examples/iteratorwithkey/iteratorwithkey.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 )
 
 // IteratorWithKeyExample to demonstrate basic usage of IteratorWithKey
-func IteratorWithKeyExample() {
+func main() {
 	m := treemap.NewWithIntComparator()
 	m.Put(1, "a")
 	m.Put(2, "b")

examples/linkedliststack/linkedliststack.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import lls "github.com/emirpasic/gods/stacks/linkedliststack"
 
 // LinkedListStackExample to demonstrate basic usage of LinkedListStack
-func LinkedListStackExample() {
+func main() {
 	stack := lls.New()  // empty
 	stack.Push(1)       // 1
 	stack.Push(2)       // 1, 2

examples/redblacktree/redblacktree.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 )
 
 // RedBlackTreeExample to demonstrate basic usage of RedBlackTree
-func RedBlackTreeExample() {
+func main() {
 	tree := rbt.NewWithIntComparator() // empty(keys are of type int)
 
 	tree.Put(1, "x") // 1->x

examples/redblacktreeextended/redblacktreeextended.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package redblacktreeextended
 
 import (
 	"fmt"
@@ -81,7 +81,7 @@ func print(tree *RedBlackTreeExtended) {
 }
 
 // RedBlackTreeExtendedExample main method on how to use the custom red-black tree above
-func RedBlackTreeExtendedExample() {
+func main() {
 	tree := RedBlackTreeExtended{rbt.NewWithIntComparator()}
 
 	tree.Put(1, "a") // 1->x (in order)

examples/serialization/serialization.go

@@ -1,4 +1,4 @@
-package examples
+package serialization
 
 import (
 	"fmt"

examples/singlylinkedlist/singlylinkedlist.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	sll "github.com/emirpasic/gods/lists/singlylinkedlist"
@@ -10,7 +10,7 @@ import (
 )
 
 // SinglyLinkedListExample to demonstrate basic usage of SinglyLinkedList
-func SinglyLinkedListExample() {
+func main() {
 	list := sll.New()
 	list.Add("a")                         // ["a"]
 	list.Append("b")                      // ["a","b"] (same as Add())

examples/sort/sort.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/utils"
 
 // SortExample to demonstrate basic usage of basic sort
-func SortExample() {
+func main() {
 	strings := []interface{}{}                  // []
 	strings = append(strings, "d")              // ["d"]
 	strings = append(strings, "a")              // ["d","a"]

examples/treebidimap/treebidimap.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import (
 	"github.com/emirpasic/gods/maps/treebidimap"
@@ -10,7 +10,7 @@ import (
 )
 
 // TreeBidiMapExample to demonstrate basic usage of TreeBidiMap
-func TreeBidiMapExample() {
+func main() {
 	m := treebidimap.NewWith(utils.IntComparator, utils.StringComparator)
 	m.Put(1, "x")        // 1->x
 	m.Put(3, "b")        // 1->x, 3->b (ordered)

examples/treemap/treemap.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/maps/treemap"
 
 // TreeMapExample to demonstrate basic usage of TreeMap
-func TreeMapExample() {
+func main() {
 	m := treemap.NewWithIntComparator() // empty (keys are of type int)
 	m.Put(1, "x")                       // 1->x
 	m.Put(2, "b")                       // 1->x, 2->b (in order)

examples/treeset/treeset.go

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package examples
+package main
 
 import "github.com/emirpasic/gods/sets/treeset"
 
 // TreeSetExample to demonstrate basic usage of TreeSet
-func TreeSetExample() {
+func main() {
 	set := treeset.NewWithIntComparator() // empty
 	set.Add(1)                            // 1
 	set.Add(2, 2, 3, 4, 5)                // 1, 2, 3, 4, 5 (in order, duplicates ignored)