divorce/Ensifer
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doc/USAGE

Browse Source 
wording, bs trim
This commit is contained in:
divorce committed 2026-10-18 04:05:32 +00:00
1 parent 7e4a1bc013
commit f5012526d4
1 file changed
+7 -33
Download Patch File Download Diff File Expand all files Collapse all files
doc/USAGE
+7 -33
View File
@@ -92,7 +92,7 @@ at that key followed by the data beneath its child enfilade.
6. A KEY MAY HAVE BOTH A DATUM AND CHILDREN 6. A KEY MAY HAVE BOTH A DATUM AND CHILDREN
-------------------------------------------- --------------------------------------------
This is important. In cases where,
(enfilade-put-data e "1.2" 99) (enfilade-put-data e "1.2" 99)
(enfilade-put-data e "1.2.5" 50) (enfilade-put-data e "1.2.5" 50)
@@ -197,33 +197,7 @@ Subtract / difference:
These are the historical tumbler operations, not ordinary decimal-number These are the historical tumbler operations, not ordinary decimal-number
addition and subtraction. addition and subtraction.
11. WHY THIS MATTERS FOR ZIGZAG 11. THE C VERSION
-------------------------------
An enfilade does not need to understand what a datum means.
That is useful when the datum is a ZigZag cell pointer.
Conceptually:
cell ID
|
v
tumbler
|
v
enfilade
|
v
cell
The catalogue can therefore answer:
“What cell is stored at this ID?”
without embedding ZigZag cell structure into the indexing mechanism.
12. THE C VERSION
----------------- -----------------
Include: Include:
@@ -256,7 +230,7 @@ The important rule is therefore:
the enfilade owns its tree; the enfilade owns its tree;
the caller owns its datum. the caller owns its datum.
13. TUMBLER C API 12. TUMBLER C API
----------------- -----------------
Include: Include:
@@ -289,7 +263,7 @@ also release:
tumbler_free(&b); tumbler_free(&b);
tumbler_free(&out); tumbler_free(&out);
14. VALID TUMBLERS 13. VALID TUMBLERS
------------------ ------------------
The current C representation accepts one or more unsigned decimal fields: The current C representation accepts one or more unsigned decimal fields:
@@ -313,7 +287,7 @@ The zero field is legal. Historical Xanadu addressing uses zero fields as
delimiters in some larger address formats; this small enfilade does not assign delimiters in some larger address formats; this small enfilade does not assign
zero any additional structural meaning. zero any additional structural meaning.
15. ERRORS 14. ERRORS
---------- ----------
Malformed tumbler text: Malformed tumbler text:
@@ -336,7 +310,7 @@ Allocation failure:
-------------------------------------- --------------------------------------
You do not need CRUM, POOM, Granfilade, Spanfilade, WID, DISP, orgl, loaf, or You do not need CRUM, POOM, Granfilade, Spanfilade, WID, DISP, orgl, loaf, or
Green's virtual-memory machinery to use this object. Udanax Green's virtual-memory machinery to use this object.
Those names describe the larger historical system and specialized data Those names describe the larger historical system and specialized data
structures built around enfilades. They are important when implementing those structures built around enfilades. They are important when implementing those
@@ -347,7 +321,7 @@ The right mental model for this package is simply:
tumbler -> path through an enfilade -> datum(s) tumbler -> path through an enfilade -> datum(s)
17. REFERENCES 15. REFERENCES
-------------- --------------
Immediate behavioral reference: Immediate behavioral reference: