Tree - Methods - 图1tip

The following is a list of commonly used methods; documentation updates may lag behind new features in the code. For more methods and examples, please refer to the code documentation: https://pkg.go.dev/github.com/gogf/gf/v2/container/gtree

NewBTree

  • Description: NewBTree creates a BTree using m (maximum number of child nodes) and a custom comparator. The safe parameter specifies whether to use a concurrency-safe tree, with a default value of false.

  • Note: The m parameter must be greater than or equal to 3, otherwise it will panic.

  • Format:

  1. NewBTree(m int, comparator func(v1, v2 interface{}) int, safe ...bool) *BTree
  • Example:
  1. func ExampleNewBTree() {
  2.       bTree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           bTree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  6.       fmt.Println(bTree.Map())
  8.       // Output:
  9.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  10. }

NewBTreeFrom

  • Description: NewBTreeFrom creates a BTree using m (maximum number of child nodes), a custom comparator, and data of type map[interface{}]interface{}. The safe parameter specifies whether to use a concurrency-safe tree, with a default value of false.

  • Note: The m parameter must be greater than or equal to 3, otherwise it will panic.

  • Format:

  1. NewBTreeFrom(m int, comparator func(v1, v2 interface{}) int, data map[interface{}]interface{}, safe ...bool) *BTree
  • Example:
  1. func ExampleNewBTreeFrom() {
  2.       bTree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           bTree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       otherBTree := gtree.NewBTreeFrom(3, gutil.ComparatorString, bTree.Map())
  8.       fmt.Println(otherBTree.Map())
  10.       // Output:
  11.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  12. }

Clone

  • Description: Clone returns a new BTree, which is a copy of the current tree.

  • Format:

  1. Clone() *BTree
  • Example:
  1. func ExampleBTree_Clone() {
  2.       b := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           b.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       tree := b.Clone()
  9.       fmt.Println(tree.Map())
  10.       fmt.Println(tree.Size())
  12.       // Output:
  13.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  14.       // 6
  15. }

Set

  • Description: Set sets the key/value for the tree.

  • Format:

  1. Set(key interface{}, value interface{})
  • Example:
  1. func ExampleBTree_Set() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Map())
  8.       fmt.Println(tree.Size())
  10.       // Output:
  11.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  12.       // 6
  13. }

Sets

  • Description: Sets sets key/value for the tree in batches.

  • Format:

  1. Sets(data map[interface{}]interface{})
  • Example:
  1. func ExampleBTree_Sets() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  4.       tree.Sets(map[interface{}]interface{}{
  5.           "key1": "val1",
  6.           "key2": "val2",
  7.       })
  9.       fmt.Println(tree.Map())
  10.       fmt.Println(tree.Size())
  12.       // Output:
  13.       // map[key1:val1 key2:val2]
  14.       // 2
  15. }

Get

  • Description: Get returns the value value corresponding to the parameter key. If key does not exist, it returns Nil.

  • Format:

  1. Get(key interface{}) (value interface{})
  • Example:
  1. func ExampleBTree_Get() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Get("key1"))
  8.       fmt.Println(tree.Get("key10"))
  10.       // Output:
  11.       // val1
  12.       // <nil>
  13. }

GetOrSet

  • Description: GetOrSet returns value if key exists; if key does not exist, it sets the key-value with key and value, then returns the value.

  • Format:

  1. GetOrSet(key interface{}, value interface{}) interface{}
  • Example:
  1. func ExampleBTree_GetOrSet() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetOrSet("key1", "newVal1"))
  8.       fmt.Println(tree.GetOrSet("key6", "val6"))
  10.       // Output:
  11.       // val1
  12.       // val6
  13. }

GetOrSetFunc

  • Description: GetOrSetFunc returns value if key exists; if key does not exist, it sets the key-value with key and the return value of func f, then returns the value.

  • Format:

  1. GetOrSetFunc(key interface{}, f func() interface{}) interface{}
  • Example:
  1. func ExampleBTree_GetOrSetFunc() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetOrSetFunc("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.GetOrSetFunc("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // val1
  16.       // val6
  17. }

