aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Smeding <tom@tomsmeding.com>2024-03-26 23:58:05 +0100
committerTom Smeding <tom@tomsmeding.com>2024-03-26 23:58:05 +0100
commit9c98118e0a0ff9be463bc9e7afe4253a4de3d433 (patch)
treeb113198f291680aeaf94f9183a3676f0b59e34a3
parent4918bbe4c5b560917c3cb53619838ead1ea53b9e (diff)
Add readme
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..81a71f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+Wrapper library around `orthotope` that defines nested arrays, including
+tuples, of (eventually) unboxed values. The arrays are represented in
+struct-of-arrays form via the `Data.Vector.Unboxed` data family trick. Below
+the surface layer, there is a more low-level wrapper around `orthotope` that
+defines an array type type-indexed by `[Maybe Nat]`: some dimensions are
+shape-typed (i.e. have their size statically known), and some not.