From 4ac6739500ae981e5ac3bdbc96715645a30d6290 Mon Sep 17 00:00:00 2001 From: Sharath P J Date: Tue, 6 Jan 2026 13:12:08 +0530 Subject: [PATCH 1/2] third_party/forked/btree: add upstream google/btree code --- third_party/forked/golang/btree/LICENSE | 202 +++ third_party/forked/golang/btree/README.md | 10 + .../forked/golang/btree/btree_generic.go | 1083 +++++++++++++++++ .../forked/golang/btree/btree_generic_test.go | 764 ++++++++++++ 4 files changed, 2059 insertions(+) create mode 100644 third_party/forked/golang/btree/LICENSE create mode 100644 third_party/forked/golang/btree/README.md create mode 100644 third_party/forked/golang/btree/btree_generic.go create mode 100644 third_party/forked/golang/btree/btree_generic_test.go diff --git a/third_party/forked/golang/btree/LICENSE b/third_party/forked/golang/btree/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/third_party/forked/golang/btree/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/third_party/forked/golang/btree/README.md b/third_party/forked/golang/btree/README.md new file mode 100644 index 00000000..eab5dbf7 --- /dev/null +++ b/third_party/forked/golang/btree/README.md @@ -0,0 +1,10 @@ +# BTree implementation for Go + +This package provides an in-memory B-Tree implementation for Go, useful as +an ordered, mutable data structure. + +The API is based off of the wonderful +http://godoc.org/github.com/petar/GoLLRB/llrb, and is meant to allow btree to +act as a drop-in replacement for gollrb trees. + +See http://godoc.org/github.com/google/btree for documentation. diff --git a/third_party/forked/golang/btree/btree_generic.go b/third_party/forked/golang/btree/btree_generic.go new file mode 100644 index 00000000..e44a0f48 --- /dev/null +++ b/third_party/forked/golang/btree/btree_generic.go @@ -0,0 +1,1083 @@ +// Copyright 2014-2022 Google Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +//go:build go1.18 +// +build go1.18 + +// In Go 1.18 and beyond, a BTreeG generic is created, and BTree is a specific +// instantiation of that generic for the Item interface, with a backwards- +// compatible API. Before go1.18, generics are not supported, +// and BTree is just an implementation based around the Item interface. + +// Package btree implements in-memory B-Trees of arbitrary degree. +// +// btree implements an in-memory B-Tree for use as an ordered data structure. +// It is not meant for persistent storage solutions. +// +// It has a flatter structure than an equivalent red-black or other binary tree, +// which in some cases yields better memory usage and/or performance. +// See some discussion on the matter here: +// http://google-opensource.blogspot.com/2013/01/c-containers-that-save-memory-and-time.html +// Note, though, that this project is in no way related to the C++ B-Tree +// implementation written about there. +// +// Within this tree, each node contains a slice of items and a (possibly nil) +// slice of children. For basic numeric values or raw structs, this can cause +// efficiency differences when compared to equivalent C++ template code that +// stores values in arrays within the node: +// * Due to the overhead of storing values as interfaces (each +// value needs to be stored as the value itself, then 2 words for the +// interface pointing to that value and its type), resulting in higher +// memory use. +// * Since interfaces can point to values anywhere in memory, values are +// most likely not stored in contiguous blocks, resulting in a higher +// number of cache misses. +// These issues don't tend to matter, though, when working with strings or other +// heap-allocated structures, since C++-equivalent structures also must store +// pointers and also distribute their values across the heap. +// +// This implementation is designed to be a drop-in replacement to gollrb.LLRB +// trees, (http://github.com/petar/gollrb), an excellent and probably the most +// widely used ordered tree implementation in the Go ecosystem currently. +// Its functions, therefore, exactly mirror those of +// llrb.LLRB where possible. Unlike gollrb, though, we currently don't +// support storing multiple equivalent values. +// +// There are two implementations; those suffixed with 'G' are generics, usable +// for any type, and require a passed-in "less" function to define their ordering. +// Those without this prefix are specific to the 'Item' interface, and use +// its 'Less' function for ordering. +package btree + +import ( + "fmt" + "io" + "sort" + "strings" + "sync" +) + +// Item represents a single object in the tree. +type Item interface { + // Less tests whether the current item is less than the given argument. + // + // This must provide a strict weak ordering. + // If !a.Less(b) && !b.Less(a), we treat this to mean a == b (i.e. we can only + // hold one of either a or b in the tree). + Less(than Item) bool +} + +const ( + DefaultFreeListSize = 32 +) + +// FreeListG represents a free list of btree nodes. By default each +// BTree has its own FreeList, but multiple BTrees can share the same +// FreeList, in particular when they're created with Clone. +// Two Btrees using the same freelist are safe for concurrent write access. +type FreeListG[T any] struct { + mu sync.Mutex + freelist []*node[T] +} + +// NewFreeListG creates a new free list. +// size is the maximum size of the returned free list. +func NewFreeListG[T any](size int) *FreeListG[T] { + return &FreeListG[T]{freelist: make([]*node[T], 0, size)} +} + +func (f *FreeListG[T]) newNode() (n *node[T]) { + f.mu.Lock() + index := len(f.freelist) - 1 + if index < 0 { + f.mu.Unlock() + return new(node[T]) + } + n = f.freelist[index] + f.freelist[index] = nil + f.freelist = f.freelist[:index] + f.mu.Unlock() + return +} + +func (f *FreeListG[T]) freeNode(n *node[T]) (out bool) { + f.mu.Lock() + if len(f.freelist) < cap(f.freelist) { + f.freelist = append(f.freelist, n) + out = true + } + f.mu.Unlock() + return +} + +// ItemIteratorG allows callers of {A/De}scend* to iterate in-order over portions of +// the tree. When this function returns false, iteration will stop and the +// associated Ascend* function will immediately return. +type ItemIteratorG[T any] func(item T) bool + +// Ordered represents the set of types for which the '<' operator work. +type Ordered interface { + ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~float32 | ~float64 | ~string +} + +// Less[T] returns a default LessFunc that uses the '<' operator for types that support it. +func Less[T Ordered]() LessFunc[T] { + return func(a, b T) bool { return a < b } +} + +// NewOrderedG creates a new B-Tree for ordered types. +func NewOrderedG[T Ordered](degree int) *BTreeG[T] { + return NewG[T](degree, Less[T]()) +} + +// NewG creates a new B-Tree with the given degree. +// +// NewG(2), for example, will create a 2-3-4 tree (each node contains 1-3 items +// and 2-4 children). +// +// The passed-in LessFunc determines how objects of type T are ordered. +func NewG[T any](degree int, less LessFunc[T]) *BTreeG[T] { + return NewWithFreeListG(degree, less, NewFreeListG[T](DefaultFreeListSize)) +} + +// NewWithFreeListG creates a new B-Tree that uses the given node free list. +func NewWithFreeListG[T any](degree int, less LessFunc[T], f *FreeListG[T]) *BTreeG[T] { + if degree <= 1 { + panic("bad degree") + } + return &BTreeG[T]{ + degree: degree, + cow: ©OnWriteContext[T]{freelist: f, less: less}, + } +} + +// items stores items in a node. +type items[T any] []T + +// insertAt inserts a value into the given index, pushing all subsequent values +// forward. +func (s *items[T]) insertAt(index int, item T) { + var zero T + *s = append(*s, zero) + if index < len(*s) { + copy((*s)[index+1:], (*s)[index:]) + } + (*s)[index] = item +} + +// removeAt removes a value at a given index, pulling all subsequent values +// back. +func (s *items[T]) removeAt(index int) T { + item := (*s)[index] + copy((*s)[index:], (*s)[index+1:]) + var zero T + (*s)[len(*s)-1] = zero + *s = (*s)[:len(*s)-1] + return item +} + +// pop removes and returns the last element in the list. +func (s *items[T]) pop() (out T) { + index := len(*s) - 1 + out = (*s)[index] + var zero T + (*s)[index] = zero + *s = (*s)[:index] + return +} + +// truncate truncates this instance at index so that it contains only the +// first index items. index must be less than or equal to length. +func (s *items[T]) truncate(index int) { + var toClear items[T] + *s, toClear = (*s)[:index], (*s)[index:] + var zero T + for i := 0; i < len(toClear); i++ { + toClear[i] = zero + } +} + +// find returns the index where the given item should be inserted into this +// list. 'found' is true if the item already exists in the list at the given +// index. +func (s items[T]) find(item T, less func(T, T) bool) (index int, found bool) { + i := sort.Search(len(s), func(i int) bool { + return less(item, s[i]) + }) + if i > 0 && !less(s[i-1], item) { + return i - 1, true + } + return i, false +} + +// node is an internal node in a tree. +// +// It must at all times maintain the invariant that either +// * len(children) == 0, len(items) unconstrained +// * len(children) == len(items) + 1 +type node[T any] struct { + items items[T] + children items[*node[T]] + cow *copyOnWriteContext[T] +} + +func (n *node[T]) mutableFor(cow *copyOnWriteContext[T]) *node[T] { + if n.cow == cow { + return n + } + out := cow.newNode() + if cap(out.items) >= len(n.items) { + out.items = out.items[:len(n.items)] + } else { + out.items = make(items[T], len(n.items), cap(n.items)) + } + copy(out.items, n.items) + // Copy children + if cap(out.children) >= len(n.children) { + out.children = out.children[:len(n.children)] + } else { + out.children = make(items[*node[T]], len(n.children), cap(n.children)) + } + copy(out.children, n.children) + return out +} + +func (n *node[T]) mutableChild(i int) *node[T] { + c := n.children[i].mutableFor(n.cow) + n.children[i] = c + return c +} + +// split splits the given node at the given index. The current node shrinks, +// and this function returns the item that existed at that index and a new node +// containing all items/children after it. +func (n *node[T]) split(i int) (T, *node[T]) { + item := n.items[i] + next := n.cow.newNode() + next.items = append(next.items, n.items[i+1:]...) + n.items.truncate(i) + if len(n.children) > 0 { + next.children = append(next.children, n.children[i+1:]...) + n.children.truncate(i + 1) + } + return item, next +} + +// maybeSplitChild checks if a child should be split, and if so splits it. +// Returns whether or not a split occurred. +func (n *node[T]) maybeSplitChild(i, maxItems int) bool { + if len(n.children[i].items) < maxItems { + return false + } + first := n.mutableChild(i) + item, second := first.split(maxItems / 2) + n.items.insertAt(i, item) + n.children.insertAt(i+1, second) + return true +} + +// insert inserts an item into the subtree rooted at this node, making sure +// no nodes in the subtree exceed maxItems items. Should an equivalent item be +// be found/replaced by insert, it will be returned. +func (n *node[T]) insert(item T, maxItems int) (_ T, _ bool) { + i, found := n.items.find(item, n.cow.less) + if found { + out := n.items[i] + n.items[i] = item + return out, true + } + if len(n.children) == 0 { + n.items.insertAt(i, item) + return + } + if n.maybeSplitChild(i, maxItems) { + inTree := n.items[i] + switch { + case n.cow.less(item, inTree): + // no change, we want first split node + case n.cow.less(inTree, item): + i++ // we want second split node + default: + out := n.items[i] + n.items[i] = item + return out, true + } + } + return n.mutableChild(i).insert(item, maxItems) +} + +// get finds the given key in the subtree and returns it. +func (n *node[T]) get(key T) (_ T, _ bool) { + i, found := n.items.find(key, n.cow.less) + if found { + return n.items[i], true + } else if len(n.children) > 0 { + return n.children[i].get(key) + } + return +} + +// min returns the first item in the subtree. +func min[T any](n *node[T]) (_ T, found bool) { + if n == nil { + return + } + for len(n.children) > 0 { + n = n.children[0] + } + if len(n.items) == 0 { + return + } + return n.items[0], true +} + +// max returns the last item in the subtree. +func max[T any](n *node[T]) (_ T, found bool) { + if n == nil { + return + } + for len(n.children) > 0 { + n = n.children[len(n.children)-1] + } + if len(n.items) == 0 { + return + } + return n.items[len(n.items)-1], true +} + +// toRemove details what item to remove in a node.remove call. +type toRemove int + +const ( + removeItem toRemove = iota // removes the given item + removeMin // removes smallest item in the subtree + removeMax // removes largest item in the subtree +) + +// remove removes an item from the subtree rooted at this node. +func (n *node[T]) remove(item T, minItems int, typ toRemove) (_ T, _ bool) { + var i int + var found bool + switch typ { + case removeMax: + if len(n.children) == 0 { + return n.items.pop(), true + } + i = len(n.items) + case removeMin: + if len(n.children) == 0 { + return n.items.removeAt(0), true + } + i = 0 + case removeItem: + i, found = n.items.find(item, n.cow.less) + if len(n.children) == 0 { + if found { + return n.items.removeAt(i), true + } + return + } + default: + panic("invalid type") + } + // If we get to here, we have children. + if len(n.children[i].items) <= minItems { + return n.growChildAndRemove(i, item, minItems, typ) + } + child := n.mutableChild(i) + // Either we had enough items to begin with, or we've done some + // merging/stealing, because we've got enough now and we're ready to return + // stuff. + if found { + // The item exists at index 'i', and the child we've selected can give us a + // predecessor, since if we've gotten here it's got > minItems items in it. + out := n.items[i] + // We use our special-case 'remove' call with typ=maxItem to pull the + // predecessor of item i (the rightmost leaf of our immediate left child) + // and set it into where we pulled the item from. + var zero T + n.items[i], _ = child.remove(zero, minItems, removeMax) + return out, true + } + // Final recursive call. Once we're here, we know that the item isn't in this + // node and that the child is big enough to remove from. + return child.remove(item, minItems, typ) +} + +// growChildAndRemove grows child 'i' to make sure it's possible to remove an +// item from it while keeping it at minItems, then calls remove to actually +// remove it. +// +// Most documentation says we have to do two sets of special casing: +// 1) item is in this node +// 2) item is in child +// In both cases, we need to handle the two subcases: +// A) node has enough values that it can spare one +// B) node doesn't have enough values +// For the latter, we have to check: +// a) left sibling has node to spare +// b) right sibling has node to spare +// c) we must merge +// To simplify our code here, we handle cases #1 and #2 the same: +// If a node doesn't have enough items, we make sure it does (using a,b,c). +// We then simply redo our remove call, and the second time (regardless of +// whether we're in case 1 or 2), we'll have enough items and can guarantee +// that we hit case A. +func (n *node[T]) growChildAndRemove(i int, item T, minItems int, typ toRemove) (T, bool) { + if i > 0 && len(n.children[i-1].items) > minItems { + // Steal from left child + child := n.mutableChild(i) + stealFrom := n.mutableChild(i - 1) + stolenItem := stealFrom.items.pop() + child.items.insertAt(0, n.items[i-1]) + n.items[i-1] = stolenItem + if len(stealFrom.children) > 0 { + child.children.insertAt(0, stealFrom.children.pop()) + } + } else if i < len(n.items) && len(n.children[i+1].items) > minItems { + // steal from right child + child := n.mutableChild(i) + stealFrom := n.mutableChild(i + 1) + stolenItem := stealFrom.items.removeAt(0) + child.items = append(child.items, n.items[i]) + n.items[i] = stolenItem + if len(stealFrom.children) > 0 { + child.children = append(child.children, stealFrom.children.removeAt(0)) + } + } else { + if i >= len(n.items) { + i-- + } + child := n.mutableChild(i) + // merge with right child + mergeItem := n.items.removeAt(i) + mergeChild := n.children.removeAt(i + 1) + child.items = append(child.items, mergeItem) + child.items = append(child.items, mergeChild.items...) + child.children = append(child.children, mergeChild.children...) + n.cow.freeNode(mergeChild) + } + return n.remove(item, minItems, typ) +} + +type direction int + +const ( + descend = direction(-1) + ascend = direction(+1) +) + +type optionalItem[T any] struct { + item T + valid bool +} + +func optional[T any](item T) optionalItem[T] { + return optionalItem[T]{item: item, valid: true} +} +func empty[T any]() optionalItem[T] { + return optionalItem[T]{} +} + +// iterate provides a simple method for iterating over elements in the tree. +// +// When ascending, the 'start' should be less than 'stop' and when descending, +// the 'start' should be greater than 'stop'. Setting 'includeStart' to true +// will force the iterator to include the first item when it equals 'start', +// thus creating a "greaterOrEqual" or "lessThanEqual" rather than just a +// "greaterThan" or "lessThan" queries. +func (n *node[T]) iterate(dir direction, start, stop optionalItem[T], includeStart bool, hit bool, iter ItemIteratorG[T]) (bool, bool) { + var ok, found bool + var index int + switch dir { + case ascend: + if start.valid { + index, _ = n.items.find(start.item, n.cow.less) + } + for i := index; i < len(n.items); i++ { + if len(n.children) > 0 { + if hit, ok = n.children[i].iterate(dir, start, stop, includeStart, hit, iter); !ok { + return hit, false + } + } + if !includeStart && !hit && start.valid && !n.cow.less(start.item, n.items[i]) { + hit = true + continue + } + hit = true + if stop.valid && !n.cow.less(n.items[i], stop.item) { + return hit, false + } + if !iter(n.items[i]) { + return hit, false + } + } + if len(n.children) > 0 { + if hit, ok = n.children[len(n.children)-1].iterate(dir, start, stop, includeStart, hit, iter); !ok { + return hit, false + } + } + case descend: + if start.valid { + index, found = n.items.find(start.item, n.cow.less) + if !found { + index = index - 1 + } + } else { + index = len(n.items) - 1 + } + for i := index; i >= 0; i-- { + if start.valid && !n.cow.less(n.items[i], start.item) { + if !includeStart || hit || n.cow.less(start.item, n.items[i]) { + continue + } + } + if len(n.children) > 0 { + if hit, ok = n.children[i+1].iterate(dir, start, stop, includeStart, hit, iter); !ok { + return hit, false + } + } + if stop.valid && !n.cow.less(stop.item, n.items[i]) { + return hit, false // continue + } + hit = true + if !iter(n.items[i]) { + return hit, false + } + } + if len(n.children) > 0 { + if hit, ok = n.children[0].iterate(dir, start, stop, includeStart, hit, iter); !ok { + return hit, false + } + } + } + return hit, true +} + +// print is used for testing/debugging purposes. +func (n *node[T]) print(w io.Writer, level int) { + fmt.Fprintf(w, "%sNODE:%v\n", strings.Repeat(" ", level), n.items) + for _, c := range n.children { + c.print(w, level+1) + } +} + +// BTreeG is a generic implementation of a B-Tree. +// +// BTreeG stores items of type T in an ordered structure, allowing easy insertion, +// removal, and iteration. +// +// Write operations are not safe for concurrent mutation by multiple +// goroutines, but Read operations are. +type BTreeG[T any] struct { + degree int + length int + root *node[T] + cow *copyOnWriteContext[T] +} + +// LessFunc[T] determines how to order a type 'T'. It should implement a strict +// ordering, and should return true if within that ordering, 'a' < 'b'. +type LessFunc[T any] func(a, b T) bool + +// copyOnWriteContext pointers determine node ownership... a tree with a write +// context equivalent to a node's write context is allowed to modify that node. +// A tree whose write context does not match a node's is not allowed to modify +// it, and must create a new, writable copy (IE: it's a Clone). +// +// When doing any write operation, we maintain the invariant that the current +// node's context is equal to the context of the tree that requested the write. +// We do this by, before we descend into any node, creating a copy with the +// correct context if the contexts don't match. +// +// Since the node we're currently visiting on any write has the requesting +// tree's context, that node is modifiable in place. Children of that node may +// not share context, but before we descend into them, we'll make a mutable +// copy. +type copyOnWriteContext[T any] struct { + freelist *FreeListG[T] + less LessFunc[T] +} + +// Clone clones the btree, lazily. Clone should not be called concurrently, +// but the original tree (t) and the new tree (t2) can be used concurrently +// once the Clone call completes. +// +// The internal tree structure of b is marked read-only and shared between t and +// t2. Writes to both t and t2 use copy-on-write logic, creating new nodes +// whenever one of b's original nodes would have been modified. Read operations +// should have no performance degredation. Write operations for both t and t2 +// will initially experience minor slow-downs caused by additional allocs and +// copies due to the aforementioned copy-on-write logic, but should converge to +// the original performance characteristics of the original tree. +func (t *BTreeG[T]) Clone() (t2 *BTreeG[T]) { + // Create two entirely new copy-on-write contexts. + // This operation effectively creates three trees: + // the original, shared nodes (old b.cow) + // the new b.cow nodes + // the new out.cow nodes + cow1, cow2 := *t.cow, *t.cow + out := *t + t.cow = &cow1 + out.cow = &cow2 + return &out +} + +// maxItems returns the max number of items to allow per node. +func (t *BTreeG[T]) maxItems() int { + return t.degree*2 - 1 +} + +// minItems returns the min number of items to allow per node (ignored for the +// root node). +func (t *BTreeG[T]) minItems() int { + return t.degree - 1 +} + +func (c *copyOnWriteContext[T]) newNode() (n *node[T]) { + n = c.freelist.newNode() + n.cow = c + return +} + +type freeType int + +const ( + ftFreelistFull freeType = iota // node was freed (available for GC, not stored in freelist) + ftStored // node was stored in the freelist for later use + ftNotOwned // node was ignored by COW, since it's owned by another one +) + +// freeNode frees a node within a given COW context, if it's owned by that +// context. It returns what happened to the node (see freeType const +// documentation). +func (c *copyOnWriteContext[T]) freeNode(n *node[T]) freeType { + if n.cow == c { + // clear to allow GC + n.items.truncate(0) + n.children.truncate(0) + n.cow = nil + if c.freelist.freeNode(n) { + return ftStored + } else { + return ftFreelistFull + } + } else { + return ftNotOwned + } +} + +// ReplaceOrInsert adds the given item to the tree. If an item in the tree +// already equals the given one, it is removed from the tree and returned, +// and the second return value is true. Otherwise, (zeroValue, false) +// +// nil cannot be added to the tree (will panic). +func (t *BTreeG[T]) ReplaceOrInsert(item T) (_ T, _ bool) { + if t.root == nil { + t.root = t.cow.newNode() + t.root.items = append(t.root.items, item) + t.length++ + return + } else { + t.root = t.root.mutableFor(t.cow) + if len(t.root.items) >= t.maxItems() { + item2, second := t.root.split(t.maxItems() / 2) + oldroot := t.root + t.root = t.cow.newNode() + t.root.items = append(t.root.items, item2) + t.root.children = append(t.root.children, oldroot, second) + } + } + out, outb := t.root.insert(item, t.maxItems()) + if !outb { + t.length++ + } + return out, outb +} + +// Delete removes an item equal to the passed in item from the tree, returning +// it. If no such item exists, returns (zeroValue, false). +func (t *BTreeG[T]) Delete(item T) (T, bool) { + return t.deleteItem(item, removeItem) +} + +// DeleteMin removes the smallest item in the tree and returns it. +// If no such item exists, returns (zeroValue, false). +func (t *BTreeG[T]) DeleteMin() (T, bool) { + var zero T + return t.deleteItem(zero, removeMin) +} + +// DeleteMax removes the largest item in the tree and returns it. +// If no such item exists, returns (zeroValue, false). +func (t *BTreeG[T]) DeleteMax() (T, bool) { + var zero T + return t.deleteItem(zero, removeMax) +} + +func (t *BTreeG[T]) deleteItem(item T, typ toRemove) (_ T, _ bool) { + if t.root == nil || len(t.root.items) == 0 { + return + } + t.root = t.root.mutableFor(t.cow) + out, outb := t.root.remove(item, t.minItems(), typ) + if len(t.root.items) == 0 && len(t.root.children) > 0 { + oldroot := t.root + t.root = t.root.children[0] + t.cow.freeNode(oldroot) + } + if outb { + t.length-- + } + return out, outb +} + +// AscendRange calls the iterator for every value in the tree within the range +// [greaterOrEqual, lessThan), until iterator returns false. +func (t *BTreeG[T]) AscendRange(greaterOrEqual, lessThan T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(ascend, optional[T](greaterOrEqual), optional[T](lessThan), true, false, iterator) +} + +// AscendLessThan calls the iterator for every value in the tree within the range +// [first, pivot), until iterator returns false. +func (t *BTreeG[T]) AscendLessThan(pivot T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(ascend, empty[T](), optional(pivot), false, false, iterator) +} + +// AscendGreaterOrEqual calls the iterator for every value in the tree within +// the range [pivot, last], until iterator returns false. +func (t *BTreeG[T]) AscendGreaterOrEqual(pivot T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(ascend, optional[T](pivot), empty[T](), true, false, iterator) +} + +// Ascend calls the iterator for every value in the tree within the range +// [first, last], until iterator returns false. +func (t *BTreeG[T]) Ascend(iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(ascend, empty[T](), empty[T](), false, false, iterator) +} + +// DescendRange calls the iterator for every value in the tree within the range +// [lessOrEqual, greaterThan), until iterator returns false. +func (t *BTreeG[T]) DescendRange(lessOrEqual, greaterThan T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(descend, optional[T](lessOrEqual), optional[T](greaterThan), true, false, iterator) +} + +// DescendLessOrEqual calls the iterator for every value in the tree within the range +// [pivot, first], until iterator returns false. +func (t *BTreeG[T]) DescendLessOrEqual(pivot T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(descend, optional[T](pivot), empty[T](), true, false, iterator) +} + +// DescendGreaterThan calls the iterator for every value in the tree within +// the range [last, pivot), until iterator returns false. +func (t *BTreeG[T]) DescendGreaterThan(pivot T, iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(descend, empty[T](), optional[T](pivot), false, false, iterator) +} + +// Descend calls the iterator for every value in the tree within the range +// [last, first], until iterator returns false. +func (t *BTreeG[T]) Descend(iterator ItemIteratorG[T]) { + if t.root == nil { + return + } + t.root.iterate(descend, empty[T](), empty[T](), false, false, iterator) +} + +// Get looks for the key item in the tree, returning it. It returns +// (zeroValue, false) if unable to find that item. +func (t *BTreeG[T]) Get(key T) (_ T, _ bool) { + if t.root == nil { + return + } + return t.root.get(key) +} + +// Min returns the smallest item in the tree, or (zeroValue, false) if the tree is empty. +func (t *BTreeG[T]) Min() (_ T, _ bool) { + return min(t.root) +} + +// Max returns the largest item in the tree, or (zeroValue, false) if the tree is empty. +func (t *BTreeG[T]) Max() (_ T, _ bool) { + return max(t.root) +} + +// Has returns true if the given key is in the tree. +func (t *BTreeG[T]) Has(key T) bool { + _, ok := t.Get(key) + return ok +} + +// Len returns the number of items currently in the tree. +func (t *BTreeG[T]) Len() int { + return t.length +} + +// Clear removes all items from the btree. If addNodesToFreelist is true, +// t's nodes are added to its freelist as part of this call, until the freelist +// is full. Otherwise, the root node is simply dereferenced and the subtree +// left to Go's normal GC processes. +// +// This can be much faster +// than calling Delete on all elements, because that requires finding/removing +// each element in the tree and updating the tree accordingly. It also is +// somewhat faster than creating a new tree to replace the old one, because +// nodes from the old tree are reclaimed into the freelist for use by the new +// one, instead of being lost to the garbage collector. +// +// This call takes: +// O(1): when addNodesToFreelist is false, this is a single operation. +// O(1): when the freelist is already full, it breaks out immediately +// O(freelist size): when the freelist is empty and the nodes are all owned +// by this tree, nodes are added to the freelist until full. +// O(tree size): when all nodes are owned by another tree, all nodes are +// iterated over looking for nodes to add to the freelist, and due to +// ownership, none are. +func (t *BTreeG[T]) Clear(addNodesToFreelist bool) { + if t.root != nil && addNodesToFreelist { + t.root.reset(t.cow) + } + t.root, t.length = nil, 0 +} + +// reset returns a subtree to the freelist. It breaks out immediately if the +// freelist is full, since the only benefit of iterating is to fill that +// freelist up. Returns true if parent reset call should continue. +func (n *node[T]) reset(c *copyOnWriteContext[T]) bool { + for _, child := range n.children { + if !child.reset(c) { + return false + } + } + return c.freeNode(n) != ftFreelistFull +} + +// Int implements the Item interface for integers. +type Int int + +// Less returns true if int(a) < int(b). +func (a Int) Less(b Item) bool { + return a < b.(Int) +} + +// BTree is an implementation of a B-Tree. +// +// BTree stores Item instances in an ordered structure, allowing easy insertion, +// removal, and iteration. +// +// Write operations are not safe for concurrent mutation by multiple +// goroutines, but Read operations are. +type BTree BTreeG[Item] + +var itemLess LessFunc[Item] = func(a, b Item) bool { + return a.Less(b) +} + +// New creates a new B-Tree with the given degree. +// +// New(2), for example, will create a 2-3-4 tree (each node contains 1-3 items +// and 2-4 children). +func New(degree int) *BTree { + return (*BTree)(NewG[Item](degree, itemLess)) +} + +// FreeList represents a free list of btree nodes. By default each +// BTree has its own FreeList, but multiple BTrees can share the same +// FreeList. +// Two Btrees using the same freelist are safe for concurrent write access. +type FreeList FreeListG[Item] + +// NewFreeList creates a new free list. +// size is the maximum size of the returned free list. +func NewFreeList(size int) *FreeList { + return (*FreeList)(NewFreeListG[Item](size)) +} + +// NewWithFreeList creates a new B-Tree that uses the given node free list. +func NewWithFreeList(degree int, f *FreeList) *BTree { + return (*BTree)(NewWithFreeListG[Item](degree, itemLess, (*FreeListG[Item])(f))) +} + +// ItemIterator allows callers of Ascend* to iterate in-order over portions of +// the tree. When this function returns false, iteration will stop and the +// associated Ascend* function will immediately return. +type ItemIterator ItemIteratorG[Item] + +// Clone clones the btree, lazily. Clone should not be called concurrently, +// but the original tree (t) and the new tree (t2) can be used concurrently +// once the Clone call completes. +// +// The internal tree structure of b is marked read-only and shared between t and +// t2. Writes to both t and t2 use copy-on-write logic, creating new nodes +// whenever one of b's original nodes would have been modified. Read operations +// should have no performance degredation. Write operations for both t and t2 +// will initially experience minor slow-downs caused by additional allocs and +// copies due to the aforementioned copy-on-write logic, but should converge to +// the original performance characteristics of the original tree. +func (t *BTree) Clone() (t2 *BTree) { + return (*BTree)((*BTreeG[Item])(t).Clone()) +} + +// Delete removes an item equal to the passed in item from the tree, returning +// it. If no such item exists, returns nil. +func (t *BTree) Delete(item Item) Item { + i, _ := (*BTreeG[Item])(t).Delete(item) + return i +} + +// DeleteMax removes the largest item in the tree and returns it. +// If no such item exists, returns nil. +func (t *BTree) DeleteMax() Item { + i, _ := (*BTreeG[Item])(t).DeleteMax() + return i +} + +// DeleteMin removes the smallest item in the tree and returns it. +// If no such item exists, returns nil. +func (t *BTree) DeleteMin() Item { + i, _ := (*BTreeG[Item])(t).DeleteMin() + return i +} + +// Get looks for the key item in the tree, returning it. It returns nil if +// unable to find that item. +func (t *BTree) Get(key Item) Item { + i, _ := (*BTreeG[Item])(t).Get(key) + return i +} + +// Max returns the largest item in the tree, or nil if the tree is empty. +func (t *BTree) Max() Item { + i, _ := (*BTreeG[Item])(t).Max() + return i +} + +// Min returns the smallest item in the tree, or nil if the tree is empty. +func (t *BTree) Min() Item { + i, _ := (*BTreeG[Item])(t).Min() + return i +} + +// Has returns true if the given key is in the tree. +func (t *BTree) Has(key Item) bool { + return (*BTreeG[Item])(t).Has(key) +} + +// ReplaceOrInsert adds the given item to the tree. If an item in the tree +// already equals the given one, it is removed from the tree and returned. +// Otherwise, nil is returned. +// +// nil cannot be added to the tree (will panic). +func (t *BTree) ReplaceOrInsert(item Item) Item { + i, _ := (*BTreeG[Item])(t).ReplaceOrInsert(item) + return i +} + +// AscendRange calls the iterator for every value in the tree within the range +// [greaterOrEqual, lessThan), until iterator returns false. +func (t *BTree) AscendRange(greaterOrEqual, lessThan Item, iterator ItemIterator) { + (*BTreeG[Item])(t).AscendRange(greaterOrEqual, lessThan, (ItemIteratorG[Item])(iterator)) +} + +// AscendLessThan calls the iterator for every value in the tree within the range +// [first, pivot), until iterator returns false. +func (t *BTree) AscendLessThan(pivot Item, iterator ItemIterator) { + (*BTreeG[Item])(t).AscendLessThan(pivot, (ItemIteratorG[Item])(iterator)) +} + +// AscendGreaterOrEqual calls the iterator for every value in the tree within +// the range [pivot, last], until iterator returns false. +func (t *BTree) AscendGreaterOrEqual(pivot Item, iterator ItemIterator) { + (*BTreeG[Item])(t).AscendGreaterOrEqual(pivot, (ItemIteratorG[Item])(iterator)) +} + +// Ascend calls the iterator for every value in the tree within the range +// [first, last], until iterator returns false. +func (t *BTree) Ascend(iterator ItemIterator) { + (*BTreeG[Item])(t).Ascend((ItemIteratorG[Item])(iterator)) +} + +// DescendRange calls the iterator for every value in the tree within the range +// [lessOrEqual, greaterThan), until iterator returns false. +func (t *BTree) DescendRange(lessOrEqual, greaterThan Item, iterator ItemIterator) { + (*BTreeG[Item])(t).DescendRange(lessOrEqual, greaterThan, (ItemIteratorG[Item])(iterator)) +} + +// DescendLessOrEqual calls the iterator for every value in the tree within the range +// [pivot, first], until iterator returns false. +func (t *BTree) DescendLessOrEqual(pivot Item, iterator ItemIterator) { + (*BTreeG[Item])(t).DescendLessOrEqual(pivot, (ItemIteratorG[Item])(iterator)) +} + +// DescendGreaterThan calls the iterator for every value in the tree within +// the range [last, pivot), until iterator returns false. +func (t *BTree) DescendGreaterThan(pivot Item, iterator ItemIterator) { + (*BTreeG[Item])(t).DescendGreaterThan(pivot, (ItemIteratorG[Item])(iterator)) +} + +// Descend calls the iterator for every value in the tree within the range +// [last, first], until iterator returns false. +func (t *BTree) Descend(iterator ItemIterator) { + (*BTreeG[Item])(t).Descend((ItemIteratorG[Item])(iterator)) +} + +// Len returns the number of items currently in the tree. +func (t *BTree) Len() int { + return (*BTreeG[Item])(t).Len() +} + +// Clear removes all items from the btree. If addNodesToFreelist is true, +// t's nodes are added to its freelist as part of this call, until the freelist +// is full. Otherwise, the root node is simply dereferenced and the subtree +// left to Go's normal GC processes. +// +// This can be much faster +// than calling Delete on all elements, because that requires finding/removing +// each element in the tree and updating the tree accordingly. It also is +// somewhat faster than creating a new tree to replace the old one, because +// nodes from the old tree are reclaimed into the freelist for use by the new +// one, instead of being lost to the garbage collector. +// +// This call takes: +// O(1): when addNodesToFreelist is false, this is a single operation. +// O(1): when the freelist is already full, it breaks out immediately +// O(freelist size): when the freelist is empty and the nodes are all owned +// by this tree, nodes are added to the freelist until full. +// O(tree size): when all nodes are owned by another tree, all nodes are +// iterated over looking for nodes to add to the freelist, and due to +// ownership, none are. +func (t *BTree) Clear(addNodesToFreelist bool) { + (*BTreeG[Item])(t).Clear(addNodesToFreelist) +} diff --git a/third_party/forked/golang/btree/btree_generic_test.go b/third_party/forked/golang/btree/btree_generic_test.go new file mode 100644 index 00000000..1b58a39a --- /dev/null +++ b/third_party/forked/golang/btree/btree_generic_test.go @@ -0,0 +1,764 @@ +// Copyright 2014-2022 Google Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +//go:build go1.18 +// +build go1.18 + +package btree + +import ( + "fmt" + "math/rand" + "reflect" + "sort" + "sync" + "testing" +) + +func intRange(s int, reverse bool) []int { + out := make([]int, s) + for i := 0; i < s; i++ { + v := i + if reverse { + v = s - i - 1 + } + out[i] = v + } + return out +} + +func intAll(t *BTreeG[int]) (out []int) { + t.Ascend(func(a int) bool { + out = append(out, a) + return true + }) + return +} + +func intAllRev(t *BTreeG[int]) (out []int) { + t.Descend(func(a int) bool { + out = append(out, a) + return true + }) + return +} + +func TestBTreeG(t *testing.T) { + tr := NewOrderedG[int](*btreeDegree) + const treeSize = 10000 + for i := 0; i < 10; i++ { + if min, ok := tr.Min(); ok || min != 0 { + t.Fatalf("empty min, got %+v", min) + } + if max, ok := tr.Max(); ok || max != 0 { + t.Fatalf("empty max, got %+v", max) + } + for _, item := range rand.Perm(treeSize) { + if x, ok := tr.ReplaceOrInsert(item); ok || x != 0 { + t.Fatal("insert found item", item) + } + } + for _, item := range rand.Perm(treeSize) { + if x, ok := tr.ReplaceOrInsert(item); !ok || x != item { + t.Fatal("insert didn't find item", item) + } + } + want := 0 + if min, ok := tr.Min(); !ok || min != want { + t.Fatalf("min: ok %v want %+v, got %+v", ok, want, min) + } + want = treeSize - 1 + if max, ok := tr.Max(); !ok || max != want { + t.Fatalf("max: ok %v want %+v, got %+v", ok, want, max) + } + got := intAll(tr) + wantRange := intRange(treeSize, false) + if !reflect.DeepEqual(got, wantRange) { + t.Fatalf("mismatch:\n got: %v\nwant: %v", got, wantRange) + } + + gotrev := intAllRev(tr) + wantrev := intRange(treeSize, true) + if !reflect.DeepEqual(gotrev, wantrev) { + t.Fatalf("mismatch:\n got: %v\nwant: %v", gotrev, wantrev) + } + + for _, item := range rand.Perm(treeSize) { + if x, ok := tr.Delete(item); !ok || x != item { + t.Fatalf("didn't find %v", item) + } + } + if got = intAll(tr); len(got) > 0 { + t.Fatalf("some left!: %v", got) + } + if got = intAllRev(tr); len(got) > 0 { + t.Fatalf("some left!: %v", got) + } + } +} + +func ExampleBTreeG() { + tr := NewOrderedG[int](*btreeDegree) + for i := 0; i < 10; i++ { + tr.ReplaceOrInsert(i) + } + fmt.Println("len: ", tr.Len()) + v, ok := tr.Get(3) + fmt.Println("get3: ", v, ok) + v, ok = tr.Get(100) + fmt.Println("get100: ", v, ok) + v, ok = tr.Delete(4) + fmt.Println("del4: ", v, ok) + v, ok = tr.Delete(100) + fmt.Println("del100: ", v, ok) + v, ok = tr.ReplaceOrInsert(5) + fmt.Println("replace5: ", v, ok) + v, ok = tr.ReplaceOrInsert(100) + fmt.Println("replace100:", v, ok) + v, ok = tr.Min() + fmt.Println("min: ", v, ok) + v, ok = tr.DeleteMin() + fmt.Println("delmin: ", v, ok) + v, ok = tr.Max() + fmt.Println("max: ", v, ok) + v, ok = tr.DeleteMax() + fmt.Println("delmax: ", v, ok) + fmt.Println("len: ", tr.Len()) + // Output: + // len: 10 + // get3: 3 true + // get100: 0 false + // del4: 4 true + // del100: 0 false + // replace5: 5 true + // replace100: 0 false + // min: 0 true + // delmin: 0 true + // max: 100 true + // delmax: 100 true + // len: 8 +} + +func TestDeleteMinG(t *testing.T) { + tr := NewOrderedG[int](3) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + for v, ok := tr.DeleteMin(); ok; v, ok = tr.DeleteMin() { + got = append(got, v) + } + if want := intRange(100, false); !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestDeleteMaxG(t *testing.T) { + tr := NewOrderedG[int](3) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + for v, ok := tr.DeleteMax(); ok; v, ok = tr.DeleteMax() { + got = append(got, v) + } + if want := intRange(100, true); !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestAscendRangeG(t *testing.T) { + tr := NewOrderedG[int](2) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.AscendRange(40, 60, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, false)[40:60]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.AscendRange(40, 60, func(a int) bool { + if a > 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, false)[40:51]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestDescendRangeG(t *testing.T) { + tr := NewOrderedG[int](2) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.DescendRange(60, 40, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, true)[39:59]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendrange:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.DescendRange(60, 40, func(a int) bool { + if a < 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, true)[39:50]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestAscendLessThanG(t *testing.T) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.AscendLessThan(60, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, false)[:60]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.AscendLessThan(60, func(a int) bool { + if a > 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, false)[:51]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestDescendLessOrEqualG(t *testing.T) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.DescendLessOrEqual(40, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, true)[59:]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendlessorequal:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.DescendLessOrEqual(60, func(a int) bool { + if a < 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, true)[39:50]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendlessorequal:\n got: %v\nwant: %v", got, want) + } +} + +func TestAscendGreaterOrEqualG(t *testing.T) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.AscendGreaterOrEqual(40, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, false)[40:]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.AscendGreaterOrEqual(40, func(a int) bool { + if a > 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, false)[40:51]; !reflect.DeepEqual(got, want) { + t.Fatalf("ascendrange:\n got: %v\nwant: %v", got, want) + } +} + +func TestDescendGreaterThanG(t *testing.T) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range rand.Perm(100) { + tr.ReplaceOrInsert(v) + } + var got []int + tr.DescendGreaterThan(40, func(a int) bool { + got = append(got, a) + return true + }) + if want := intRange(100, true)[:59]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendgreaterthan:\n got: %v\nwant: %v", got, want) + } + got = got[:0] + tr.DescendGreaterThan(40, func(a int) bool { + if a < 50 { + return false + } + got = append(got, a) + return true + }) + if want := intRange(100, true)[:50]; !reflect.DeepEqual(got, want) { + t.Fatalf("descendgreaterthan:\n got: %v\nwant: %v", got, want) + } +} + +func BenchmarkInsertG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + b.StartTimer() + i := 0 + for i < b.N { + tr := NewOrderedG[int](*btreeDegree) + for _, item := range insertP { + tr.ReplaceOrInsert(item) + i++ + if i >= b.N { + return + } + } + } +} + +func BenchmarkSeekG(b *testing.B) { + b.StopTimer() + size := 100000 + insertP := rand.Perm(size) + tr := NewOrderedG[int](*btreeDegree) + for _, item := range insertP { + tr.ReplaceOrInsert(item) + } + b.StartTimer() + + for i := 0; i < b.N; i++ { + tr.AscendGreaterOrEqual(i%size, func(i int) bool { return false }) + } +} + +func BenchmarkDeleteInsertG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, item := range insertP { + tr.ReplaceOrInsert(item) + } + b.StartTimer() + for i := 0; i < b.N; i++ { + tr.Delete(insertP[i%benchmarkTreeSize]) + tr.ReplaceOrInsert(insertP[i%benchmarkTreeSize]) + } +} + +func BenchmarkDeleteInsertCloneOnceG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, item := range insertP { + tr.ReplaceOrInsert(item) + } + tr = tr.Clone() + b.StartTimer() + for i := 0; i < b.N; i++ { + tr.Delete(insertP[i%benchmarkTreeSize]) + tr.ReplaceOrInsert(insertP[i%benchmarkTreeSize]) + } +} + +func BenchmarkDeleteInsertCloneEachTimeG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, item := range insertP { + tr.ReplaceOrInsert(item) + } + b.StartTimer() + for i := 0; i < b.N; i++ { + tr = tr.Clone() + tr.Delete(insertP[i%benchmarkTreeSize]) + tr.ReplaceOrInsert(insertP[i%benchmarkTreeSize]) + } +} + +func BenchmarkDeleteG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + removeP := rand.Perm(benchmarkTreeSize) + b.StartTimer() + i := 0 + for i < b.N { + b.StopTimer() + tr := NewOrderedG[int](*btreeDegree) + for _, v := range insertP { + tr.ReplaceOrInsert(v) + } + b.StartTimer() + for _, item := range removeP { + tr.Delete(item) + i++ + if i >= b.N { + return + } + } + if tr.Len() > 0 { + panic(tr.Len()) + } + } +} + +func BenchmarkGetG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + removeP := rand.Perm(benchmarkTreeSize) + b.StartTimer() + i := 0 + for i < b.N { + b.StopTimer() + tr := NewOrderedG[int](*btreeDegree) + for _, v := range insertP { + tr.ReplaceOrInsert(v) + } + b.StartTimer() + for _, item := range removeP { + tr.Get(item) + i++ + if i >= b.N { + return + } + } + } +} + +func BenchmarkGetCloneEachTimeG(b *testing.B) { + b.StopTimer() + insertP := rand.Perm(benchmarkTreeSize) + removeP := rand.Perm(benchmarkTreeSize) + b.StartTimer() + i := 0 + for i < b.N { + b.StopTimer() + tr := NewOrderedG[int](*btreeDegree) + for _, v := range insertP { + tr.ReplaceOrInsert(v) + } + b.StartTimer() + for _, item := range removeP { + tr = tr.Clone() + tr.Get(item) + i++ + if i >= b.N { + return + } + } + } +} + +func BenchmarkAscendG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := 0 + tr.Ascend(func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j++ + return true + }) + } +} + +func BenchmarkDescendG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := len(arr) - 1 + tr.Descend(func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j-- + return true + }) + } +} + +func BenchmarkAscendRangeG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := 100 + tr.AscendRange(100, arr[len(arr)-100], func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j++ + return true + }) + if j != len(arr)-100 { + b.Fatalf("expected: %v, got %v", len(arr)-100, j) + } + } +} + +func BenchmarkDescendRangeG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := len(arr) - 100 + tr.DescendRange(arr[len(arr)-100], 100, func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j-- + return true + }) + if j != 100 { + b.Fatalf("expected: %v, got %v", len(arr)-100, j) + } + } +} + +func BenchmarkAscendGreaterOrEqualG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := 100 + k := 0 + tr.AscendGreaterOrEqual(100, func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j++ + k++ + return true + }) + if j != len(arr) { + b.Fatalf("expected: %v, got %v", len(arr), j) + } + if k != len(arr)-100 { + b.Fatalf("expected: %v, got %v", len(arr)-100, k) + } + } +} + +func BenchmarkDescendLessOrEqualG(b *testing.B) { + arr := rand.Perm(benchmarkTreeSize) + tr := NewOrderedG[int](*btreeDegree) + for _, v := range arr { + tr.ReplaceOrInsert(v) + } + sort.Ints(arr) + b.ResetTimer() + for i := 0; i < b.N; i++ { + j := len(arr) - 100 + k := len(arr) + tr.DescendLessOrEqual(arr[len(arr)-100], func(item int) bool { + if item != arr[j] { + b.Fatalf("mismatch: expected: %v, got %v", arr[j], item) + } + j-- + k-- + return true + }) + if j != -1 { + b.Fatalf("expected: %v, got %v", -1, j) + } + if k != 99 { + b.Fatalf("expected: %v, got %v", 99, k) + } + } +} + +func cloneTestG(t *testing.T, b *BTreeG[int], start int, p []int, wg *sync.WaitGroup, trees *[]*BTreeG[int], lock *sync.Mutex) { + t.Logf("Starting new clone at %v", start) + lock.Lock() + *trees = append(*trees, b) + lock.Unlock() + for i := start; i < cloneTestSize; i++ { + b.ReplaceOrInsert(p[i]) + if i%(cloneTestSize/5) == 0 { + wg.Add(1) + go cloneTestG(t, b.Clone(), i+1, p, wg, trees, lock) + } + } + wg.Done() +} + +func TestCloneConcurrentOperationsG(t *testing.T) { + b := NewOrderedG[int](*btreeDegree) + trees := []*BTreeG[int]{} + p := rand.Perm(cloneTestSize) + var wg sync.WaitGroup + wg.Add(1) + go cloneTestG(t, b, 0, p, &wg, &trees, &sync.Mutex{}) + wg.Wait() + want := intRange(cloneTestSize, false) + t.Logf("Starting equality checks on %d trees", len(trees)) + for i, tree := range trees { + if !reflect.DeepEqual(want, intAll(tree)) { + t.Errorf("tree %v mismatch", i) + } + } + t.Log("Removing half from first half") + toRemove := intRange(cloneTestSize, false)[cloneTestSize/2:] + for i := 0; i < len(trees)/2; i++ { + tree := trees[i] + wg.Add(1) + go func() { + for _, item := range toRemove { + tree.Delete(item) + } + wg.Done() + }() + } + wg.Wait() + t.Log("Checking all values again") + for i, tree := range trees { + var wantpart []int + if i < len(trees)/2 { + wantpart = want[:cloneTestSize/2] + } else { + wantpart = want + } + if got := intAll(tree); !reflect.DeepEqual(wantpart, got) { + t.Errorf("tree %v mismatch, want %v got %v", i, len(want), len(got)) + } + } +} + +func BenchmarkDeleteAndRestoreG(b *testing.B) { + items := rand.Perm(16392) + b.ResetTimer() + b.Run(`CopyBigFreeList`, func(b *testing.B) { + fl := NewFreeListG[int](16392) + tr := NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + b.ReportAllocs() + b.ResetTimer() + for i := 0; i < b.N; i++ { + dels := make([]int, 0, tr.Len()) + tr.Ascend(func(b int) bool { + dels = append(dels, b) + return true + }) + for _, del := range dels { + tr.Delete(del) + } + // tr is now empty, we make a new empty copy of it. + tr = NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + } + }) + b.Run(`Copy`, func(b *testing.B) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + b.ReportAllocs() + b.ResetTimer() + for i := 0; i < b.N; i++ { + dels := make([]int, 0, tr.Len()) + tr.Ascend(func(b int) bool { + dels = append(dels, b) + return true + }) + for _, del := range dels { + tr.Delete(del) + } + // tr is now empty, we make a new empty copy of it. + tr = NewOrderedG[int](*btreeDegree) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + } + }) + b.Run(`ClearBigFreelist`, func(b *testing.B) { + fl := NewFreeListG[int](16392) + tr := NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + b.ReportAllocs() + b.ResetTimer() + for i := 0; i < b.N; i++ { + tr.Clear(true) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + } + }) + b.Run(`Clear`, func(b *testing.B) { + tr := NewOrderedG[int](*btreeDegree) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + b.ReportAllocs() + b.ResetTimer() + for i := 0; i < b.N; i++ { + tr.Clear(true) + for _, v := range items { + tr.ReplaceOrInsert(v) + } + } + }) +} From cec797edde69529d9ca19a3cf87d1702bf4ed631 Mon Sep 17 00:00:00 2001 From: Sharath P J Date: Tue, 6 Jan 2026 13:36:40 +0530 Subject: [PATCH 2/2] third_party/forked/btree: adapt forked google/btree for Kubernetes usage --- third_party/forked/golang/btree/LICENSE | 2 +- third_party/forked/golang/btree/README.md | 11 +- .../btree/{btree_generic.go => btree.go} | 415 ++++-------------- .../{btree_generic_test.go => btree_test.go} | 146 +++--- 4 files changed, 176 insertions(+), 398 deletions(-) rename third_party/forked/golang/btree/{btree_generic.go => btree.go} (64%) rename third_party/forked/golang/btree/{btree_generic_test.go => btree_test.go} (83%) diff --git a/third_party/forked/golang/btree/LICENSE b/third_party/forked/golang/btree/LICENSE index d6456956..7a4a3ea2 100644 --- a/third_party/forked/golang/btree/LICENSE +++ b/third_party/forked/golang/btree/LICENSE @@ -199,4 +199,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and - limitations under the License. + limitations under the License. \ No newline at end of file diff --git a/third_party/forked/golang/btree/README.md b/third_party/forked/golang/btree/README.md index eab5dbf7..643ad5e9 100644 --- a/third_party/forked/golang/btree/README.md +++ b/third_party/forked/golang/btree/README.md @@ -1,10 +1,7 @@ -# BTree implementation for Go +This package is forked from https://github.com/google/btree. -This package provides an in-memory B-Tree implementation for Go, useful as -an ordered, mutable data structure. +The upstream repository is deprecated. Kubernetes maintains this fork to continue supporting existing usage. -The API is based off of the wonderful -http://godoc.org/github.com/petar/GoLLRB/llrb, and is meant to allow btree to -act as a drop-in replacement for gollrb trees. +Only the subset of functionality required by Kubernetes is included. The implementation is based on the generic version introduced in Go 1.18. -See http://godoc.org/github.com/google/btree for documentation. +The core B-tree algorithm is unchanged from the upstream implementation. \ No newline at end of file diff --git a/third_party/forked/golang/btree/btree_generic.go b/third_party/forked/golang/btree/btree.go similarity index 64% rename from third_party/forked/golang/btree/btree_generic.go rename to third_party/forked/golang/btree/btree.go index e44a0f48..88c0352b 100644 --- a/third_party/forked/golang/btree/btree_generic.go +++ b/third_party/forked/golang/btree/btree.go @@ -1,4 +1,8 @@ // Copyright 2014-2022 Google Inc. +// Copyright 2025 The Kubernetes Authors. +// +// This file is derived from github.com/google/btree and has been +// modified for use in the Kubernetes util package. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,14 +16,6 @@ // See the License for the specific language governing permissions and // limitations under the License. -//go:build go1.18 -// +build go1.18 - -// In Go 1.18 and beyond, a BTreeG generic is created, and BTree is a specific -// instantiation of that generic for the Item interface, with a backwards- -// compatible API. Before go1.18, generics are not supported, -// and BTree is just an implementation based around the Item interface. - // Package btree implements in-memory B-Trees of arbitrary degree. // // btree implements an in-memory B-Tree for use as an ordered data structure. @@ -28,7 +24,9 @@ // It has a flatter structure than an equivalent red-black or other binary tree, // which in some cases yields better memory usage and/or performance. // See some discussion on the matter here: -// http://google-opensource.blogspot.com/2013/01/c-containers-that-save-memory-and-time.html +// +// http://google-opensource.blogspot.com/2013/01/c-containers-that-save-memory-and-time.html +// // Note, though, that this project is in no way related to the C++ B-Tree // implementation written about there. // @@ -36,13 +34,14 @@ // slice of children. For basic numeric values or raw structs, this can cause // efficiency differences when compared to equivalent C++ template code that // stores values in arrays within the node: -// * Due to the overhead of storing values as interfaces (each +// - Due to the overhead of storing values as interfaces (each // value needs to be stored as the value itself, then 2 words for the // interface pointing to that value and its type), resulting in higher // memory use. -// * Since interfaces can point to values anywhere in memory, values are +// - Since interfaces can point to values anywhere in memory, values are // most likely not stored in contiguous blocks, resulting in a higher // number of cache misses. +// // These issues don't tend to matter, though, when working with strings or other // heap-allocated structures, since C++-equivalent structures also must store // pointers and also distribute their values across the heap. @@ -53,51 +52,33 @@ // Its functions, therefore, exactly mirror those of // llrb.LLRB where possible. Unlike gollrb, though, we currently don't // support storing multiple equivalent values. -// -// There are two implementations; those suffixed with 'G' are generics, usable -// for any type, and require a passed-in "less" function to define their ordering. -// Those without this prefix are specific to the 'Item' interface, and use -// its 'Less' function for ordering. package btree import ( - "fmt" - "io" + "cmp" "sort" - "strings" "sync" ) -// Item represents a single object in the tree. -type Item interface { - // Less tests whether the current item is less than the given argument. - // - // This must provide a strict weak ordering. - // If !a.Less(b) && !b.Less(a), we treat this to mean a == b (i.e. we can only - // hold one of either a or b in the tree). - Less(than Item) bool -} +// DefaultFreeListSize is the default capacity of a BTree node free list. +const DefaultFreeListSize = 32 -const ( - DefaultFreeListSize = 32 -) - -// FreeListG represents a free list of btree nodes. By default each +// FreeList represents a free list of btree nodes. By default each // BTree has its own FreeList, but multiple BTrees can share the same // FreeList, in particular when they're created with Clone. // Two Btrees using the same freelist are safe for concurrent write access. -type FreeListG[T any] struct { +type FreeList[T any] struct { mu sync.Mutex freelist []*node[T] } -// NewFreeListG creates a new free list. +// NewFreeList creates a new free list. // size is the maximum size of the returned free list. -func NewFreeListG[T any](size int) *FreeListG[T] { - return &FreeListG[T]{freelist: make([]*node[T], 0, size)} +func NewFreeList[T any](size int) *FreeList[T] { + return &FreeList[T]{freelist: make([]*node[T], 0, size)} } -func (f *FreeListG[T]) newNode() (n *node[T]) { +func (f *FreeList[T]) newNode() (n *node[T]) { f.mu.Lock() index := len(f.freelist) - 1 if index < 0 { @@ -111,7 +92,7 @@ func (f *FreeListG[T]) newNode() (n *node[T]) { return } -func (f *FreeListG[T]) freeNode(n *node[T]) (out bool) { +func (f *FreeList[T]) freeNode(n *node[T]) (out bool) { f.mu.Lock() if len(f.freelist) < cap(f.freelist) { f.freelist = append(f.freelist, n) @@ -121,42 +102,37 @@ func (f *FreeListG[T]) freeNode(n *node[T]) (out bool) { return } -// ItemIteratorG allows callers of {A/De}scend* to iterate in-order over portions of +// ItemIterator allows callers of {A/De}scend* to iterate in-order over portions of // the tree. When this function returns false, iteration will stop and the // associated Ascend* function will immediately return. -type ItemIteratorG[T any] func(item T) bool - -// Ordered represents the set of types for which the '<' operator work. -type Ordered interface { - ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~float32 | ~float64 | ~string -} +type ItemIterator[T any] func(item T) bool -// Less[T] returns a default LessFunc that uses the '<' operator for types that support it. -func Less[T Ordered]() LessFunc[T] { +// Less returns a default LessFunc that uses the '<' operator for types that support it. +func Less[T cmp.Ordered]() LessFunc[T] { return func(a, b T) bool { return a < b } } -// NewOrderedG creates a new B-Tree for ordered types. -func NewOrderedG[T Ordered](degree int) *BTreeG[T] { - return NewG[T](degree, Less[T]()) +// NewOrdered creates a new B-Tree for ordered types. +func NewOrdered[T cmp.Ordered](degree int) *BTree[T] { + return New[T](degree, Less[T]()) } -// NewG creates a new B-Tree with the given degree. +// New creates a new B-Tree with the given degree. // -// NewG(2), for example, will create a 2-3-4 tree (each node contains 1-3 items +// New(2), for example, will create a 2-3-4 tree (each node contains 1-3 items // and 2-4 children). // // The passed-in LessFunc determines how objects of type T are ordered. -func NewG[T any](degree int, less LessFunc[T]) *BTreeG[T] { - return NewWithFreeListG(degree, less, NewFreeListG[T](DefaultFreeListSize)) +func New[T any](degree int, less LessFunc[T]) *BTree[T] { + return NewWithFreeList(degree, less, NewFreeList[T](DefaultFreeListSize)) } -// NewWithFreeListG creates a new B-Tree that uses the given node free list. -func NewWithFreeListG[T any](degree int, less LessFunc[T], f *FreeListG[T]) *BTreeG[T] { +// NewWithFreeList creates a new B-Tree that uses the given node free list. +func NewWithFreeList[T any](degree int, less LessFunc[T], f *FreeList[T]) *BTree[T] { if degree <= 1 { panic("bad degree") } - return &BTreeG[T]{ + return &BTree[T]{ degree: degree, cow: ©OnWriteContext[T]{freelist: f, less: less}, } @@ -224,8 +200,8 @@ func (s items[T]) find(item T, less func(T, T) bool) (index int, found bool) { // node is an internal node in a tree. // // It must at all times maintain the invariant that either -// * len(children) == 0, len(items) unconstrained -// * len(children) == len(items) + 1 +// - len(children) == 0, len(items) unconstrained +// - len(children) == len(items) + 1 type node[T any] struct { items items[T] children items[*node[T]] @@ -420,15 +396,20 @@ func (n *node[T]) remove(item T, minItems int, typ toRemove) (_ T, _ bool) { // remove it. // // Most documentation says we have to do two sets of special casing: -// 1) item is in this node -// 2) item is in child +// 1. item is in this node +// 2. item is in child +// // In both cases, we need to handle the two subcases: -// A) node has enough values that it can spare one -// B) node doesn't have enough values +// +// A) node has enough values that it can spare one +// B) node doesn't have enough values +// // For the latter, we have to check: -// a) left sibling has node to spare -// b) right sibling has node to spare -// c) we must merge +// +// a) left sibling has node to spare +// b) right sibling has node to spare +// c) we must merge +// // To simplify our code here, we handle cases #1 and #2 the same: // If a node doesn't have enough items, we make sure it does (using a,b,c). // We then simply redo our remove call, and the second time (regardless of @@ -497,7 +478,7 @@ func empty[T any]() optionalItem[T] { // will force the iterator to include the first item when it equals 'start', // thus creating a "greaterOrEqual" or "lessThanEqual" rather than just a // "greaterThan" or "lessThan" queries. -func (n *node[T]) iterate(dir direction, start, stop optionalItem[T], includeStart bool, hit bool, iter ItemIteratorG[T]) (bool, bool) { +func (n *node[T]) iterate(dir direction, start, stop optionalItem[T], includeStart bool, hit bool, iter ItemIterator[T]) (bool, bool) { var ok, found bool var index int switch dir { @@ -565,29 +546,21 @@ func (n *node[T]) iterate(dir direction, start, stop optionalItem[T], includeSta return hit, true } -// print is used for testing/debugging purposes. -func (n *node[T]) print(w io.Writer, level int) { - fmt.Fprintf(w, "%sNODE:%v\n", strings.Repeat(" ", level), n.items) - for _, c := range n.children { - c.print(w, level+1) - } -} - -// BTreeG is a generic implementation of a B-Tree. +// BTree is a generic implementation of a B-Tree. // -// BTreeG stores items of type T in an ordered structure, allowing easy insertion, +// BTree stores items of type T in an ordered structure, allowing easy insertion, // removal, and iteration. // // Write operations are not safe for concurrent mutation by multiple // goroutines, but Read operations are. -type BTreeG[T any] struct { +type BTree[T any] struct { degree int length int root *node[T] cow *copyOnWriteContext[T] } -// LessFunc[T] determines how to order a type 'T'. It should implement a strict +// LessFunc determines how to order a type 'T'. It should implement a strict // ordering, and should return true if within that ordering, 'a' < 'b'. type LessFunc[T any] func(a, b T) bool @@ -606,7 +579,7 @@ type LessFunc[T any] func(a, b T) bool // not share context, but before we descend into them, we'll make a mutable // copy. type copyOnWriteContext[T any] struct { - freelist *FreeListG[T] + freelist *FreeList[T] less LessFunc[T] } @@ -621,7 +594,7 @@ type copyOnWriteContext[T any] struct { // will initially experience minor slow-downs caused by additional allocs and // copies due to the aforementioned copy-on-write logic, but should converge to // the original performance characteristics of the original tree. -func (t *BTreeG[T]) Clone() (t2 *BTreeG[T]) { +func (t *BTree[T]) Clone() (t2 *BTree[T]) { // Create two entirely new copy-on-write contexts. // This operation effectively creates three trees: // the original, shared nodes (old b.cow) @@ -635,13 +608,13 @@ func (t *BTreeG[T]) Clone() (t2 *BTreeG[T]) { } // maxItems returns the max number of items to allow per node. -func (t *BTreeG[T]) maxItems() int { +func (t *BTree[T]) maxItems() int { return t.degree*2 - 1 } // minItems returns the min number of items to allow per node (ignored for the // root node). -func (t *BTreeG[T]) minItems() int { +func (t *BTree[T]) minItems() int { return t.degree - 1 } @@ -670,12 +643,10 @@ func (c *copyOnWriteContext[T]) freeNode(n *node[T]) freeType { n.cow = nil if c.freelist.freeNode(n) { return ftStored - } else { - return ftFreelistFull } - } else { - return ftNotOwned + return ftFreelistFull } + return ftNotOwned } // ReplaceOrInsert adds the given item to the tree. If an item in the tree @@ -683,21 +654,20 @@ func (c *copyOnWriteContext[T]) freeNode(n *node[T]) freeType { // and the second return value is true. Otherwise, (zeroValue, false) // // nil cannot be added to the tree (will panic). -func (t *BTreeG[T]) ReplaceOrInsert(item T) (_ T, _ bool) { +func (t *BTree[T]) ReplaceOrInsert(item T) (_ T, _ bool) { if t.root == nil { t.root = t.cow.newNode() t.root.items = append(t.root.items, item) t.length++ return - } else { - t.root = t.root.mutableFor(t.cow) - if len(t.root.items) >= t.maxItems() { - item2, second := t.root.split(t.maxItems() / 2) - oldroot := t.root - t.root = t.cow.newNode() - t.root.items = append(t.root.items, item2) - t.root.children = append(t.root.children, oldroot, second) - } + } + t.root = t.root.mutableFor(t.cow) + if len(t.root.items) >= t.maxItems() { + item2, second := t.root.split(t.maxItems() / 2) + oldroot := t.root + t.root = t.cow.newNode() + t.root.items = append(t.root.items, item2) + t.root.children = append(t.root.children, oldroot, second) } out, outb := t.root.insert(item, t.maxItems()) if !outb { @@ -708,25 +678,25 @@ func (t *BTreeG[T]) ReplaceOrInsert(item T) (_ T, _ bool) { // Delete removes an item equal to the passed in item from the tree, returning // it. If no such item exists, returns (zeroValue, false). -func (t *BTreeG[T]) Delete(item T) (T, bool) { +func (t *BTree[T]) Delete(item T) (T, bool) { return t.deleteItem(item, removeItem) } // DeleteMin removes the smallest item in the tree and returns it. // If no such item exists, returns (zeroValue, false). -func (t *BTreeG[T]) DeleteMin() (T, bool) { +func (t *BTree[T]) DeleteMin() (T, bool) { var zero T return t.deleteItem(zero, removeMin) } // DeleteMax removes the largest item in the tree and returns it. // If no such item exists, returns (zeroValue, false). -func (t *BTreeG[T]) DeleteMax() (T, bool) { +func (t *BTree[T]) DeleteMax() (T, bool) { var zero T return t.deleteItem(zero, removeMax) } -func (t *BTreeG[T]) deleteItem(item T, typ toRemove) (_ T, _ bool) { +func (t *BTree[T]) deleteItem(item T, typ toRemove) (_ T, _ bool) { if t.root == nil || len(t.root.items) == 0 { return } @@ -745,7 +715,7 @@ func (t *BTreeG[T]) deleteItem(item T, typ toRemove) (_ T, _ bool) { // AscendRange calls the iterator for every value in the tree within the range // [greaterOrEqual, lessThan), until iterator returns false. -func (t *BTreeG[T]) AscendRange(greaterOrEqual, lessThan T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) AscendRange(greaterOrEqual, lessThan T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -754,7 +724,7 @@ func (t *BTreeG[T]) AscendRange(greaterOrEqual, lessThan T, iterator ItemIterato // AscendLessThan calls the iterator for every value in the tree within the range // [first, pivot), until iterator returns false. -func (t *BTreeG[T]) AscendLessThan(pivot T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) AscendLessThan(pivot T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -763,7 +733,7 @@ func (t *BTreeG[T]) AscendLessThan(pivot T, iterator ItemIteratorG[T]) { // AscendGreaterOrEqual calls the iterator for every value in the tree within // the range [pivot, last], until iterator returns false. -func (t *BTreeG[T]) AscendGreaterOrEqual(pivot T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) AscendGreaterOrEqual(pivot T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -772,7 +742,7 @@ func (t *BTreeG[T]) AscendGreaterOrEqual(pivot T, iterator ItemIteratorG[T]) { // Ascend calls the iterator for every value in the tree within the range // [first, last], until iterator returns false. -func (t *BTreeG[T]) Ascend(iterator ItemIteratorG[T]) { +func (t *BTree[T]) Ascend(iterator ItemIterator[T]) { if t.root == nil { return } @@ -781,7 +751,7 @@ func (t *BTreeG[T]) Ascend(iterator ItemIteratorG[T]) { // DescendRange calls the iterator for every value in the tree within the range // [lessOrEqual, greaterThan), until iterator returns false. -func (t *BTreeG[T]) DescendRange(lessOrEqual, greaterThan T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) DescendRange(lessOrEqual, greaterThan T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -790,7 +760,7 @@ func (t *BTreeG[T]) DescendRange(lessOrEqual, greaterThan T, iterator ItemIterat // DescendLessOrEqual calls the iterator for every value in the tree within the range // [pivot, first], until iterator returns false. -func (t *BTreeG[T]) DescendLessOrEqual(pivot T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) DescendLessOrEqual(pivot T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -799,7 +769,7 @@ func (t *BTreeG[T]) DescendLessOrEqual(pivot T, iterator ItemIteratorG[T]) { // DescendGreaterThan calls the iterator for every value in the tree within // the range [last, pivot), until iterator returns false. -func (t *BTreeG[T]) DescendGreaterThan(pivot T, iterator ItemIteratorG[T]) { +func (t *BTree[T]) DescendGreaterThan(pivot T, iterator ItemIterator[T]) { if t.root == nil { return } @@ -808,7 +778,7 @@ func (t *BTreeG[T]) DescendGreaterThan(pivot T, iterator ItemIteratorG[T]) { // Descend calls the iterator for every value in the tree within the range // [last, first], until iterator returns false. -func (t *BTreeG[T]) Descend(iterator ItemIteratorG[T]) { +func (t *BTree[T]) Descend(iterator ItemIterator[T]) { if t.root == nil { return } @@ -817,7 +787,7 @@ func (t *BTreeG[T]) Descend(iterator ItemIteratorG[T]) { // Get looks for the key item in the tree, returning it. It returns // (zeroValue, false) if unable to find that item. -func (t *BTreeG[T]) Get(key T) (_ T, _ bool) { +func (t *BTree[T]) Get(key T) (_ T, _ bool) { if t.root == nil { return } @@ -825,23 +795,23 @@ func (t *BTreeG[T]) Get(key T) (_ T, _ bool) { } // Min returns the smallest item in the tree, or (zeroValue, false) if the tree is empty. -func (t *BTreeG[T]) Min() (_ T, _ bool) { +func (t *BTree[T]) Min() (_ T, _ bool) { return min(t.root) } // Max returns the largest item in the tree, or (zeroValue, false) if the tree is empty. -func (t *BTreeG[T]) Max() (_ T, _ bool) { +func (t *BTree[T]) Max() (_ T, _ bool) { return max(t.root) } // Has returns true if the given key is in the tree. -func (t *BTreeG[T]) Has(key T) bool { +func (t *BTree[T]) Has(key T) bool { _, ok := t.Get(key) return ok } // Len returns the number of items currently in the tree. -func (t *BTreeG[T]) Len() int { +func (t *BTree[T]) Len() int { return t.length } @@ -858,14 +828,15 @@ func (t *BTreeG[T]) Len() int { // one, instead of being lost to the garbage collector. // // This call takes: -// O(1): when addNodesToFreelist is false, this is a single operation. -// O(1): when the freelist is already full, it breaks out immediately -// O(freelist size): when the freelist is empty and the nodes are all owned -// by this tree, nodes are added to the freelist until full. -// O(tree size): when all nodes are owned by another tree, all nodes are -// iterated over looking for nodes to add to the freelist, and due to -// ownership, none are. -func (t *BTreeG[T]) Clear(addNodesToFreelist bool) { +// +// O(1): when addNodesToFreelist is false, this is a single operation. +// O(1): when the freelist is already full, it breaks out immediately +// O(freelist size): when the freelist is empty and the nodes are all owned +// by this tree, nodes are added to the freelist until full. +// O(tree size): when all nodes are owned by another tree, all nodes are +// iterated over looking for nodes to add to the freelist, and due to +// ownership, none are. +func (t *BTree[T]) Clear(addNodesToFreelist bool) { if t.root != nil && addNodesToFreelist { t.root.reset(t.cow) } @@ -883,201 +854,3 @@ func (n *node[T]) reset(c *copyOnWriteContext[T]) bool { } return c.freeNode(n) != ftFreelistFull } - -// Int implements the Item interface for integers. -type Int int - -// Less returns true if int(a) < int(b). -func (a Int) Less(b Item) bool { - return a < b.(Int) -} - -// BTree is an implementation of a B-Tree. -// -// BTree stores Item instances in an ordered structure, allowing easy insertion, -// removal, and iteration. -// -// Write operations are not safe for concurrent mutation by multiple -// goroutines, but Read operations are. -type BTree BTreeG[Item] - -var itemLess LessFunc[Item] = func(a, b Item) bool { - return a.Less(b) -} - -// New creates a new B-Tree with the given degree. -// -// New(2), for example, will create a 2-3-4 tree (each node contains 1-3 items -// and 2-4 children). -func New(degree int) *BTree { - return (*BTree)(NewG[Item](degree, itemLess)) -} - -// FreeList represents a free list of btree nodes. By default each -// BTree has its own FreeList, but multiple BTrees can share the same -// FreeList. -// Two Btrees using the same freelist are safe for concurrent write access. -type FreeList FreeListG[Item] - -// NewFreeList creates a new free list. -// size is the maximum size of the returned free list. -func NewFreeList(size int) *FreeList { - return (*FreeList)(NewFreeListG[Item](size)) -} - -// NewWithFreeList creates a new B-Tree that uses the given node free list. -func NewWithFreeList(degree int, f *FreeList) *BTree { - return (*BTree)(NewWithFreeListG[Item](degree, itemLess, (*FreeListG[Item])(f))) -} - -// ItemIterator allows callers of Ascend* to iterate in-order over portions of -// the tree. When this function returns false, iteration will stop and the -// associated Ascend* function will immediately return. -type ItemIterator ItemIteratorG[Item] - -// Clone clones the btree, lazily. Clone should not be called concurrently, -// but the original tree (t) and the new tree (t2) can be used concurrently -// once the Clone call completes. -// -// The internal tree structure of b is marked read-only and shared between t and -// t2. Writes to both t and t2 use copy-on-write logic, creating new nodes -// whenever one of b's original nodes would have been modified. Read operations -// should have no performance degredation. Write operations for both t and t2 -// will initially experience minor slow-downs caused by additional allocs and -// copies due to the aforementioned copy-on-write logic, but should converge to -// the original performance characteristics of the original tree. -func (t *BTree) Clone() (t2 *BTree) { - return (*BTree)((*BTreeG[Item])(t).Clone()) -} - -// Delete removes an item equal to the passed in item from the tree, returning -// it. If no such item exists, returns nil. -func (t *BTree) Delete(item Item) Item { - i, _ := (*BTreeG[Item])(t).Delete(item) - return i -} - -// DeleteMax removes the largest item in the tree and returns it. -// If no such item exists, returns nil. -func (t *BTree) DeleteMax() Item { - i, _ := (*BTreeG[Item])(t).DeleteMax() - return i -} - -// DeleteMin removes the smallest item in the tree and returns it. -// If no such item exists, returns nil. -func (t *BTree) DeleteMin() Item { - i, _ := (*BTreeG[Item])(t).DeleteMin() - return i -} - -// Get looks for the key item in the tree, returning it. It returns nil if -// unable to find that item. -func (t *BTree) Get(key Item) Item { - i, _ := (*BTreeG[Item])(t).Get(key) - return i -} - -// Max returns the largest item in the tree, or nil if the tree is empty. -func (t *BTree) Max() Item { - i, _ := (*BTreeG[Item])(t).Max() - return i -} - -// Min returns the smallest item in the tree, or nil if the tree is empty. -func (t *BTree) Min() Item { - i, _ := (*BTreeG[Item])(t).Min() - return i -} - -// Has returns true if the given key is in the tree. -func (t *BTree) Has(key Item) bool { - return (*BTreeG[Item])(t).Has(key) -} - -// ReplaceOrInsert adds the given item to the tree. If an item in the tree -// already equals the given one, it is removed from the tree and returned. -// Otherwise, nil is returned. -// -// nil cannot be added to the tree (will panic). -func (t *BTree) ReplaceOrInsert(item Item) Item { - i, _ := (*BTreeG[Item])(t).ReplaceOrInsert(item) - return i -} - -// AscendRange calls the iterator for every value in the tree within the range -// [greaterOrEqual, lessThan), until iterator returns false. -func (t *BTree) AscendRange(greaterOrEqual, lessThan Item, iterator ItemIterator) { - (*BTreeG[Item])(t).AscendRange(greaterOrEqual, lessThan, (ItemIteratorG[Item])(iterator)) -} - -// AscendLessThan calls the iterator for every value in the tree within the range -// [first, pivot), until iterator returns false. -func (t *BTree) AscendLessThan(pivot Item, iterator ItemIterator) { - (*BTreeG[Item])(t).AscendLessThan(pivot, (ItemIteratorG[Item])(iterator)) -} - -// AscendGreaterOrEqual calls the iterator for every value in the tree within -// the range [pivot, last], until iterator returns false. -func (t *BTree) AscendGreaterOrEqual(pivot Item, iterator ItemIterator) { - (*BTreeG[Item])(t).AscendGreaterOrEqual(pivot, (ItemIteratorG[Item])(iterator)) -} - -// Ascend calls the iterator for every value in the tree within the range -// [first, last], until iterator returns false. -func (t *BTree) Ascend(iterator ItemIterator) { - (*BTreeG[Item])(t).Ascend((ItemIteratorG[Item])(iterator)) -} - -// DescendRange calls the iterator for every value in the tree within the range -// [lessOrEqual, greaterThan), until iterator returns false. -func (t *BTree) DescendRange(lessOrEqual, greaterThan Item, iterator ItemIterator) { - (*BTreeG[Item])(t).DescendRange(lessOrEqual, greaterThan, (ItemIteratorG[Item])(iterator)) -} - -// DescendLessOrEqual calls the iterator for every value in the tree within the range -// [pivot, first], until iterator returns false. -func (t *BTree) DescendLessOrEqual(pivot Item, iterator ItemIterator) { - (*BTreeG[Item])(t).DescendLessOrEqual(pivot, (ItemIteratorG[Item])(iterator)) -} - -// DescendGreaterThan calls the iterator for every value in the tree within -// the range [last, pivot), until iterator returns false. -func (t *BTree) DescendGreaterThan(pivot Item, iterator ItemIterator) { - (*BTreeG[Item])(t).DescendGreaterThan(pivot, (ItemIteratorG[Item])(iterator)) -} - -// Descend calls the iterator for every value in the tree within the range -// [last, first], until iterator returns false. -func (t *BTree) Descend(iterator ItemIterator) { - (*BTreeG[Item])(t).Descend((ItemIteratorG[Item])(iterator)) -} - -// Len returns the number of items currently in the tree. -func (t *BTree) Len() int { - return (*BTreeG[Item])(t).Len() -} - -// Clear removes all items from the btree. If addNodesToFreelist is true, -// t's nodes are added to its freelist as part of this call, until the freelist -// is full. Otherwise, the root node is simply dereferenced and the subtree -// left to Go's normal GC processes. -// -// This can be much faster -// than calling Delete on all elements, because that requires finding/removing -// each element in the tree and updating the tree accordingly. It also is -// somewhat faster than creating a new tree to replace the old one, because -// nodes from the old tree are reclaimed into the freelist for use by the new -// one, instead of being lost to the garbage collector. -// -// This call takes: -// O(1): when addNodesToFreelist is false, this is a single operation. -// O(1): when the freelist is already full, it breaks out immediately -// O(freelist size): when the freelist is empty and the nodes are all owned -// by this tree, nodes are added to the freelist until full. -// O(tree size): when all nodes are owned by another tree, all nodes are -// iterated over looking for nodes to add to the freelist, and due to -// ownership, none are. -func (t *BTree) Clear(addNodesToFreelist bool) { - (*BTreeG[Item])(t).Clear(addNodesToFreelist) -} diff --git a/third_party/forked/golang/btree/btree_generic_test.go b/third_party/forked/golang/btree/btree_test.go similarity index 83% rename from third_party/forked/golang/btree/btree_generic_test.go rename to third_party/forked/golang/btree/btree_test.go index 1b58a39a..396aac15 100644 --- a/third_party/forked/golang/btree/btree_generic_test.go +++ b/third_party/forked/golang/btree/btree_test.go @@ -1,4 +1,8 @@ // Copyright 2014-2022 Google Inc. +// Copyright 2025 The Kubernetes Authors. +// +// This file is derived from github.com/google/btree and has been +// modified for use in the Kubernetes util package. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,12 +16,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -//go:build go1.18 -// +build go1.18 - package btree import ( + "flag" "fmt" "math/rand" "reflect" @@ -38,7 +40,7 @@ func intRange(s int, reverse bool) []int { return out } -func intAll(t *BTreeG[int]) (out []int) { +func intAll(t *BTree[int]) (out []int) { t.Ascend(func(a int) bool { out = append(out, a) return true @@ -46,7 +48,7 @@ func intAll(t *BTreeG[int]) (out []int) { return } -func intAllRev(t *BTreeG[int]) (out []int) { +func intAllRev(t *BTree[int]) (out []int) { t.Descend(func(a int) bool { out = append(out, a) return true @@ -54,8 +56,10 @@ func intAllRev(t *BTreeG[int]) (out []int) { return } -func TestBTreeG(t *testing.T) { - tr := NewOrderedG[int](*btreeDegree) +var btreeDegree = flag.Int("degree", 32, "B-Tree degree") + +func TestBTree(t *testing.T) { + tr := NewOrdered[int](*btreeDegree) const treeSize = 10000 for i := 0; i < 10; i++ { if min, ok := tr.Min(); ok || min != 0 { @@ -108,8 +112,8 @@ func TestBTreeG(t *testing.T) { } } -func ExampleBTreeG() { - tr := NewOrderedG[int](*btreeDegree) +func ExampleBTree() { + tr := NewOrdered[int](*btreeDegree) for i := 0; i < 10; i++ { tr.ReplaceOrInsert(i) } @@ -150,8 +154,8 @@ func ExampleBTreeG() { // len: 8 } -func TestDeleteMinG(t *testing.T) { - tr := NewOrderedG[int](3) +func TestDeleteMin(t *testing.T) { + tr := NewOrdered[int](3) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -164,8 +168,8 @@ func TestDeleteMinG(t *testing.T) { } } -func TestDeleteMaxG(t *testing.T) { - tr := NewOrderedG[int](3) +func TestDeleteMax(t *testing.T) { + tr := NewOrdered[int](3) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -178,8 +182,8 @@ func TestDeleteMaxG(t *testing.T) { } } -func TestAscendRangeG(t *testing.T) { - tr := NewOrderedG[int](2) +func TestAscendRange(t *testing.T) { + tr := NewOrdered[int](2) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -204,8 +208,8 @@ func TestAscendRangeG(t *testing.T) { } } -func TestDescendRangeG(t *testing.T) { - tr := NewOrderedG[int](2) +func TestDescendRange(t *testing.T) { + tr := NewOrdered[int](2) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -230,8 +234,8 @@ func TestDescendRangeG(t *testing.T) { } } -func TestAscendLessThanG(t *testing.T) { - tr := NewOrderedG[int](*btreeDegree) +func TestAscendLessThan(t *testing.T) { + tr := NewOrdered[int](*btreeDegree) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -256,8 +260,8 @@ func TestAscendLessThanG(t *testing.T) { } } -func TestDescendLessOrEqualG(t *testing.T) { - tr := NewOrderedG[int](*btreeDegree) +func TestDescendLessOrEqual(t *testing.T) { + tr := NewOrdered[int](*btreeDegree) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -282,8 +286,8 @@ func TestDescendLessOrEqualG(t *testing.T) { } } -func TestAscendGreaterOrEqualG(t *testing.T) { - tr := NewOrderedG[int](*btreeDegree) +func TestAscendGreaterOrEqual(t *testing.T) { + tr := NewOrdered[int](*btreeDegree) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -308,8 +312,8 @@ func TestAscendGreaterOrEqualG(t *testing.T) { } } -func TestDescendGreaterThanG(t *testing.T) { - tr := NewOrderedG[int](*btreeDegree) +func TestDescendGreaterThan(t *testing.T) { + tr := NewOrdered[int](*btreeDegree) for _, v := range rand.Perm(100) { tr.ReplaceOrInsert(v) } @@ -334,13 +338,15 @@ func TestDescendGreaterThanG(t *testing.T) { } } -func BenchmarkInsertG(b *testing.B) { +const benchmarkTreeSize = 10000 + +func BenchmarkInsert(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) b.StartTimer() i := 0 for i < b.N { - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, item := range insertP { tr.ReplaceOrInsert(item) i++ @@ -351,25 +357,25 @@ func BenchmarkInsertG(b *testing.B) { } } -func BenchmarkSeekG(b *testing.B) { +func BenchmarkSeek(b *testing.B) { b.StopTimer() size := 100000 insertP := rand.Perm(size) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, item := range insertP { tr.ReplaceOrInsert(item) } b.StartTimer() for i := 0; i < b.N; i++ { - tr.AscendGreaterOrEqual(i%size, func(i int) bool { return false }) + tr.AscendGreaterOrEqual(i%size, func(_ int) bool { return false }) } } -func BenchmarkDeleteInsertG(b *testing.B) { +func BenchmarkDeleteInsert(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, item := range insertP { tr.ReplaceOrInsert(item) } @@ -380,10 +386,10 @@ func BenchmarkDeleteInsertG(b *testing.B) { } } -func BenchmarkDeleteInsertCloneOnceG(b *testing.B) { +func BenchmarkDeleteInsertCloneOnce(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, item := range insertP { tr.ReplaceOrInsert(item) } @@ -395,10 +401,10 @@ func BenchmarkDeleteInsertCloneOnceG(b *testing.B) { } } -func BenchmarkDeleteInsertCloneEachTimeG(b *testing.B) { +func BenchmarkDeleteInsertCloneEachTime(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, item := range insertP { tr.ReplaceOrInsert(item) } @@ -410,7 +416,7 @@ func BenchmarkDeleteInsertCloneEachTimeG(b *testing.B) { } } -func BenchmarkDeleteG(b *testing.B) { +func BenchmarkDelete(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) removeP := rand.Perm(benchmarkTreeSize) @@ -418,7 +424,7 @@ func BenchmarkDeleteG(b *testing.B) { i := 0 for i < b.N { b.StopTimer() - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range insertP { tr.ReplaceOrInsert(v) } @@ -436,7 +442,7 @@ func BenchmarkDeleteG(b *testing.B) { } } -func BenchmarkGetG(b *testing.B) { +func BenchmarkGet(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) removeP := rand.Perm(benchmarkTreeSize) @@ -444,7 +450,7 @@ func BenchmarkGetG(b *testing.B) { i := 0 for i < b.N { b.StopTimer() - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range insertP { tr.ReplaceOrInsert(v) } @@ -459,7 +465,7 @@ func BenchmarkGetG(b *testing.B) { } } -func BenchmarkGetCloneEachTimeG(b *testing.B) { +func BenchmarkGetCloneEachTime(b *testing.B) { b.StopTimer() insertP := rand.Perm(benchmarkTreeSize) removeP := rand.Perm(benchmarkTreeSize) @@ -467,7 +473,7 @@ func BenchmarkGetCloneEachTimeG(b *testing.B) { i := 0 for i < b.N { b.StopTimer() - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range insertP { tr.ReplaceOrInsert(v) } @@ -483,9 +489,9 @@ func BenchmarkGetCloneEachTimeG(b *testing.B) { } } -func BenchmarkAscendG(b *testing.B) { +func BenchmarkAscend(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -503,9 +509,9 @@ func BenchmarkAscendG(b *testing.B) { } } -func BenchmarkDescendG(b *testing.B) { +func BenchmarkDescend(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -523,9 +529,9 @@ func BenchmarkDescendG(b *testing.B) { } } -func BenchmarkAscendRangeG(b *testing.B) { +func BenchmarkAscendRange(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -546,9 +552,9 @@ func BenchmarkAscendRangeG(b *testing.B) { } } -func BenchmarkDescendRangeG(b *testing.B) { +func BenchmarkDescendRange(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -569,9 +575,9 @@ func BenchmarkDescendRangeG(b *testing.B) { } } -func BenchmarkAscendGreaterOrEqualG(b *testing.B) { +func BenchmarkAscendGreaterOrEqual(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -597,9 +603,9 @@ func BenchmarkAscendGreaterOrEqualG(b *testing.B) { } } -func BenchmarkDescendLessOrEqualG(b *testing.B) { +func BenchmarkDescendLessOrEqual(b *testing.B) { arr := rand.Perm(benchmarkTreeSize) - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range arr { tr.ReplaceOrInsert(v) } @@ -625,7 +631,9 @@ func BenchmarkDescendLessOrEqualG(b *testing.B) { } } -func cloneTestG(t *testing.T, b *BTreeG[int], start int, p []int, wg *sync.WaitGroup, trees *[]*BTreeG[int], lock *sync.Mutex) { +const cloneTestSize = 10000 + +func cloneTest(t *testing.T, b *BTree[int], start int, p []int, wg *sync.WaitGroup, trees *[]*BTree[int], lock *sync.Mutex) { t.Logf("Starting new clone at %v", start) lock.Lock() *trees = append(*trees, b) @@ -634,19 +642,19 @@ func cloneTestG(t *testing.T, b *BTreeG[int], start int, p []int, wg *sync.WaitG b.ReplaceOrInsert(p[i]) if i%(cloneTestSize/5) == 0 { wg.Add(1) - go cloneTestG(t, b.Clone(), i+1, p, wg, trees, lock) + go cloneTest(t, b.Clone(), i+1, p, wg, trees, lock) } } wg.Done() } -func TestCloneConcurrentOperationsG(t *testing.T) { - b := NewOrderedG[int](*btreeDegree) - trees := []*BTreeG[int]{} +func TestCloneConcurrentOperations(t *testing.T) { + b := NewOrdered[int](*btreeDegree) + trees := []*BTree[int]{} p := rand.Perm(cloneTestSize) var wg sync.WaitGroup wg.Add(1) - go cloneTestG(t, b, 0, p, &wg, &trees, &sync.Mutex{}) + go cloneTest(t, b, 0, p, &wg, &trees, &sync.Mutex{}) wg.Wait() want := intRange(cloneTestSize, false) t.Logf("Starting equality checks on %d trees", len(trees)) @@ -682,12 +690,12 @@ func TestCloneConcurrentOperationsG(t *testing.T) { } } -func BenchmarkDeleteAndRestoreG(b *testing.B) { +func BenchmarkDeleteAndRestore(b *testing.B) { items := rand.Perm(16392) b.ResetTimer() b.Run(`CopyBigFreeList`, func(b *testing.B) { - fl := NewFreeListG[int](16392) - tr := NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + fl := NewFreeList[int](16392) + tr := NewWithFreeList[int](*btreeDegree, Less[int](), fl) for _, v := range items { tr.ReplaceOrInsert(v) } @@ -703,14 +711,14 @@ func BenchmarkDeleteAndRestoreG(b *testing.B) { tr.Delete(del) } // tr is now empty, we make a new empty copy of it. - tr = NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + tr = NewWithFreeList[int](*btreeDegree, Less[int](), fl) for _, v := range items { tr.ReplaceOrInsert(v) } } }) b.Run(`Copy`, func(b *testing.B) { - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range items { tr.ReplaceOrInsert(v) } @@ -726,15 +734,15 @@ func BenchmarkDeleteAndRestoreG(b *testing.B) { tr.Delete(del) } // tr is now empty, we make a new empty copy of it. - tr = NewOrderedG[int](*btreeDegree) + tr = NewOrdered[int](*btreeDegree) for _, v := range items { tr.ReplaceOrInsert(v) } } }) b.Run(`ClearBigFreelist`, func(b *testing.B) { - fl := NewFreeListG[int](16392) - tr := NewWithFreeListG[int](*btreeDegree, Less[int](), fl) + fl := NewFreeList[int](16392) + tr := NewWithFreeList[int](*btreeDegree, Less[int](), fl) for _, v := range items { tr.ReplaceOrInsert(v) } @@ -748,7 +756,7 @@ func BenchmarkDeleteAndRestoreG(b *testing.B) { } }) b.Run(`Clear`, func(b *testing.B) { - tr := NewOrderedG[int](*btreeDegree) + tr := NewOrdered[int](*btreeDegree) for _, v := range items { tr.ReplaceOrInsert(v) }