GetOrSetFuncLock

  • Description: GetOrSetFunc returns value if key exists; if key does not exist, it sets the key-value with key and the return value of func f, then returns the value.

  • Note: The difference between GetOrSetFuncLock and GetOrSetFunc is that it executes the function f in a write lock.

  • Format:

  1. GetOrSetFuncLock(key interface{}, f func() interface{}) interface{}
  • Example:
  1. func ExampleBTree_GetOrSetFuncLock() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetOrSetFuncLock("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.GetOrSetFuncLock("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // val1
  16.       // val6
  17. }

GetVar

  • Description: GetVar searches and returns the key value corresponding to the key name key, the type is *gvar.Var.

  • Note: The returned gvar.Var is not concurrent safe.

  • Format:

  1. GetVar(key interface{}) *gvar.Var
  • Example:
  1. func ExampleBTree_GetVar() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetVar("key1").String())
  9.       // Output:
  10.       // val1
  11. }

GetVarOrSet

  • Description: GetVarOrSet returns the result of GetOrSet, the type is *gvar.Var.

  • Note: The returned gvar.Var is not concurrent safe.

  • Format:

  1. GetVarOrSet(key interface{}, value interface{}) *gvar.Var
  • Example:
  1. func ExampleBTree_GetVarOrSet() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetVarOrSet("key1", "newVal1"))
  8.       fmt.Println(tree.GetVarOrSet("key6", "val6"))
  10.       // Output:
  11.       // val1
  12.       // val6
  13. }

GetVarOrSetFunc

  • Description: GetVarOrSetFunc returns the result of GetOrSetFunc, the type is *gvar.Var.
  • Note: The returned gvar.Var is not concurrent safe.
  • Format:
  1. GetVarOrSetFunc(key interface{}, f func() interface{}) *gvar.Var
  • Example:
  1. func ExampleBTree_GetVarOrSetFunc() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetVarOrSetFunc("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.GetVarOrSetFunc("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // val1
  16.       // val6
  17. }

GetVarOrSetFuncLock

  • Description: GetVarOrSetFuncLock returns the result of GetOrSetFuncLock, the type is *gvar.Var.

  • Note: The returned gvar.Var is not concurrent safe.

  • Format:

  1. GetVarOrSetFuncLock(key interface{}, f func() interface{}) *gvar.Var
  • Example:
  1. func ExampleBTree_GetVarOrSetFuncLock() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.GetVarOrSetFuncLock("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.GetVarOrSetFuncLock("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // val1
  16.       // val6
  17. }

SetIfNotExist

  • Description: If key does not exist, SetIfNotExist sets the key-value pair key/value for the map and returns true. If key exists, it returns false, and value will be ignored.

  • Format:

  1. SetIfNotExist(key interface{}, value interface{}) bool
  • Example:
  1. func ExampleBTree_SetIfNotExist() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.SetIfNotExist("key1", "newVal1"))
  8.       fmt.Println(tree.SetIfNotExist("key6", "val6"))
  10.       // Output:
  11.       // false
  12.       // true
  13. }

SetIfNotExistFunc

  • Description: If key does not exist, SetIfNotExistFunc sets the value to the return value of the function f and returns true. If key exists, it returns false, and value will be ignored.

  • Format:

  1. SetIfNotExistFunc(key interface{}, f func() interface{}) bool
  • Example:
  1. func ExampleBTree_SetIfNotExistFunc() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.SetIfNotExistFunc("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.SetIfNotExistFunc("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // false
  16.       // true
  17. }

