Merge pull request #117 from Workiva/inclusive_itree

Make interval tree inclusive.

Author: dustinhiatt-wf

augmentedtree/atree.go

@@ -37,7 +37,7 @@ func intervalOverlaps(n *node, low, high int64, interval Interval, maxDimension
 }
 
 func overlaps(high, otherHigh, low, otherLow int64) bool {
-	return high > otherLow && low < otherHigh
+	return high >= otherLow && low <= otherHigh
 }
 
 // compare returns an int indicating which direction the node
@@ -298,15 +298,15 @@ func (tree *tree) delete(iv Interval) {
 // be deleted.  A 0 indicates this interval requires no action.
 func insertInterval(dimension uint64, interval Interval, index, count int64) int {
 	low, high := interval.LowAtDimension(dimension), interval.HighAtDimension(dimension)
-	if index >= high {
+	if index > high {
 		return 0
 	}
 
 	if count > 0 {
 		return 1
 	}
 
-	if index <= low && count*-1 >= high-index {
+	if index <= low && low-index+high+count < low {
 		return -1
 	}
 
@@ -342,34 +342,38 @@ func (tree *tree) Insert(dimension uint64,
 			return
 		}
 
-		if n.max <= index { // won't change min or max in this case
+		if n.max < index { // won't change min or max in this case
 			return
 		}
 
+		needsDeletion := false
+
+		if n.low >= index && n.low-index+n.high+count < n.low {
+			needsDeletion = true
+		}
+
 		n.max += count
 		if n.min >= index {
 			n.min += count
 		}
 
-		mod := false
-		if n.high > index {
-			n.high += count
-			if n.high < index {
-				n.high = index
-			}
-			mod = true
-		}
 		if n.low > index {
 			n.low += count
 			if n.low < index {
 				n.low = index
 			}
-			mod = true
 		}
 
-		if n.low >= n.high {
+		if n.high > index {
+			n.high += count
+			if n.high < index {
+				n.high = index
+			}
+		}
+
+		if needsDeletion {
 			deleted = append(deleted, n.interval)
-		} else if mod {
+		} else {
 			modified = append(modified, n.interval)
 		}
 	})

augmentedtree/atree_test.go

@@ -305,7 +305,7 @@ func constructSingleDimensionQueryTestTree() (
 
 	it := newTree(1)
 
-	iv1 := constructSingleDimensionInterval(5, 10, 0)
+	iv1 := constructSingleDimensionInterval(6, 10, 0)
 	it.Add(iv1)
 
 	iv2 := constructSingleDimensionInterval(4, 5, 1)
@@ -329,7 +329,7 @@ func TestSimpleQuery(t *testing.T) {
 func TestRightQuery(t *testing.T) {
 	it, iv1, _, iv3 := constructSingleDimensionQueryTestTree()
 
-	result := it.Query(constructSingleDimensionInterval(5, 8, 0))
+	result := it.Query(constructSingleDimensionInterval(6, 8, 0))
 
 	expected := Intervals{iv1, iv3}
 	assert.Equal(t, expected, result)
@@ -356,7 +356,7 @@ func TestMatchingQuery(t *testing.T) {
 func TestNoMatchLeft(t *testing.T) {
 	it, _, _, _ := constructSingleDimensionQueryTestTree()
 
-	result := it.Query(constructSingleDimensionInterval(1, 4, 0))
+	result := it.Query(constructSingleDimensionInterval(1, 3, 0))
 
 	expected := Intervals{}
 	assert.Equal(t, expected, result)
@@ -365,7 +365,7 @@ func TestNoMatchLeft(t *testing.T) {
 func TestNoMatchRight(t *testing.T) {
 	it, _, _, _ := constructSingleDimensionQueryTestTree()
 
-	result := it.Query(constructSingleDimensionInterval(12, 13, 0))
+	result := it.Query(constructSingleDimensionInterval(13, 13, 0))
 
 	expected := Intervals{}
 	assert.Equal(t, expected, result)
@@ -601,11 +601,11 @@ func TestAddDeleteDuplicatesRebalanceRandomOrder(t *testing.T) {
 func TestInsertSingleAtDimension(t *testing.T) {
 	tree, ivs := constructSingleDimensionTestTree(3)
 
-	modified, deleted := tree.Insert(1, 10, 1)
+	modified, deleted := tree.Insert(1, 11, 1)
 	assert.Len(t, deleted, 0)
 	assert.Equal(t, ivs[1:], modified)
 
-	result := tree.Query(constructSingleDimensionInterval(10, 20, 0))
+	result := tree.Query(constructSingleDimensionInterval(11, 20, 0))
 	assert.Equal(t, ivs[1:], result)
 	checkRedBlack(t, tree.root, 1)
 
@@ -616,7 +616,7 @@ func TestInsertSingleAtDimension(t *testing.T) {
 func TestInsertMultipleAtDimension(t *testing.T) {
 	tree, ivs := constructSingleDimensionTestTree(3)
 
-	modified, deleted := tree.Insert(1, 10, 2)
+	modified, deleted := tree.Insert(1, 11, 2)
 	assert.Len(t, deleted, 0)
 	assert.Equal(t, ivs[1:], modified)
 
@@ -635,7 +635,7 @@ func TestInsertAtLowestIndex(t *testing.T) {
 	assert.Equal(t, ivs[0:], modified)
 	assert.Len(t, deleted, 0)
 
-	result := tree.Query(constructSingleDimensionInterval(0, 1, 0))
+	result := tree.Query(constructSingleDimensionInterval(0, 0, 0))
 	assert.Len(t, result, 0)
 
 	result = tree.Query(constructSingleDimensionInterval(1, 4, 0))
@@ -650,12 +650,12 @@ func TestInsertAtLowestIndex(t *testing.T) {
 func TestDeleteSingleAtDimension(t *testing.T) {
 	tree, ivs := constructSingleDimensionTestTree(3)
 
-	modified, deleted := tree.Insert(1, 10, -1)
+	modified, deleted := tree.Insert(1, 11, -1)
 	assert.Equal(t, ivs[1:], modified)
 	assert.Len(t, deleted, 0)
 
-	result := tree.Query(constructSingleDimensionInterval(10, 20, 0))
-	assert.Equal(t, ivs[2:], result)
+	result := tree.Query(constructSingleDimensionInterval(11, 20, 0))
+	assert.Equal(t, ivs[1:], result)
 
 	result = tree.Query(constructSingleDimensionInterval(9, 20, 0))
 	assert.Equal(t, ivs, result)
@@ -681,7 +681,7 @@ func TestDeleteBelowLowestIndex(t *testing.T) {
 	assert.Equal(t, ivs, modified)
 	assert.Len(t, deleted, 0)
 
-	result := tree.Query(constructSingleDimensionInterval(0, 1, 0))
+	result := tree.Query(constructSingleDimensionInterval(0, 0, 0))
 	assert.Equal(t, ivs[:1], result)
 
 	result = tree.Query(constructSingleDimensionInterval(0, 10, 0))
@@ -695,11 +695,11 @@ func TestDeleteBelowLowestIndex(t *testing.T) {
 func TestInsertDeletesInterval(t *testing.T) {
 	tree, ivs := constructSingleDimensionTestTree(3)
 
-	modified, deleted := tree.Insert(1, 0, -10)
+	modified, deleted := tree.Insert(1, 0, -11)
 	assert.Equal(t, ivs[1:], modified)
 	assert.Equal(t, ivs[:1], deleted)
 
-	result := tree.Query(constructSingleDimensionInterval(2, 10, 0))
+	result := tree.Query(constructSingleDimensionInterval(3, 10, 0))
 	assert.Len(t, result, 0)
 
 	result = tree.Query(constructSingleDimensionInterval(0, 2, 0))
@@ -708,7 +708,7 @@ func TestInsertDeletesInterval(t *testing.T) {
 	checkRedBlack(t, tree.root, 1)
 	assert.Equal(t, uint64(2), tree.Len())
 	assert.Equal(t, int64(0), tree.root.min)
-	assert.Equal(t, int64(2), tree.root.max)
+	assert.Equal(t, int64(1), tree.root.max)
 }
 
 func TestDeleteMiddleOfRange(t *testing.T) {

augmentedtree/interface.go

@@ -32,7 +32,10 @@ range handling.
 package augmentedtree
 
 // Interval is the interface that must be implemented by any
-// item added to the interval tree.
+// item added to the interval tree.  This interface is similar to the
+// interval found in the rangetree package and it should be possible
+// for the same struct to implement both interfaces.  Note that ranges
+// here are inclusive.
 type Interval interface {
 	// LowAtDimension returns an integer representing the lower bound
 	// at the requested dimension.

augmentedtree/multidimensional_test.go

@@ -130,6 +130,21 @@ func TestAddRebalanceInOrderMultiDimensions(t *testing.T) {
 	assert.Equal(t, uint64(10), it.Len())
 }
 
+func TestInsertAtMax(t *testing.T) {
+	it := newTree(2)
+	iv := constructMultiDimensionInterval(0, &dimension{0, 0}, &dimension{0, 0})
+
+	it.Add(iv)
+
+	modified, deleted := it.Insert(1, 0, 1)
+	assert.Empty(t, deleted)
+	assert.Len(t, modified, 1)
+
+	modified, deleted = it.Insert(2, 0, 1)
+	assert.Empty(t, deleted)
+	assert.Len(t, modified, 1)
+}
+
 func TestAddRebalanceReverseOrderMultiDimensions(t *testing.T) {
 	it := newTree(2)
 
@@ -482,7 +497,7 @@ func TestInsertPositiveMultipleDimensions(t *testing.T) {
 func TestInsertNegativeMultipleDimensions(t *testing.T) {
 	it, iv1, iv2, iv3 := constructMultiDimensionQueryTestTree()
 
-	modified, deleted := it.Insert(2, 4, -1)
+	modified, deleted := it.Insert(2, 4, -2)
 	assert.Equal(t, Intervals{iv1, iv3}, modified)
 	assert.Equal(t, Intervals{iv2}, deleted)