refactor!: ♻️ rename Delete API to the Remove API

I have renamed the `Delete` API to the `Remove` API. I made this change to make the APIs of my K-D Tree library consistent with those of existing ones written in Go.

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

Author: rishitc

kdtree.go

@@ -121,9 +121,9 @@ func (t *KDTree[T]) Insert(value T) {
 	}
 }
 
-func (t *KDTree[T]) Delete(value T) bool {
+func (t *KDTree[T]) Remove(value T) bool {
 	ok := false
-	t.root, ok = deleteNode(t.dimensions, value, 0, t.root)
+	t.root, ok = removeNode(t.dimensions, value, 0, t.root)
 	if ok {
 		t.size--
 	}
@@ -379,7 +379,7 @@ func insertAllNew[T Comparable[T]](vs []T, initialIndices [][]int, cd int) *kdNo
 	return n
 }
 
-func deleteNode[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) (*kdNode[T], bool) {
+func removeNode[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) (*kdNode[T], bool) {
 	if r == nil {
 		return nil, false
 	}
@@ -389,18 +389,18 @@ func deleteNode[T Comparable[T]](d int, value T, cd int, r *kdNode[T]) (*kdNode[
 		ok = true
 		if r.right != nil {
 			r.value = *findMin(d, cd, ncd, r.right)
-			r.right, ok = deleteNode(d, r.value, ncd, r.right)
+			r.right, ok = removeNode(d, r.value, ncd, r.right)
 		} else if r.left != nil {
 			r.value = *findMin(d, cd, ncd, r.left)
-			r.right, ok = deleteNode(d, r.value, ncd, r.left)
+			r.right, ok = removeNode(d, r.value, ncd, r.left)
 			r.left = nil
 		} else {
 			r = nil
 		}
 	} else if value.Order(r.value, cd) < 0 {
-		r.left, ok = deleteNode(d, value, ncd, r.left)
+		r.left, ok = removeNode(d, value, ncd, r.left)
 	} else {
-		r.right, ok = deleteNode(d, value, ncd, r.right)
+		r.right, ok = removeNode(d, value, ncd, r.right)
 	}
 	return r, ok
 }

kdtree_internal_2d_test.go

@@ -6,7 +6,7 @@ import (
 	types "github.com/rishitc/go-kd-tree/internal/types"
 )
 
-func Test2DDeleteAllNodesInTree(t *testing.T) {
+func Test2DRemoveAllNodesInTree(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{5, 6})
 	tree := NewTestKDTree(2, treeNodes)
 
@@ -20,15 +20,15 @@ func Test2DDeleteAllNodesInTree(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
 	}
 }
 
 // https://youtu.be/DkBNF98MV1Q?si=YhQLGxiH7BbG9D8s&t=37
-func Test2DDeleteLeafNode(t *testing.T) {
+func Test2DRemoveLeafNode(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{25, 50}).
 		SetLeft(
 			NewKDNode(types.Tensor2D{3, 25}),
@@ -58,15 +58,15 @@ func Test2DDeleteLeafNode(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
 	}
 }
 
 // https://youtu.be/DkBNF98MV1Q?si=-tQZZtNASyMXnhNc&t=90
-func Test2DDeleteNodeWithRightSubtree(t *testing.T) {
+func Test2DRemoveNodeWithRightSubtree(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{25, 50}).
 		SetLeft(
 			NewKDNode(types.Tensor2D{3, 25}).
@@ -108,15 +108,15 @@ func Test2DDeleteNodeWithRightSubtree(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
 	}
 }
 
 // https://youtu.be/DkBNF98MV1Q?si=v-TuZNV9YiTmCOFg&t=189
-func Test2DDeleteNodeWithLeftSubtreeOnly(t *testing.T) {
+func Test2DRemoveNodeWithLeftSubtreeOnly(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{25, 50}).
 		SetLeft(
 			NewKDNode(types.Tensor2D{3, 25}).
@@ -158,14 +158,14 @@ func Test2DDeleteNodeWithLeftSubtreeOnly(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
 	}
 }
 
-func Test2DDeleteNode1(t *testing.T) {
+func Test2DRemoveNode1(t *testing.T) {
 	const dimensions = 2
 	ps := []types.Tensor2D{
 		{5, 6},
@@ -185,13 +185,13 @@ func Test2DDeleteNode1(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
 	}
 }
-func Test2DDeleteNode2(t *testing.T) {
+func Test2DRemoveNode2(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{5, 6}).
 		SetLeft(
 			NewKDNode(types.Tensor2D{4, 10}).
@@ -215,7 +215,7 @@ func Test2DDeleteNode2(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}
@@ -227,7 +227,7 @@ func Test2DDeleteNode2(t *testing.T) {
 // child of node (70, 20), and not the right child of node (70, 20).
 // However, the resultant tree shown in the video lecture is correct and has been used in this test case.
 // The below test case, has been created using the corrected valid KD-Tree as input
-func Test2DDeleteNode3(t *testing.T) {
+func Test2DRemoveNode3(t *testing.T) {
 	treeNodes := NewKDNode(types.Tensor2D{35, 60}).
 		SetLeft(
 			NewKDNode(types.Tensor2D{20, 45}).
@@ -293,7 +293,7 @@ func Test2DDeleteNode3(t *testing.T) {
 		},
 	}
 	for _, v := range testTable {
-		ok := tree.Delete(v.input)
+		ok := tree.Remove(v.input)
 		if !ok || !IdenticalTrees(tree, v.expected) {
 			t.Fatalf("Tree does not match expected tree structure\nExpected:\n%s\nGot:\n%s", v.expected, tree)
 		}