SetIfNotExistFuncLock

  • Description: If key does not exist, SetIfNotExistFunc sets the value to the return value of func c, then returns true. If key exists, it returns false, and value will be ignored.

  • The difference between SetIfNotExistFuncLock and SetIfNotExistFunc is that it executes the function f within mutex.Lock.

  • Format:

  1. SetIfNotExistFuncLock(key interface{}, f func() interface{}) bool
  • Example:
  1. func ExampleBTree_SetIfNotExistFuncLock() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.SetIfNotExistFuncLock("key1", func() interface{} {
  8.           return "newVal1"
  9.       }))
  10.       fmt.Println(tree.SetIfNotExistFuncLock("key6", func() interface{} {
  11.           return "val6"
  12.       }))
  14.       // Output:
  15.       // false
  16.       // true
  17. }

Contains

  • Description: Contains checks if key exists in the tree. If key exists, it returns true; otherwise, it returns false.

  • Format:

  1. Contains(key interface{}) bool
  • Example:
  1. func ExampleBTree_Contains() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Contains("key1"))
  8.       fmt.Println(tree.Contains("key6"))
  10.       // Output:
  11.       // true
  12.       // false
  13. }

Remove

  • Description: Delete the value from tree according to the given key and return this deleted value.

  • Format:

  1. Remove(key interface{}) (value interface{})
  • Example:
  1. func ExampleBTree_Remove() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Remove("key1"))
  8.       fmt.Println(tree.Remove("key6"))
  9.       fmt.Println(tree.Map())
  11.       // Output:
  12.       // val1
  13.       // <nil>
  14.       // map[key0:val0 key2:val2 key3:val3 key4:val4 key5:val5]
  15. }

Removes

  • Description: Removes deletes value of tree in batches according to the given key.

  • Format:

  1. Removes(keys []interface{})
  • Example:
  1. func ExampleBTree_Removes() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       removeKeys := make([]interface{}, 2)
  8.       removeKeys = append(removeKeys, "key1")
  9.       removeKeys = append(removeKeys, "key6")
  11.       tree.Removes(removeKeys)
  13.       fmt.Println(tree.Map())
  15.       // Output:
  16.       // map[key0:val0 key2:val2 key3:val3 key4:val4 key5:val5]
  17. }

IsEmpty

  • Description: IsEmpty checks if tree is empty. If tree is empty, it returns true; otherwise, it returns false.

  • Format:

  1. IsEmpty() bool
  • Example:
  1. func ExampleBTree_IsEmpty() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  4.       fmt.Println(tree.IsEmpty())
  6.       for i := 0; i < 6; i++ {
  7.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  8.       }
  10.       fmt.Println(tree.IsEmpty())
  12.       // Output:
  13.       // true
  14.       // false
  15. }

Size

  • Description: Size returns the size of the tree.

  • Format:

  1. Size() int
  • Example:
  1. func ExampleBTree_Size() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  4.       fmt.Println(tree.Size())
  6.       for i := 0; i < 6; i++ {
  7.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  8.       }
  10.       fmt.Println(tree.Size())
  12.       // Output:
  13.       // 0
  14.       // 6
  15. }

Keys

  • Description: Keys returns all keys in ascending order.

  • Format:

  1. Keys() []interface{}
  • Example:
  1. func ExampleBTree_Keys() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 6; i > 0; i-- {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Keys())
  9.       // Output:
  10.       // [key1 key2 key3 key4 key5 key6]
  11. }

Values

  • Description: Values returns all values in ascending order of key.

  • Format:

  1. Values() []interface{}
  • Example:
  1. func ExampleBTree_Values() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 6; i > 0; i-- {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Values())
  9.       // Output:
  10.       // [val1 val2 val3 val4 val5 val6]
  11. }

Map

  • Description: Map returns all key/value pairs in the form of a map.

  • Format:

  1. Map() map[interface{}]interface{}
  • Example:
  1. func ExampleBTree_Map() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Map())
  9.       // Output:
  10.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  11. }

