aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar Peter McGoron 2025-01-16 19:40:06 -0500
committerGravatar Peter McGoron 2025-01-16 19:40:06 -0500
commit0d5d0f16c5b4c969e01a0ec27954b69a967c4970 (patch)
tree3a74a912396ed03b1ab3d74947dc394b0bea9355 /doc
parentsuccesfully test join (diff)
rename module to internal
Diffstat (limited to '')
-rw-r--r--doc/mcgoron.weight-balanced-trees.internal.scm (renamed from doc/mcgoron.weight-balanced-trees.scm)16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/mcgoron.weight-balanced-trees.scm b/doc/mcgoron.weight-balanced-trees.internal.scm
index 0bebb3d..5812d72 100644
--- a/doc/mcgoron.weight-balanced-trees.scm
+++ b/doc/mcgoron.weight-balanced-trees.internal.scm
@@ -31,4 +31,18 @@ Returns a weight-balanced tree where the elements of the tree are the
elements of `x`."))
((name . "node->in-order-list")
(signature lambda ((wb-tree-node? x)) => list?)
- (desc "Returns a list of all elements of `x` in order."))) \ No newline at end of file
+ (desc "Returns a list of all elements of `x` in order."))
+ ((name . "join")
+ (signature lambda (data (wb-tree-node? left) (wb-tree-node? right))
+ => non-null-wb-tree-node?)
+ (desc "
+* It is an error if `left` or `right` are not balanced.
+* It is an error if any element of `left` is greater than or equal to
+ any element in `right`.
+* It is an error if `data` is less than or equal to any element in
+ `left`.
+* It is an error if `data` is greater than or equal to any element in
+ `right`.
+
+Returns a balanced tree containing all elements of `left` and `right`
+with `data`."))) \ No newline at end of file