[!NOTE]
This is one of 189 standalone projects, maintained as part
of the @thi.ng/umbrella monorepo
and anti-framework.
🚀 Help me to work full-time on these projects by sponsoring me on
GitHub. Thank you! ❤️
About
Functional tree editing, manipulation & navigation.
Immutable, semi-functional, structural tree editing, manipulation &
navigation, based on my fork and optimizations to
fast-zip, which in turn
is based on
clojure.zip
and which itself is based on the original data structure invented by
Gérard Huet in 1997.
Reference: https://en.wikipedia.org/wiki/Zipper_(data_structure)
Status
STABLE - used in production
Search or submit any issues for this package
Related packages
- @thi.ng/gp - Genetic programming helpers & strategies (tree based & multi-expression programming)
Blog posts
Installation
yarn add @thi.ng/zipper
ES module import:
<script type="module" src="https://cdn.skypack.dev/@thi.ng/zipper"></script>
Skypack documentation
For Node.js REPL:
const zipper = await import("@thi.ng/zipper");
Package sizes (brotli'd, pre-treeshake): ESM: 1.02 KB
Dependencies
API
Generated API docs
import { arrayZipper } from "@thi.ng/zipper";
const x = [1, [5, 4, 3, 2], 6];
const a = arrayZipper(x);
a.next.node
a.next.next.node
a.next.next.down.rightmost.node
a.next.next.down.rightmost.left.remove().up.up.appendChild(7).root
a.appendChild(7).next.next.down.rightmost.left.remove().root
a.next.next.insertChild(10).root
a.next.next.replace(10).root
x
Benchmark
For better comparison, the included benchmarks are also ported from the
fast-zip package and
measure traversal & editing of a tree of 10 x 10 x 10 values.
Measurements for MBP 2015 2.8GHz, 16GB, node v12.10.0:
$ node bench/index.js
walk:
warmup... 2562ms
warmup... 2469ms
warmup... 2460ms
total: 2476ms, mean: 0.2476ms, runs: 10000
edit:
warmup... 4660ms
warmup... 4573ms
warmup... 4566ms
total: 4616ms, mean: 0.4616ms, runs: 10000
Authors
If this project contributes to an academic publication, please cite it as:
@misc{thing-zipper,
title = "@thi.ng/zipper",
author = "Karsten Schmidt",
note = "https://thi.ng/zipper",
year = 2015
}
License
© 2015 - 2024 Karsten Schmidt // Apache License 2.0