MapStrAny

  • Description: MapStrAny returns all key/value pairs in the form of map[string]interface{}.

  • Format:

  1. MapStrAny() map[string]interface{}
  • Example:
  1. func ExampleBTree_MapStrAny() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set(1000+i, "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.MapStrAny())
  9.       // Output:
  10.       // map[1000:val0 1001:val1 1002:val2 1003:val3 1004:val4 1005:val5]
  11. }

Clear

  • Description: Clear deletes all data in the tree.

  • Format:

  1. Clear()
  • Example:
  1. func ExampleBTree_Clear() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set(1000+i, "val"+gconv.String(i))
  5.       }
  6.       fmt.Println(tree.Size())
  8.       tree.Clear()
  9.       fmt.Println(tree.Size())
  11.       // Output:
  12.       // 6
  13.       // 0
  14. }

Replace

  • Description: Replace replaces the key/value in the tree with data of type map[interface{}]interface{}.

  • Format:

  1. Replace(data map[interface{}]interface{})
  • Example:
  1. func ExampleBTree_Replace() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Map())
  9.       data := map[interface{}]interface{}{
  10.           "newKey0": "newVal0",
  11.           "newKey1": "newVal1",
  12.           "newKey2": "newVal2",
  13.       }
  15.       tree.Replace(data)
  17.       fmt.Println(tree.Map())
  19.       // Output:
  20.       // map[key0:val0 key1:val1 key2:val2 key3:val3 key4:val4 key5:val5]
  21.       // map[newKey0:newVal0 newKey1:newVal1 newKey2:newVal2]
  22. }

Height

  • Description: Height returns the height of the tree.

  • Format:

  1. Height() int
  • Example:
  1. func ExampleBTree_Height() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorInt)
  3.       for i := 0; i < 100; i++ {
  4.           tree.Set(i, i)
  5.       }
  6.       fmt.Println(tree.Height())
  8.       // Output:
  9.       // 6
  10. }

Left

  • Description: Left returns the leftmost (smallest) node of type *BTreeEntry, or nil if the tree is empty.

  • Format:

  1. Left() *BTreeEntry
  • Example:
  1. func ExampleBTree_Left() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorInt)
  3.       for i := 1; i < 100; i++ {
  4.           tree.Set(i, i)
  5.       }
  6.       fmt.Println(tree.Left().Key, tree.Left().Value)
  8.       emptyTree := gtree.NewBTree(3, gutil.ComparatorInt)
  9.       fmt.Println(emptyTree.Left())
  11.       // Output:
  12.       // 1 1
  13.       // <nil>
  14. }

Right

  • Description: Right returns the rightmost (largest) node of type *BTreeEntry, or nil if the tree is empty.

  • Format:

  1. Right() *BTreeEntry
  • Example:
  1. func ExampleBTree_Right() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorInt)
  3.       for i := 1; i < 100; i++ {
  4.           tree.Set(i, i)
  5.       }
  6.       fmt.Println(tree.Right().Key, tree.Right().Value)
  8.       emptyTree := gtree.NewBTree(3, gutil.ComparatorInt)
  9.       fmt.Println(emptyTree.Left())
  11.       // Output:
  12.       // 99 99
  13.       // <nil>
  14. }

String

  • Description: String returns a display (for debugging) of the node in the tree.

  • Format:

  1. String() string
  • Example:
  1. func ExampleBTree_String() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.String())
  9.       // Output:
  10.       // key0
  11.       // key1
  12.       //     key2
  13.       // key3
  14.       //     key4
  15.       //     key5
  16. }

Search

  • Description: Search searches the tree using the parameter key. If the key is found, it returns its corresponding key-value and returns the parameter found as true, otherwise false.

  • Format:

  1. Search(key interface{}) (value interface{}, found bool)
  • Example:
  1. func ExampleBTree_Search() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       fmt.Println(tree.Search("key0"))
  8.       fmt.Println(tree.Search("key6"))
  10.       // Output:
  11.       // val0 true
  12.       // <nil> false
  13. }

