@bablr/btree 0.2.0 → 0.3.1

package/README.md

@@ -1,13 +1,18 @@
 # @bablr/btree
 
-Functional utilities for working with btrees such as those used in agAST. These trees could also correctly be termed sum trees, and are represented as:
+Functional utilities for working with btrees such as those used in agAST.
 
 ```js
-let leafNode = [...data];
+expect(push(['a', 'b'], 'c')).toEqual([
+  3,
+  [['a'], ['b', 'c']],
+]);
 
-let branchNode = [sum, [...nodes]];
-
-let tree = [3, [[node1, node2], [node3]]];
+expect(addAt(0, [3, [['x'], ['y', 'z']]], 'w')).toEqual([
+  4,
+  [
+    ['w', 'x'],
+    ['y', 'z'],
+  ],
+]);
 ```
-
-You can differentiate non-leaf nodes because they have a number as their first element. This is possible the data stored in this tree will always be object-typed.

package/lib/enhanceable.js

@@ -13,7 +13,7 @@ export const buildModule = (
   finalizeSums,
 ) => {
   const sumNodes = (nodes) => {
-    return nodes.map(getSum).reduce((a, b) => a + b, 0);
+    return nodes.map(getSize).reduce((a, b) => a + b, 0);
   };
 
   const treeFrom = (...values) => {
@@ -52,14 +52,14 @@ export const buildModule = (
 
   const findBalancePoint = (values) => {
     let leftSum = 0;
-    let rightSum = values.reduce((sum, v) => sum + getSum(v), 0);
+    let rightSum = values.reduce((sum, v) => sum + getSize(v), 0);
     let balance = leftSum / rightSum;
 
     if (!values.length) return null;
     if (values.length === 1) return 1;
 
     for (let i = 1; i < values.length; i++) {
-      const sum = getSum(values[i - 1]);
+      const sum = getSize(values[i - 1]);
       const lastBalance = balance;
       leftSum += sum;
       rightSum -= sum;
@@ -163,7 +163,7 @@ export const buildModule = (
   };
 
   const push = (tree, value) => {
-    return addAt(getSum(tree), tree, value);
+    return addAt(getSize(tree), tree, value);
   };
 
   const collapses = (size) => {
@@ -224,7 +224,7 @@ export const buildModule = (
       }
 
       if (path.size === 1) {
-        if (isFinite(returnValue[0]) && getSum(returnValue) <= NODE_SIZE) {
+        if (isFinite(returnValue[0]) && getSize(returnValue) <= NODE_SIZE) {
           returnValue = returnValue[1].flat();
         }
         return returnValue;
@@ -261,6 +261,11 @@ export const buildModule = (
     return node ? (isArray(node) ? (isFinite(node[0]) ? node[1] : node) : [node]) : [];
   };
 
+  const getSums = (node) => {
+    if (!isValidNode(node)) throw new Error();
+    return node[2];
+  };
+
   const setValues = (node, values) => {
     if (values.length > NODE_SIZE) throw new Error();
 
@@ -300,7 +305,7 @@ export const buildModule = (
     }
   }
 
-  const getSum = (tree) => {
+  const getSize = (tree) => {
     if (tree == null) {
       return 0;
     } else if (!isArray(tree)) {
@@ -324,7 +329,7 @@ export const buildModule = (
 
     let path = emptyStack;
 
-    let treeSum = getSum(tree);
+    let treeSum = getSize(tree);
     let currentIdx = idx < 0 ? treeSum : 0;
     let direction = idx < 0 ? -1 : 1;
     let targetIdx = idx < 0 ? treeSum + idx : idx;
@@ -334,11 +339,11 @@ export const buildModule = (
       assertValidNode(node);
 
       if (isLeafNode(node)) {
-        const startIdx = idx < 0 ? currentIdx - getSum(node) : currentIdx;
+        const startIdx = idx < 0 ? currentIdx - getSize(node) : currentIdx;
         let index = isFinite(currentIdx) ? targetIdx - startIdx : currentIdx;
         if (index < 0) {
           index = -Infinity;
-        } else if (index >= getSum(node)) {
+        } else if (index >= getSize(node)) {
           index = Infinity;
         }
         return path.push({ index, node });
@@ -349,7 +354,7 @@ export const buildModule = (
 
         for (i of indexes(values.length, idx < 0)) {
           candidateNode = values[i];
-          const sum = getSum(candidateNode);
+          const sum = getSize(candidateNode);
           const nextCount = currentIdx + sum * direction;
           if (idx < 0 ? nextCount <= targetIdx : nextCount > targetIdx || nextCount >= treeSum) {
             path = path.push({ index: i, node });
@@ -373,9 +378,9 @@ export const buildModule = (
   const replaceAt = (idx, tree, value) => {
     let path = findPath(idx, tree);
 
-    if (getSum(tree) < idx) {
+    if (getSize(tree) < idx) {
       throw new Error('Cannot add past the end of a list');
-    } else if (getSum(tree) === idx) {
+    } else if (getSize(tree) === idx) {
       return addAt(idx, tree, value);
     }
 
@@ -412,10 +417,11 @@ export const buildModule = (
     isValidNode,
     assertValidNode,
     getValues,
+    getSums,
     setValues,
     isLeafNode,
     traverse,
-    getSum,
+    getSize,
     findPath,
     getAt,
     replaceAt,

package/lib/index.js

@@ -1,7 +1,8 @@
-import { buildModule } from './enhanceable.js';
+import { defaultNodeSize, buildModule } from './enhanceable.js';
+
+export { defaultNodeSize };
 
 export const {
-  defaultNodeSize,
   treeFromValues,
   findBalancePoint,
   splitValues,
@@ -14,10 +15,11 @@ export const {
   isValidNode,
   assertValidNode,
   getValues,
+  getSums,
   setValues,
   isLeafNode,
   traverse,
-  getSum,
+  getSize,
   findPath,
   getAt,
   replaceAt,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bablr/btree",
   "description": "Functional utilities for working with btrees such as those used in agAST",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "author": "Conrad Buck<conartist6@gmail.com>",
   "type": "module",
   "files": [