树形类型-方法介绍 - 图1提示

以下常用方法列表，文档更新可能滞后于代码新特性，更多的方法及示例请参考代码文档： https://pkg.go.dev/github.com/gogf/gf/v2/container/gtree

NewBTree

  • 说明： NewBTree 使用 m(最大子节点数量)和自定义的比较方法创建 BTree。参数 safe 用于指定是否使用并发安全的 tree，默认情况下为 false。

  • 注意：参数 m 必须大于等于 3，否则会 panic。

  • 格式：

  1. NewBTree(m int, comparator func(v1, v2 interface{}) int, safe ...bool) *BTree
  • 示例：
  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

  • 说明： NewBTreeFrom 使用 m(最大子节点数量)，自定义的比较方法和类型为 map[interface{}]interface{} 的 data 创建 BTree。参数 safe 用于指定是否使用并发安全的 tree，默认情况下为 false。

  • 注意：参数 m 必须大于等于 3，否则会 panic。

  • 格式：

  1. NewBTreeFrom(m int, comparator func(v1, v2 interface{}) int, data map[interface{}]interface{}, safe ...bool) *BTree
  • 示例：
  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

  • 说明： clone 返回一个值为当前 tree 值的副本的新 BTree。

  • 格式：

  1. Clone() *BTree
  • 示例：
  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

  • 说明： Set 为 tree 设置 key/value。

  • 格式：

  1. Set(key interface{}, value interface{})
  • 示例：
  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

  • 说明： Sets 为 tree 批量设置 key/value。

  • 格式：

  1. Sets(data map[interface{}]interface{})
  • 示例：
  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

  • 说明： Get 返回参数 key 对应的值 value，如 key 不存在，则返回 Nil。

  • 格式：

  1. Get(key interface{}) (value interface{})
  • 示例：
  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

  • 说明： GetOrSet 如 key 存在，则返回 value，如 key 不存在，使用 key 和 value 设置键值，然后返回该值。

  • 格式：

  1. GetOrSet(key interface{}, value interface{}) interface{}
  • 示例：
  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

  • 说明： GetOrSetFunc 如 key 存在，则返回 value，如 key 不存在，使用 key 和 func f 的返回值设置键值，然后返回该值。

  • 格式：

  1. GetOrSetFunc(key interface{}, f func() interface{}) interface{}
  • 示例：
  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

  • 说明： GetOrSetFunc 如 key 存在，则返回 value，如 key 不存在，使用 key 和 func f 的返回值设置键值，然后返回该值。

  • 注意： GetOrSetFuncLock 与 GetOrSetFunc 函数的不同之处在于它在写锁中执行函数 f。

  • 格式：

  1. GetOrSetFuncLock(key interface{}, f func() interface{}) interface{}
  • 示例：
  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

  • 说明： GetVar 根据键名 key 查询并返回对应的键值，类型为 *gvar.Var。

  • 注意：返回的 gvar.Var 是非并发安全的。

  • 格式：

  1. GetVar(key interface{}) *gvar.Var
  • 示例：
  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

  • 说明： GetVarOrSet 使用 GetOrSet 的结果返回，类型为 *gvar.Var。

  • 注意：返回的 gvar.Var 是非并发安全的。

  • 格式：

  1. GetVarOrSet(key interface{}, value interface{}) *gvar.Var
  • 示例：
  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

  • 说明： GetVarOrSetFunc 使用 GetOrSetFunc 的结果返回，类型为 *gvar.Var。
  • 注意：返回的 gvar.Var 是非并发安全的。
  • 格式：
  1. GetVarOrSetFunc(key interface{}, f func() interface{}) *gvar.Var
  • 示例：
  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

  • 说明： GetVarOrSetFuncLock 使用 GetOrSetFuncLock 的结果返回，类型为 *gvar.Var。

  • 注意：返回的 gvar.Var 是非并发安全的。

  • 格式：

  1. GetVarOrSetFuncLock(key interface{}, f func() interface{}) *gvar.Var
  • 示例：
  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

  • 说明：如果 key 不存在，则 SetIfNotExist 为 map 设置值键值对 key/value，并且返回 true。如果 key 存在，则返回 false，而 value 将被忽略。

  • 格式：

  1. SetIfNotExist(key interface{}, value interface{}) bool
  • 示例：
  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

  • 说明：如果 key 不存在，则 SetIfNotExistFunc 设置值为函数 f 的返回值，并且返回 true。如果 key 存在，则返回 false，并且 value 将被忽略。

  • 格式：

  1. SetIfNotExistFunc(key interface{}, f func() interface{}) bool
  • 示例：
  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

  • 说明：如果 key 不存在，则 SetIfNotExistFunc 设置值为 func c 的返回值，然后返回 true。如果 key 存在，则返回 false，而 value 将被忽略。

  • SetIfNotExistFuncLock 与 SetIfNotExistFunc 函数的不同之处在于它在 mutex.Lock 中执行函数 f。

  • 格式：

  1. SetIfNotExistFuncLock(key interface{}, f func() interface{}) bool
  • 示例：
  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

  • 说明： Contains 检查 key 在 tree 中是否存在。如果 key 存在，则返回 true，否则返回 false。

  • 格式：

  1. Contains(key interface{}) bool
  • 示例：
  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

  • 说明：按给定的 key 从 tree 中删除 value，并返回此删除的 value。

  • 格式：

  1. Remove(key interface{}) (value interface{})
  • 示例：
  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

  • 说明： Removes 按给定的 key 批量删除 tree 的 value。

  • 格式：

  1. Removes(keys []interface{})
  • 示例：
  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

  • 说明： IsEmpty 检查 tree 是否为空。如果 tree 为空，则返回 true，否则返回 false。

  • 格式：

  1. IsEmpty() bool
  • 示例：
  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

  • 说明： Size 返回 tree 的大小。

  • 格式：

  1. Size() int
  • 示例：
  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

  • 说明： Keys 按升序返回所有的 key。

  • 格式：

  1. Keys() []interface{}
  • 示例：
  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

  • 说明： Values 按 key 的升序返回所有的 value。

  • 格式：

  1. Values() []interface{}
  • 示例：
  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

  • 说明： Map 以 map 的形式返回所有的 key/value。

  • 格式：

  1. Map() map[interface{}]interface{}
  • 示例：
  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

  • 说明： MapStrAny 以 map[string]interface{} 的形式返回所有的 key/value。

  • 格式：

  1. MapStrAny() map[string]interface{}
  • 示例：
  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

  • 说明： Clear 删除 tree 的所有数据。

  • 格式：

  1. Clear()
  • 示例：
  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

  • 说明： Replace 用类型为 map[interface{}]interface{} 的 data 替换 tree 的 key/value。

  • 格式：

  1. Replace(data map[interface{}]interface{})
  • 示例：
  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

  • 说明： Height 返回 tree 的高度。

  • 格式：

  1. Height() int
  • 示例：
  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

  • 说明： Left 返回最左边（最小）的类型为 *BTreeEntry 的 node，如果 tree 是空的，则返回 nil。

  • 格式：

  1. Left() *BTreeEntry
  • 示例：
  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

  • 说明： Left 返回最右边（最大）的类型为 *BTreeEntry 的 node，如果 tree 是空的，则返回 nil。

  • 格式：

  1. Right() *BTreeEntry
  • 示例：
  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

  • 说明： String 返回 tree 的 node 显示（用于调试）。

  • 格式：

  1. String() string
  • 示例：
  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

  • 说明： Search 使用参数 key 搜索 tree。如果找到 key，则返回其对应的键值，并且返回参数 found 为 true，否则为 false。

  • 格式：

  1. Search(key interface{}) (value interface{}, found bool)
  • 示例：
  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

  • 说明： Print 将 tree 打印到标准输出。

  • 格式：

  1. Print()
  • 示例：
  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

  • 说明： Iterator 等同于 IteratorAsc 。

  • 格式：

  1. Iterator(f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： IteratorFrom 等同于 IteratorAscFrom 。

  • 格式：

  1. IteratorFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： IteratorAsc 使用自定义回调函数 f 以只读方式按升序迭代 tree。如果 f 返回 true，则继续迭代，返回 false 则停止。

  • 格式：

  1. IteratorAsc(f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： IteratorAscFrom 使用自定义回调函数 f 以只读方式按升序迭代 tree。参数 key 指定从哪个 key 开始迭代。参数 match 为 true 时，从 key 完全匹配时开始迭代，否则使用索引搜索迭代。如果 f 返回 true，则继续迭代，返回 false 则停止。

  • 格式：

  1. IteratorAscFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： IteratorDesc 使用自定义回调函数 f 以只读方式按降序迭代 tree。如果 f 返回 true，则继续迭代，返回 false 则停止。

  • 格式：

  1. IteratorDesc(f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： IteratorDescFrom 使用自定义回调函数 f 以只读方式按降序迭代 tree。参数 key 指定从哪个 key 开始迭代。参数 match 为 true 时，从 key 完全匹配时开始迭代，否则使用索引搜索迭代。如果 f 返回 true，则继续迭代，返回 false 则停止。

  • 格式：

  1. IteratorDescFrom(key interface{}, match bool, f func(key, value interface{}) bool)
  • 示例：
  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

  • 说明： MarshalJSON 实现 json.Marshal 的接口。

  • 格式：

  1. MarshalJSON() ([]byte, error)
  • 示例：
  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. }