Print

  • Description: Print prints the tree to standard output.

  • Format:

  1. Print()
  • Example:
  1. func ExampleBTree_Print() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       tree.Print()
  9.       // Output:
  10.       // key0
  11.       // key1
  12.       //     key2
  13.       // key3
  14.       //     key4
  15.       //     key5
  16. }

Iterator

  • Description: Iterator is equivalent to IteratorAsc.

  • Format:

  1. Iterator(f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_Iterator() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 10; i++ {
  4.           tree.Set(i, 10-i)
  5.       }
  7.       var totalKey, totalValue int
  8.       tree.Iterator(func(key, value interface{}) bool {
  9.           totalKey += key.(int)
  10.           totalValue += value.(int)
  12.           return totalValue < 20
  13.       })
  15.       fmt.Println("totalKey:", totalKey)
  16.       fmt.Println("totalValue:", totalValue)
  18.       // Output:
  19.       // totalKey: 3
  20.       // totalValue: 27
  21. }

IteratorFrom

  • Description: IteratorFrom is equivalent to IteratorAscFrom.

  • Format:

  1. IteratorFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_IteratorFrom() {
  2.       m := make(map[interface{}]interface{})
  3.       for i := 1; i <= 5; i++ {
  4.           m[i] = i * 10
  5.       }
  6.       tree := gtree.NewBTreeFrom(3, gutil.ComparatorInt, m)
  8.       tree.IteratorFrom(1, true, func(key, value interface{}) bool {
  9.           fmt.Println("key:", key, ", value:", value)
  10.           return true
  11.       })
  13.       // Output:
  14.       // key: 1 , value: 10
  15.       // key: 2 , value: 20
  16.       // key: 3 , value: 30
  17.       // key: 4 , value: 40
  18.       // key: 5 , value: 50
  19. }

IteratorAsc

  • Description: IteratorAsc iterates over the tree in ascending order using a custom callback function f in read-only mode. If f returns true, it continues iterating; if it returns false, it stops.

  • Format:

  1. IteratorAsc(f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_IteratorAsc() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 10; i++ {
  4.           tree.Set(i, 10-i)
  5.       }
  7.       tree.IteratorAsc(func(key, value interface{}) bool {
  8.           fmt.Println("key:", key, ", value:", value)
  9.           return true
  10.       })
  12.       // Output:
  13.       // key: 0 , value: 10
  14.       // key: 1 , value: 9
  15.       // key: 2 , value: 8
  16.       // key: 3 , value: 7
  17.       // key: 4 , value: 6
  18.       // key: 5 , value: 5
  19.       // key: 6 , value: 4
  20.       // key: 7 , value: 3
  21.       // key: 8 , value: 2
  22.       // key: 9 , value: 1
  23. }

IteratorAscFrom

  • Description: IteratorAscFrom iterates over the tree in ascending order using a custom callback function f in read-only mode. The parameter key specifies from which key to start iterating. When match is true, iteration starts from the complete match of key; otherwise, iteration uses index searching. If f returns true, it continues iterating; if it returns false, it stops.

  • Format:

  1. IteratorAscFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_IteratorAscFrom_Normal() {
  2.       m := make(map[interface{}]interface{})
  3.       for i := 1; i <= 5; i++ {
  4.           m[i] = i * 10
  5.       }
  6.       tree := gtree.NewBTreeFrom(3, gutil.ComparatorInt, m)
  8.       tree.IteratorAscFrom(1, true, func(key, value interface{}) bool {
  9.           fmt.Println("key:", key, ", value:", value)
  10.           return true
  11.       })
  13.       // Output:
  14.       // key: 1 , value: 10
  15.       // key: 2 , value: 20
  16.       // key: 3 , value: 30
  17.       // key: 4 , value: 40
  18.       // key: 5 , value: 50
  19. }
  1. func ExampleBTree_IteratorAscFrom_NoExistKey() {
  2.       m := make(map[interface{}]interface{})
  3.       for i := 1; i <= 5; i++ {
  4.           m[i] = i * 10
  5.       }
  6.       tree := gtree.NewBTreeFrom(3, gutil.ComparatorInt, m)
  8.       tree.IteratorAscFrom(0, true, func(key, value interface{}) bool {
  9.           fmt.Println("key:", key, ", value:", value)
  10.           return true
  11.       })
  13.       // Output:
  14. }
  1. func ExampleBTree_IteratorAscFrom_NoExistKeyAndMatchFalse() {
  2.       m := make(map[interface{}]interface{})
  3.       for i := 1; i <= 5; i++ {
  4.           m[i] = i * 10
  5.       }
  6.       tree := gtree.NewBTreeFrom(3, gutil.ComparatorInt, m)
  8.       tree.IteratorAscFrom(0, false, func(key, value interface{}) bool {
  9.           fmt.Println("key:", key, ", value:", value)
  10.           return true
  11.       })
  13.       // Output:
  14.       // key: 1 , value: 10
  15.       // key: 2 , value: 20
  16.       // key: 3 , value: 30
  17.       // key: 4 , value: 40
  18.       // key: 5 , value: 50
  19. }

