Add README

Author: mtfishman

NDTensors/src/NamedDimsArrays/README.md

@@ -0,0 +1,36 @@
+# NamedDimsArrays.jl
+
+````julia
+using NDTensors.NamedDimsArrays: align, dimnames, named, unname
+using NDTensors.TensorAlgebra: TensorAlgebra
+
+# Named dimensions
+i = named(2, "i")
+j = named(2, "j")
+k = named(2, "k")
+
+# Arrays with named dimensions
+na1 = randn(i, j)
+na2 = randn(j, k)
+
+@show dimnames(na1) == ("i", "j")
+
+# Indexing
+@show na1[j => 2, i => 1] == na1[1, 2]
+
+# Tensor contraction
+na_dest = TensorAlgebra.contract(na1, na2)
+
+@show issetequal(dimnames(na_dest), ("i", "k"))
+# `unname` removes the names and returns an `Array`
+@show unname(na_dest, (i, k)) ≈ unname(na1) * unname(na2)
+
+# Permute dimensions (like `ITensors.permute`)
+na1 = align(na1, (j, i))
+@show na1[i => 1, j => 2] == na1[2, 1]
+````
+
+---
+
+*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*
+

NDTensors/src/NamedDimsArrays/examples/example_readme.jl

@@ -0,0 +1,29 @@
+# # NamedDimsArrays.jl
+
+using NDTensors.NamedDimsArrays: align, dimnames, named, unname
+using NDTensors.TensorAlgebra: TensorAlgebra
+
+## Named dimensions
+i = named(2, "i")
+j = named(2, "j")
+k = named(2, "k")
+
+## Arrays with named dimensions
+na1 = randn(i, j)
+na2 = randn(j, k)
+
+@show dimnames(na1) == ("i", "j")
+
+## Indexing
+@show na1[j => 2, i => 1] == na1[1, 2]
+
+## Tensor contraction
+na_dest = TensorAlgebra.contract(na1, na2)
+
+@show issetequal(dimnames(na_dest), ("i", "k"))
+## `unname` removes the names and returns an `Array`
+@show unname(na_dest, (i, k)) ≈ unname(na1) * unname(na2)
+
+## Permute dimensions (like `ITensors.permute`)
+na1 = align(na1, (j, i))
+@show na1[i => 1, j => 2] == na1[2, 1]

NDTensors/src/NamedDimsArrays/ext/NamedDimsArraysTensorAlgebraExt/test/runtests.jl

@@ -9,5 +9,5 @@ using NDTensors.TensorAlgebra: TensorAlgebra
   na1 = randn(i, j)
   na2 = randn(j, k)
   na_dest = TensorAlgebra.contract(na1, na2)
-  @test unname(na_dest, (i, k)) == unname(na1) * unname(na2)
+  @test unname(na_dest, (i, k)) ≈ unname(na1) * unname(na2)
 end

NDTensors/src/NamedDimsArrays/generate_readme.jl

@@ -0,0 +1,10 @@
+using Literate
+using NDTensors.NamedDimsArrays: NamedDimsArrays
+Literate.markdown(
+  joinpath(
+    pkgdir(NamedDimsArrays), "src", "NamedDimsArrays", "examples", "example_readme.jl"
+  ),
+  joinpath(pkgdir(NamedDimsArrays), "src", "NamedDimsArrays");
+  flavor=Literate.CommonMarkFlavor(),
+  name="README",
+)