refactor!: ♻️ rename the Add API to Insert

I have renamed the `Add` API to `Insert` to make the APIs of my K-D Tree library consistent with those of existing ones written in Go.

BREAKING CHANGE: With the removal of the `Add` API in this commit, any code that uses the `Add` API will no longer work with future releases of this library created after this commit. Affected codebases must migrate to the `Insert` API to be compatible with future releases of this library.

Author: rishitc

kdtree.go

@@ -112,12 +112,12 @@ func (t *KDTree[T]) Values() []T {
 	return res
 }
 
-func (t *KDTree[T]) Add(value T) bool {
+func (t *KDTree[T]) Insert(value T) bool {
 	if t.root == nil {
 		t.root = NewKDNode(value)
 		return true
 	}
-	res := add(t.dimensions, value, 0, t.root)
+	res := insert(t.dimensions, value, 0, t.root)
 	if res {
 		t.size++
 	}
@@ -359,7 +359,7 @@ func deleteNode[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) (*kdNode[
 	return r, ok
 }
 
-func add[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) bool {
+func insert[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) bool {
 	if value.Dist(r.value) == 0 {
 		return false
 	}
@@ -370,13 +370,13 @@ func add[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) bool {
 		if r.left == nil {
 			r.left = NewKDNode(value)
 		} else {
-			return add(d, value, ncd, r.left)
+			return insert(d, value, ncd, r.left)
 		}
 	} else {
 		if r.right == nil {
 			r.right = NewKDNode(value)
 		} else {
-			return add(d, value, ncd, r.right)
+			return insert(d, value, ncd, r.right)
 		}
 	}
 	return true

tests/kdtree_2d_test.go

@@ -249,7 +249,7 @@ func Test2DNodeAddition1(t *testing.T) {
 	}
 	tree := kdtree.NewKDTreeWithValues(dimensions, ps)
 	v := types.Tensor2D{48, 38}
-	tree.Add(v)
+	tree.Insert(v)
 	testTable := []struct {
 		input, expected types.Tensor2D
 	}{
@@ -292,7 +292,7 @@ func Test2DNodeAddition2(t *testing.T) {
 		{879, 810},
 	}
 	for _, v := range ps {
-		tree.Add(v)
+		tree.Insert(v)
 	}
 	testTable := []struct {
 		input, expected types.Tensor2D