Merge pull request #4829 from 9il/ndslicechangelog

Ndslice changlog, tables update, note about Mir

Author: WalterBright

changelog.dd

@@ -20,10 +20,20 @@ $(BUGSTITLE Library Changes,
     $(LI $(RELATIVE_LINK2 optimization, `findLocalMin` was added to `std.numeric`.))
     $(LI $(RELATIVE_LINK2 slice_ptr, `ptr` property and public constructor were
         added to `std.experimental.ndslice.slice.Slice`.))
+    $(LI $(RELATIVE_LINK2 slice_toHash, `toHash` method was
+        added to `std.experimental.ndslice.slice.Slice`.))
     $(LI $(RELATIVE_LINK2 slice_alloc, `slice`, `shape`, `ndarray`, and other
         utilities were added to `std.experimental.ndslice.slice`.))
+    $(LI $(RELATIVE_LINK2 slice_as, `as` lazy tensor was added to
+        `std.experimental.ndslice.slice`.))
     $(LI $(RELATIVE_LINK2 slice_iota, `iotaSlice` lazy tensor was added to
         `std.experimental.ndslice.selection`.))
+    $(LI $(RELATIVE_LINK2 slice_index, `indexSlice` lazy tensor was added to
+        `std.experimental.ndslice.selection`.))
+    $(LI $(RELATIVE_LINK2 slice_repeat, `repeatSlice` lazy tensor was added to
+        `std.experimental.ndslice.selection`.))
+    $(LI $(RELATIVE_LINK2 slice_map, `mapSlice` lazy tensor was added to
+        `std.experimental.ndslice.selection`.))
     $(LI $(RELATIVE_LINK2 slice_mio, partial support for Math Index Order
         was added to `std.experimental.ndslice.slice.Slice`.))
     $(LI $(RELATIVE_LINK2 mutation, `std.algorithm.mutation.swapAt` was
@@ -183,16 +193,30 @@ $(LI $(LNAME2 slice_ptr, `ptr` property and public constructor were added to
     )
 )
 
+$(LI $(LNAME2 slice_toHash, $(P $(REF .Slice.toHash, std,experimental,ndslice,slice) method was added.)
+---
+import std.experimental.ndslice;
+
+// hash is the same for allocated data and generated data
+auto a = iotaSlice(3, 7);
+auto b = iotaSlice(3, 7).slice;
+
+assert(a.toHash == b.toHash);
+---
+)
+
 $(LI $(LNAME2 slice_alloc, `slice`, `shape`, `ndarray`, and other utilities
     were added to `std.experimental.ndslice.slice`.)
     $(P These utility functions have been added to
         $(MREF std,experimental,ndslice):)
     $(UL
+        $(LI $(REF makeNdarray, std,experimental,ndslice,slice),)
+        $(LI $(REF makeSlice, std,experimental,ndslice,slice),)
+        $(LI $(REF makeUninitializedSlice, std,experimental,ndslice,slice),)
+        $(LI $(REF ndarray, std,experimental,ndslice,slice),)
         $(LI $(REF shape, std,experimental,ndslice,slice),)
         $(LI $(REF slice, std,experimental,ndslice,slice),)
-        $(LI $(REF makeSlice, std,experimental,ndslice,slice),)
-        $(LI $(REF ndarray, std,experimental,ndslice,slice), and)
-        $(LI $(REF makeNdarray, std,experimental,ndslice,slice).)
+        $(LI $(REF uninitializedSlice, std,experimental,ndslice,slice).)
     )
     $(P Example: Transposing common 2D array using `ndslice`)
 -----
@@ -209,6 +233,24 @@ assert(ar == [[0, 3], [1, 4], [2, 5]]);
 -----
 )
 
+$(LI $(LNAME2 slice_as, $(P $(REF as, std,experimental,ndslice,slice)
+    lazy tensor was added.)
+---
+import std.experimental.ndslice;
+
+auto matrix = slice!double([2, 2], 0);
+auto stringMatrixView = matrix.as!string;
+assert(stringMatrixView ==
+        [["0", "0"],
+         ["0", "0"]]);
+
+matrix.diagonal[] = 1;
+assert(stringMatrixView ==
+        [["1", "0"],
+         ["0", "1"]]);
+---
+)
+
 $(LI $(LNAME2 slice_iota, `iotaSlice` lazy tensor was added to `std.experimental.ndslice.selection`.)
     $(P $(REF iotaSlice, std,experimental,ndslice,selection) is the fastest possible `Slice`.)
 ---
@@ -222,6 +264,46 @@ assert(sl.transposed == [[10, 13],
 ---
 )
 
+$(LI $(LNAME2 slice_index, $(P $(REF indexSlice, std,experimental,ndslice,selection)
+    lazy tensor was added.)
+---
+import std.experimental.ndslice;
+
+auto slice = indexSlice(2, 3);
+
+assert(slice == [[[0, 0], [0, 1], [0, 2]],
+                 [[1, 0], [1, 1], [1, 2]]]);
+---
+)
+
+$(LI $(LNAME2 slice_repeat, $(P $(REF repeatSlice, std,experimental,ndslice,selection)
+    lazy tensor was added.)
+---
+import std.experimental.ndslice;
+
+auto sl = iotaSlice(3).repeatSlice(4);
+assert(sl == [[0, 1, 2],
+              [0, 1, 2],
+              [0, 1, 2],
+              [0, 1, 2]]);
+
+auto m = 4.repeatSlice(2, 3);
+assert(m == [[4, 4, 4],
+             [4, 4, 4]]);
+---
+)
+
+$(LI $(LNAME2 slice_map, $(P $(REF mapSlice, std,experimental,ndslice,selection)
+    lazy tensor was added.)
+---
+import std.experimental.ndslice;
+
+auto s = iotaSlice(2, 3).mapSlice!(a => a * a);
+assert(s == [[ 0,  1,  4],
+             [ 9, 16, 25]]);
+---
+)
+
 $(LI $(LNAME2 slice_mio, partial support for Math Index Order was added to `std.experimental.ndslice.slice.Slice`.)
 ---
 import std.experimental.ndslice;

std/experimental/ndslice/package.d

@@ -50,6 +50,10 @@ processing algorithms, but should also be general enough for use anywhere with
 homogeneously-typed multidimensional data.
 In addition, it includes various functions for iteration, accessing, and manipulation.
 
+Advanced and fast iteration algorithms, matrix multiplication, and BLAS-like functions
+can be found in the $(LINK2 http://mir.dlang.io, Mir
+LLVM-Accelerated Generic Numerical Library for Science and Machine Learning).
+
 Quick_Start:
 $(SUBREF slice, sliced) is a function designed to create
 a multidimensional view over a range.
@@ -80,30 +84,32 @@ $(TR $(TH Submodule) $(TH Declarations))
 $(TR $(TDNW $(SUBMODULE slice)
         $(BR) $(SMALL $(SUBREF slice, Slice), its properties, operator overloading))
      $(TD
-        $(SUBREF slice, sliced)
-        $(SUBREF slice, Slice)
-        $(SUBREF slice, slice)
+        $(SUBREF slice, as)
+        $(SUBREF slice, assumeSameStructure)
+        $(SUBREF slice, DeepElementType)
+        $(SUBREF slice, makeNdarray)
         $(SUBREF slice, makeSlice)
+        $(SUBREF slice, makeUninitializedSlice)
         $(SUBREF slice, ndarray)
-        $(SUBREF slice, makeNdarray)
+        $(SUBREF slice, ReplaceArrayWithPointer)
         $(SUBREF slice, shape)
         $(SUBREF slice, Slice)
-        $(SUBREF slice, assumeSameStructure)
-        $(SUBREF slice, ReplaceArrayWithPointer)
-        $(SUBREF slice, DeepElementType)
+        $(SUBREF slice, slice)
+        $(SUBREF slice, sliced)
         $(SUBREF slice, SliceException)
+        $(SUBREF slice, uninitializedSlice)
     )
 )
 $(TR $(TDNW $(SUBMODULE iteration)
         $(BR) $(SMALL Basic iteration operators))
      $(TD
-        $(SUBREF iteration, transposed)
-        $(SUBREF iteration, strided)
+        $(SUBREF iteration, allReversed)
+        $(SUBREF iteration, everted)
         $(SUBREF iteration, reversed)
         $(SUBREF iteration, rotated)
-        $(SUBREF iteration, everted)
+        $(SUBREF iteration, strided)
         $(SUBREF iteration, swapped)
-        $(SUBREF iteration, allReversed)
+        $(SUBREF iteration, transposed)
         $(SUBREF iteration, dropToHypercube) and other `drop` primitives
     )
 )
@@ -112,19 +118,19 @@ $(TR $(TDNW $(SUBMODULE selection)
         $(BR) $(SMALL Subspace manipulations $(BR) Operators for loop free programming))
      $(TD
         $(SUBREF selection, blocks)
-        $(SUBREF selection, windows)
-        $(SUBREF selection, diagonal)
-        $(SUBREF selection, reshape)
         $(SUBREF selection, byElement)
         $(SUBREF selection, byElementInStandardSimplex)
-        $(SUBREF selection, mapSlice)
+        $(SUBREF selection, diagonal)
+        $(SUBREF selection, evertPack)
         $(SUBREF selection, indexSlice)
         $(SUBREF selection, iotaSlice)
-        $(SUBREF selection, repeatSlice)
+        $(SUBREF selection, mapSlice)
         $(SUBREF selection, pack)
-        $(SUBREF selection, evertPack)
-        $(SUBREF selection, unpack)
+        $(SUBREF selection, repeatSlice)
+        $(SUBREF selection, reshape)
         $(SUBREF selection, ReshapeException)
+        $(SUBREF selection, unpack)
+        $(SUBREF selection, windows)
     )
 )
 ))

std/experimental/ndslice/selection.d

@@ -27,16 +27,17 @@ $(T2 evertPack, reverses dimension packs)
 $(BOOKTABLE $(H2 Selectors),
 
 $(TR $(TH Function Name) $(TH Description))
+$(T2 blocks, n-dimensional slice composed of n-dimensional non-overlapping blocks.
+    If the slice has two dimensions, it is a block matrix.)
 $(T2 byElement, flat, random access range of all elements with `index` property)
 $(T2 byElementInStandardSimplex, an input range of all elements in standard simplex of hypercube with `index` property.
     If the slice has two dimensions, it is a range of all elements of upper left triangular matrix.)
+$(T2 diagonal, 1-dimensional slice composed of diagonal elements)
 $(T2 indexSlice, lazy slice with initial multidimensional index)
 $(T2 iotaSlice, lazy slice with initial flattened (continuous) index)
+$(T2 mapSlice, lazy multidimensional functional map)
 $(T2 repeatSlice, slice with identical values)
 $(T2 reshape, new slice with changed dimensions for the same data)
-$(T2 diagonal, 1-dimensional slice composed of diagonal elements)
-$(T2 blocks, n-dimensional slice composed of n-dimensional non-overlapping blocks.
-    If the slice has two dimensions, it is a block matrix.)
 $(T2 windows, n-dimensional slice of n-dimensional overlapping windows.
     If the slice has two dimensions, it is a sliding window.)
 )