update docs

Author: 9il

doc/Makefile

@@ -25,17 +25,19 @@ ARTWORK_DIR=$(DOC_SOURCE_DIR)/artwork
 # Packages in mir. Just mention the package name here. The contents of package
 # xy/zz is in variable PACKAGE_xy_zz. This allows automation in iterating
 # packages and their modules.
-MIR_PACKAGES = mir mir/ndslice mir/ndslice/connect mir/internal mir/math mir/math/func mir/array mir/interpolate mir/graph
+MIR_PACKAGES = mir mir/ndslice mir/ndslice/connect mir/internal mir/math mir/math/func mir/array mir/interpolate mir/graph mir/combinatorics mir/container
 
 PACKAGE_mir = bitmanip conv functional primitives range series utility
 
 PACKAGE_mir_array = primitives
+PACKAGE_mir_combinatorics = package
+PACKAGE_mir_container = binaryheap
+PACKAGE_mir_graph = tarjan package
 PACKAGE_mir_internal = utility
 PACKAGE_mir_interpolate = package constant linear spline pchip utility
 PACKAGE_mir_math = constant common sum numeric package
 PACKAGE_mir_math_func = expdigamma
 PACKAGE_mir_ndslice_connect = cpp cpython
-PACKAGE_mir_graph = tarjan package
 
 PACKAGE_mir_ndslice = \
 	algorithm\

index.d

@@ -10,23 +10,11 @@ $(BOOKTABLE ,
         $(TH Modules)
         $(TH Description)
     )
+    $(LEADINGROW nd-arrays, algorithms)
+    $(TR $(TDNW $(MREF mir,ndslice)★) $(TD Package for vectors, matrixes, and nd-arrays, and iteration algorithms.))
     $(LEADINGROW Containers)
     $(TR $(TDNW $(MREF mir,series)★) $(TD Generic series suitable for time-series or semi-immutable ordered maps with CPU cache friendly binary search.))
-    $(LEADINGROW Algorithms constructors, multidimensional arrays, iterators)
-    $(TR $(TDNW $(MREF mir,ndslice)★) $(TD Package for vectors, matrixes, and nd-arrays))
-    $(TR $(TDNW $(MREF mir,ndslice,algorithm)★) $(TD Loop free programming: `each`, `reduce`, and friends))
-    $(TR $(TDNW $(MREF mir,ndslice,allocation)★) $(TD Allocation utilities))
-    $(TR $(TDNW $(MREF mir,ndslice,chunks)) $(TD `chunks` routine))
-    $(TR $(TDNW $(MREF mir,ndslice,concatenation)) $(TD Concatenation and padding))
-    $(TR $(TDNW $(MREF mir,ndslice,dynamic)) $(TD Dynamic dimension manipulators))
-    $(TR $(TDNW $(MREF mir,ndslice,field)) $(TD Field declarations))
-    $(TR $(TDNW $(MREF mir,ndslice,fuse)) $(TD Fuse (stack) utilities for rows, columns, and cells))
-    $(TR $(TDNW $(MREF mir,ndslice,iterator)) $(TD Iterator declarations))
-    $(TR $(TDNW $(MREF mir,ndslice,ndfield)) $(TD NdField declarations))
-    $(TR $(TDNW $(MREF mir,ndslice,slice)★) $(TD Slice structure, basic constructors))
-    $(TR $(TDNW $(MREF mir,ndslice,sorting)) $(TD Sorting utilities))
-    $(TR $(TDNW $(MREF mir,ndslice,topology)★) $(TD Advanced ndslice constructors (key module).))
-    $(TR $(TDNW $(MREF mir,ndslice,traits)) $(TD Multi-dimensional traits))
+    $(TR $(TDNW $(MREF mir,container,binaryheap)★) $(TD BetterC rework of `std.container.binaryheap`.))
     $(LEADINGROW Graphs)
     $(TR $(TDNW $(MREF mir,graph) WIP) $(TD Basic routines to work with graphs))
     $(TR $(TDNW $(MREF mir,graph,tarjan)★) $(TD Tarjan's strongly connected components algorithm))

source/mir/ndslice/concatenation.d

@@ -23,6 +23,8 @@ License:   $(HTTP boost.org/LICENSE_1_0.txt, Boost License 1.0).
 Copyright: Copyright © 2017-, Ilya Yaroshenko
 Authors:   Ilya Yaroshenko
 
+See_also: $(MODULE3 mir.ndslice.fuse)
+
 Macros:
 SUBREF = $(REF_ALTTEXT $(TT $2), $2, mir, ndslice, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))

source/mir/ndslice/fuse.d

@@ -7,6 +7,8 @@ License:   $(HTTP boost.org/LICENSE_1_0.txt, Boost License 1.0).
 Copyright: Copyright © 2018-, Ilya Yaroshenko
 Authors:   Ilya Yaroshenko
 
+See_also: $(MODULE3 mir.ndslice.concatenation)
+
 Macros:
 SUBREF = $(REF_ALTTEXT $(TT $2), $2, mir, ndslice, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))

source/mir/ndslice/package.d

@@ -183,6 +183,14 @@ $(TR $(TDNW $(SUBMODULE algorithm)
     )
 )
 
+$(TR $(TDNW $(SUBMODULE fuse)
+        $(BR) $(SMALL Fusing (stacking) of rows, columns, or cells into nd-slice.))
+     $(TD
+        $(SUBREF fuse, fuse)
+        $(SUBREF fuse, fuseCells)
+    )
+)
+
 $(TR $(TDNW $(SUBMODULE concatenation)
         $(BR) $(SMALL Concatenation, padding, and algorithms))
      $(TD

source/mir/series.d

@@ -1421,4 +1421,4 @@ private AARange _aaToRange(T: V[K], K, V)(ref T aa) pure nothrow @nogc @safe
     return _aaRange(() @trusted { return cast(void*)realAA; } ());
 }
 
-}
+}