IteratorDesc

  • Description: IteratorDesc iterates over the tree in descending order using a custom callback function f in read-only mode. If f returns true, it continues iterating; if it returns false, it stops.

  • Format:

  1. IteratorDesc(f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_IteratorDesc() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 10; i++ {
  4.           tree.Set(i, 10-i)
  5.       }
  7.       tree.IteratorDesc(func(key, value interface{}) bool {
  8.           fmt.Println("key:", key, ", value:", value)
  9.           return true
  10.       })
  12.       // Output:
  13.       // key: 9 , value: 1
  14.       // key: 8 , value: 2
  15.       // key: 7 , value: 3
  16.       // key: 6 , value: 4
  17.       // key: 5 , value: 5
  18.       // key: 4 , value: 6
  19.       // key: 3 , value: 7
  20.       // key: 2 , value: 8
  21.       // key: 1 , value: 9
  22.       // key: 0 , value: 10
  23. }

IteratorDescFrom

  • Description: IteratorDescFrom iterates over the tree in descending order using a custom callback function f in read-only mode. The parameter key specifies from which key to start iterating. When match is true, iteration starts from the complete match of key; otherwise, iteration uses index searching. If f returns true, it continues iterating; if it returns false, it stops.

  • Format:

  1. IteratorDescFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • Example:
  1. func ExampleBTree_IteratorDescFrom() {
  2.       m := make(map[interface{}]interface{})
  3.       for i := 1; i <= 5; i++ {
  4.           m[i] = i * 10
  5.       }
  6.       tree := gtree.NewBTreeFrom(3, gutil.ComparatorInt, m)
  8.       tree.IteratorDescFrom(5, true, func(key, value interface{}) bool {
  9.           fmt.Println("key:", key, ", value:", value)
  10.           return true
  11.       })
  13.       // Output:
  14.       // key: 5 , value: 50
  15.       // key: 4 , value: 40
  16.       // key: 3 , value: 30
  17.       // key: 2 , value: 20
  18.       // key: 1 , value: 10
  19. }

MarshalJson

  • Description: MarshalJSON implements the json.Marshal interface.

  • Format:

  1. MarshalJSON() ([]byte, error)
  • Example:
  1. func ExampleBTree_MarshalJSON() {
  2.       tree := gtree.NewBTree(3, gutil.ComparatorString)
  3.       for i := 0; i < 6; i++ {
  4.           tree.Set("key"+gconv.String(i), "val"+gconv.String(i))
  5.       }
  7.       bytes, err := json.Marshal(tree)
  8.       if err == nil {
  9.           fmt.Println(gconv.String(bytes))
  10.       }
  12.       // Output:
  13.       // {"key0":"val0","key1":"val1","key2":"val2","key3":"val3","key4":"val4","key5":"val5"}
  14. }