Change api (#7)

* avltree修改完成

* btree 修改

* linkedlist

* rbtree接口修改完

* skip 接口修改完成

Author: guonaihong

api/api.go

@@ -6,7 +6,7 @@ type Map[K constraints.Ordered, V any] interface {
 	// 获取
 	Get(k K) (elem V)
 	// 获取
-	GetWithErr(k K) (elem V, err error)
+	GetWithBool(k K) (elem V, ok bool)
 	// 删除
 	Delete(k K)
 	// 设置

avltree/avltree.go

@@ -5,7 +5,6 @@ package avltree
 // 参考资料
 // https://github.com/skywind3000/avlmini
 import (
-	"errors"
 	"fmt"
 
 	"github.com/antlabs/gstl/api"
@@ -14,8 +13,6 @@ import (
 	"golang.org/x/exp/constraints"
 )
 
-var ErrNotFound = errors.New("avltree: not found value")
-
 var _ api.SortedMap[int, int] = (*AvlTree[int, int])(nil)
 
 // 元素
@@ -191,47 +188,47 @@ func New[K constraints.Ordered, V any]() *AvlTree[K, V] {
 }
 
 // 第一个节点
-func (a *AvlTree[K, V]) First() (v V, err error) {
+func (a *AvlTree[K, V]) First() (v V, ok bool) {
 	n := a.root.node
 	if n == nil {
-		err = ErrNotFound
+		ok = false
 		return
 	}
 
 	for n.left != nil {
 		n = n.left
 	}
 
-	return n.val, nil
+	return n.val, true
 }
 
 // 最后一个节点
-func (a *AvlTree[K, V]) Last() (v V, err error) {
+func (a *AvlTree[K, V]) Last() (v V, ok bool) {
 	n := a.root.node
 	if n == nil {
-		err = ErrNotFound
+		ok = false
 		return
 	}
 
 	for n.right != nil {
 		n = n.right
 	}
 
-	return n.val, nil
+	return n.val, true
 }
 
 // Get
 func (a *AvlTree[K, V]) Get(k K) (v V) {
-	v, _ = a.GetWithErr(k)
+	v, _ = a.GetWithBool(k)
 	return
 }
 
 // 从avl tree找到需要的值
-func (a *AvlTree[K, V]) GetWithErr(k K) (v V, err error) {
+func (a *AvlTree[K, V]) GetWithBool(k K) (v V, ok bool) {
 	n := a.root.node
 	for n != nil {
 		if n.key == k {
-			return n.val, nil
+			return n.val, true
 		}
 
 		if k > n.key {
@@ -241,7 +238,6 @@ func (a *AvlTree[K, V]) GetWithErr(k K) (v V, err error) {
 		}
 	}
 
-	err = ErrNotFound
 	return
 }
 

avltree/avltree_test.go

@@ -18,8 +18,8 @@ func Test_SetAndGet(t *testing.T) {
 	}
 
 	for i := 0; i < max; i++ {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err)
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok)
 		assert.Equal(t, v, i)
 	}
 }
@@ -33,8 +33,8 @@ func Test_SetAndGet2(t *testing.T) {
 	}
 
 	for i := max; i >= 0; i-- {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err)
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok)
 		assert.Equal(t, v, i)
 	}
 }
@@ -57,15 +57,15 @@ func Test_AVLTree_Delete1(t *testing.T) {
 
 		// max/2-max应该能找到
 		for i := max / 2; i < max; i++ {
-			v, err := b.GetWithErr(i)
-			assert.NoError(t, err, fmt.Sprintf("index:%d", i))
+			v, ok := b.GetWithBool(i)
+			assert.True(t, ok, fmt.Sprintf("index:%d", i))
 			assert.Equal(t, v, i, fmt.Sprintf("index:%d", i))
 		}
 
 		// 0-max/2应该找不到
 		for i := 0; i < max/2; i++ {
-			v, err := b.GetWithErr(i)
-			assert.Error(t, err, fmt.Sprintf("index:%d", i))
+			v, ok := b.GetWithBool(i)
+			assert.False(t, ok, fmt.Sprintf("index:%d", i))
 			assert.Equal(t, v, 0, fmt.Sprintf("index:%d", i))
 		}
 	}

btree/btree.go

@@ -5,7 +5,6 @@ package btree
 // 参考资料
 // https://github.com/tidwall/btree
 import (
-	"errors"
 	"fmt"
 
 	"github.com/antlabs/gstl/api"
@@ -15,7 +14,7 @@ import (
 )
 
 var _ api.SortedMap[int, int] = (*Btree[int, int])(nil)
-var ErrNotFound = errors.New("btree not found")
+var notFound = "not found element"
 
 // btree头结点
 type Btree[K constraints.Ordered, V any] struct {
@@ -198,27 +197,25 @@ func (b *Btree[K, V]) SetWithPrev(k K, v V) (prev V, replaced bool) {
 
 // 获取值, 忽略找不到的情况
 func (b *Btree[K, V]) Get(k K) (v V) {
-	v, _ = b.GetWithErr(k)
+	v, _ = b.GetWithBool(k)
 	return
 }
 
-// 找到err为nil
-// 找不到err为ErrNotFound
-func (b *Btree[K, V]) GetWithErr(k K) (v V, err error) {
+// 找到ok为true
+// 找不到ok为false
+func (b *Btree[K, V]) GetWithBool(k K) (v V, ok bool) {
 	if b.root == nil {
-		err = ErrNotFound
 		return
 	}
 
 	n := b.root
 	for {
 		i, found := b.find(n, k)
 		if found {
-			return n.items.Get(i).val, nil
+			return n.items.Get(i).val, true
 		}
 
 		if n.leaf() {
-			err = ErrNotFound
 			return
 		}
 
@@ -243,10 +240,10 @@ func (b *Btree[K, V]) DeleteWithPrev(k K) (prev V, deleted bool) {
 	}
 
 	if b.root.items.Len() == 0 && !b.root.leaf() {
-		var err error
-		b.root, err = b.root.children.First()
-		if err != nil {
-			panic(err.Error())
+		var ok bool
+		b.root, ok = b.root.children.First()
+		if !ok {
+			panic("not found first element")
 		}
 	}
 
@@ -336,19 +333,19 @@ func (b *Btree[K, V]) rebalance(n *node[K, V], i int) {
 		// 父到右
 		right.items.Insert(0, n.items.Get(i))
 		// 左边最后一个当父
-		last, err := left.items.Pop()
-		if err != nil {
-			panic(err.Error())
+		last, ok := left.items.Pop()
+		if !ok {
+			panic(notFound)
 		}
 
 		// last是从左叶子最后一个元素借过来的
 		n.items.Set(i, last)
 
 		if !left.leaf() {
 
-			last, err := left.children.Pop()
-			if err != nil {
-				panic(err.Error())
+			last, ok := left.children.Pop()
+			if !ok {
+				panic(notFound)
 			}
 			right.children.Insert(0, last)
 		}
@@ -358,18 +355,18 @@ func (b *Btree[K, V]) rebalance(n *node[K, V], i int) {
 		// 左叶先合并父
 		left.items.Push(n.items.Get(i))
 		// 向右边借最左边的元素当父
-		first, err := right.items.PopFront()
-		if err != nil {
-			panic(err.Error())
+		first, ok := right.items.PopFront()
+		if !ok {
+			panic(notFound)
 		}
 
 		// first是和右叶子借过来的
 		n.items.Set(i, first)
 
 		if !left.leaf() {
-			first, err := right.children.PopFront()
-			if err != nil {
-				panic(err.Error())
+			first, ok := right.children.PopFront()
+			if !ok {
+				panic(notFound)
 			}
 
 			left.children.Push(first)
@@ -468,7 +465,7 @@ func (n *node[K, V]) rangeInner(callback func(k K, v V) bool) bool {
 	}
 
 	// n.children比n.items多一个元素. 这里不能漏掉
-	return must.TakeOne(n.children.Last()).rangeInner(callback)
+	return must.TakeOneDiscardBool(n.children.Last()).rangeInner(callback)
 }
 
 // 从后向前倒序遍历b tree
@@ -499,7 +496,7 @@ func (n *node[K, V]) rangePrevInner(callback func(k K, v V) bool) bool {
 
 	// 先右
 	if n.children != nil {
-		if !must.TakeOne(n.children.Last()).rangePrevInner(callback) {
+		if !must.TakeOneDiscardBool(n.children.Last()).rangePrevInner(callback) {
 			return false
 		}
 	}

btree/btree_test.go

@@ -20,8 +20,8 @@ func Test_Btree_SetAndGet(t *testing.T) {
 	}
 
 	for i := 0; i < max; i++ {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err)
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok)
 		assert.Equal(t, v, i)
 	}
 }
@@ -37,8 +37,8 @@ func Test_Btree_SetAndGet_Split(t *testing.T) {
 	}
 
 	for i := 0; i < max; i++ {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err, fmt.Sprintf("index:%d", i))
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok, fmt.Sprintf("index:%d", i))
 		assert.Equal(t, v, i, fmt.Sprintf("index:%d", i))
 	}
 }
@@ -54,8 +54,8 @@ func Test_Btree_SetAndGet_Split_Big(t *testing.T) {
 	}
 
 	for i := 0; i < max; i++ {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err, fmt.Sprintf("index:%d", i))
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok, fmt.Sprintf("index:%d", i))
 		assert.Equal(t, v, i, fmt.Sprintf("index:%d", i))
 	}
 }
@@ -76,8 +76,8 @@ func Test_Btree_SetAndGet_Replace(t *testing.T) {
 	}
 
 	for i := 0; i < max; i++ {
-		v, err := b.GetWithErr(i)
-		assert.NoError(t, err, fmt.Sprintf("index:%d", i))
+		v, ok := b.GetWithBool(i)
+		assert.True(t, ok, fmt.Sprintf("index:%d", i))
 		assert.Equal(t, v, i+1, fmt.Sprintf("index:%d", i))
 	}
 }
@@ -312,15 +312,15 @@ func Test_Btree_Delete1(t *testing.T) {
 
 		// max/2-max应该能找到
 		for i := max / 2; i < max; i++ {
-			v, err := b.GetWithErr(i)
-			assert.NoError(t, err, fmt.Sprintf("index:%d", i))
+			v, ok := b.GetWithBool(i)
+			assert.True(t, ok, fmt.Sprintf("index:%d", i))
 			assert.Equal(t, v, i, fmt.Sprintf("index:%d", i))
 		}
 
 		// 0-max/2应该找不到
 		for i := 0; i < max/2; i++ {
-			v, err := b.GetWithErr(i)
-			assert.Error(t, err, fmt.Sprintf("index:%d", i))
+			v, ok := b.GetWithBool(i)
+			assert.False(t, ok, fmt.Sprintf("index:%d", i))
 			assert.Equal(t, v, 0, fmt.Sprintf("index:%d", i))
 		}
 	}
@@ -360,17 +360,16 @@ func Test_Btree_Delete2(t *testing.T) {
 
 		// 查找后半段, 应该找不到
 		for i := start; i < max; i++ {
-			v, err := b.GetWithErr(i)
-			assert.Error(t, err, fmt.Sprintf("index:%d", i))
+			v, ok := b.GetWithBool(i)
+			assert.False(t, ok, fmt.Sprintf("index:%d", i))
 			assert.Equal(t, v, 0, fmt.Sprintf("index:%d", i))
 		}
 
 		// 查找前半段
 		for i := 0; i < start; i++ {
-			v, err := b.GetWithErr(i)
-			assert.NoError(t, err, fmt.Sprintf("index:%d, max:%d, delete-start:%d", i, max, start))
-			if err != nil {
-				fmt.Println(b.GetWithErr(i))
+			v, ok := b.GetWithBool(i)
+			assert.True(t, ok, fmt.Sprintf("index:%d, max:%d, delete-start:%d", i, max, start))
+			if !ok {
 				return
 			}