add mir.ndslice.fuse and a a huge work on qualifier propagation (#127)

* add mir.qualifier

* ditto

* add mir.qualifier

* ditto

* fix few bugs

* update join

* prepare docs

* fix bugs

* fix optmath

* add import

* fix makefile

* ditto

* ditto

* fix docs

* add fuse instead of join, improve API with fused slices, optimize ndslice.algorithm, fix few minor bugs

* Update spline.d

* Update spline.d

* Update pchip.d

Author: 9il

doc/Makefile

@@ -25,7 +25,7 @@ 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_PACKAGES = mir mir/ndslice mir/ndslice/connect mir/internal mir/math mir/math/func mir/array mir/interpolate mir/graph
 
 PACKAGE_mir = bitmanip conv functional primitives range series utility
 
@@ -35,6 +35,7 @@ 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\
@@ -44,6 +45,7 @@ PACKAGE_mir_ndslice = \
 	dynamic\
 	field\
 	iterator\
+	fuse\
 	mutation\
 	ndfield\
 	package\

index.d

@@ -10,6 +10,8 @@ $(BOOKTABLE ,
         $(TH Modules)
         $(TH Description)
     )
+    $(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))
@@ -18,19 +20,21 @@ $(BOOKTABLE ,
     $(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))
+    $(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))
+    $(LEADINGROW Interpolation)
+    $(TR $(TDNW $(MREF mir,interpolate)★) $(TD Interpolation algorithms))
     $(LEADINGROW Interconnection with other languages)
     $(TR $(TDNW $(MREF mir,ndslice,connect,cpp)) $(TD Definitions suitable for `extern(C++)` functions))
     $(TR $(TDNW $(MREF mir,ndslice,connect,cpython)) $(TD Utilities for $(HTTPS docs.python.org/3/c-api/buffer.html, Python Buffer Protocol)))
-    $(LEADINGROW Data structures, finance)
-    $(TR $(TDNW $(MREF mir,series)★) $(TD Generic series suitable for time-series or semi-immutable ordered maps with CPU cache friendly binary search.))
-    $(LEADINGROW Interpolation)
-    $(TR $(TDNW $(MREF mir,interpolate)★) $(TD Interpolation algorithms))
     $(LEADINGROW Math)
     $(TR $(TDNW $(MREF mir,math)) $(TD Package))
     $(TR $(TDNW $(MREF mir,math,common)★) $(TD Common math functions and fp-math compiler optimization attributes))

source/mir/functional.d

@@ -708,6 +708,21 @@ struct AliasCall(T, string methodName, TemplateArgs...)
 {
     T __this;
     alias __this this;
+
+    ///
+    auto lightConst()() const @property
+    {
+        import mir.qualifier;
+        return AliasCall!(LightConstOf!T, methodName, TemplateArgs)(__this.lightConst);
+    }
+
+    ///
+    auto lightImmutable()() immutable @property
+    {
+        import mir.qualifier;
+        return AliasCall!(LightImmutableOf!T, methodName, TemplateArgs)(__this.lightImmutable);
+    }
+
     this()(auto ref T value)
     {
         __this = value;
@@ -752,6 +767,8 @@ template aliasCall(string methodName, TemplateArgs...)
 
     static struct S
     {
+        auto lightConst()() const @property { return S(); }
+
         auto fun(size_t ct_param = 1)(size_t rt_param)
         {
             return rt_param + ct_param;

source/mir/graph/utility.d renamed to source/mir/graph/package.d

@@ -1,4 +1,6 @@
 /++
+Basic routines to work with graphs.
+
 License:   $(HTTP boost.org/LICENSE_1_0.txt, Boost License 1.0).
 Copyright: Copyright © 2018-, Kaleidic Associates Advisory Limited
 Authors:   Ilya Yaroshenko
@@ -8,7 +10,11 @@ SUBREF = $(REF_ALTTEXT $(TT $2), $2, mir, graph, $1)$(NBSP)
 T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 +/
 
-module mir.graph.utility;
+module mir.graph;
+
+import mir.math.common: optmath;
+
+@optmath:
 
 import mir.series;
 

source/mir/graph/tarjan.d

@@ -1,4 +1,6 @@
 /++
+This is a submodule of $(MREF mir,graph).
+
 Tarjan's strongly connected components algorithm.
 
 License:   $(HTTP boost.org/LICENSE_1_0.txt, Boost License 1.0).
@@ -14,6 +16,11 @@ module mir.graph.tarjan;
 
 import std.traits;
 
+import mir.math.common: optmath;
+
+@optmath:
+
+
 /++
 Classic Tarjan's strongly connected components algorithm.
 
@@ -217,7 +224,8 @@ auto tarjan(G, I = Unqual!(ForeachType!(ForeachType!G)))(G graph)
 +/
 pure version(mir_test) unittest
 {
-    import mir.graph.utility;
+    import mir.graph;
+    import mir.graph.tarjan;
 
     GraphSeries!(string, uint) gs = [
         "00": ["01"],
@@ -249,7 +257,8 @@ Tests that the graph `0 -> 1 -> 2 -> 3 -> 4` returns 4 components.
 +/
 pure version(mir_test) unittest
 {
-    import mir.graph.utility;
+    import mir.graph;
+    import mir.graph.tarjan;
 
     GraphSeries!(char, uint) gs = [
         'a': ['b'],
@@ -268,13 +277,14 @@ pure version(mir_test) unittest
 ----
  0 <- 2 <-- 5 <--> 6
  |  ^ ^ ^___       
- v /  |     \     /\ 
+ v_|  |     |      _ 
  1 <- 3 <-> 4 <-- 7_|
 ----
 +/
 pure version(mir_test) unittest
 {
-    import mir.graph.utility;
+    import mir.graph;
+    import mir.graph.tarjan;
 
     auto gs = [
         0: [1],
@@ -300,14 +310,15 @@ pure version(mir_test) unittest
 /++
 -----
  2 <-> 1
- \    ^
-  v /
-   0
+ |    ^
+ v_0 /
+   
 -----
 +/
 pure version(mir_test) unittest
 {
-    import mir.graph.utility;
+    import mir.graph;
+    import mir.graph.tarjan;
 
     auto gs = [
         0: [1],
@@ -331,7 +342,8 @@ not when they were actually removed from the stack
 +/
 pure version(mir_test) unittest
 {
-    import mir.graph.utility;
+    import mir.graph;
+    import mir.graph.tarjan;
 
     auto root = 0;
     auto lvl1 = [1,2,3,4,5,6,7,8,9,10];

source/mir/interpolate/constant.d

@@ -13,6 +13,8 @@ T2=$(TR $(TDNW $(LREF $1)) $(TD $+))
 +/
 module mir.interpolate.constant;
 
+@optmath:
+
 ///
 version(mir_test)
 @safe pure unittest
@@ -64,6 +66,8 @@ template constant(T, size_t N = 1, FirstGridIterator = immutable(T)*, NextGridIt
 {
     static if (N > 1) pragma(msg, "Warning: multivariate constant interpolant was not tested.");
 
+@optmath:
+
     private alias GridIterators = AliasSeq!(FirstGridIterator, NextGridIterators);
     private alias GridVectors = Constant!(T, N, GridIterators).GridVectors;
 
@@ -105,6 +109,8 @@ struct Constant(F, size_t N = 1, FirstGridIterator = immutable(F)*, NextGridIter
     package alias GridIterators = AliasSeq!(FirstGridIterator, NextGridIterators);
     package alias GridVectors = staticMap!(GridVector, GridIterators);
 
+@optmath:
+
     /// Aligned buffer allocated with `mir.internal.memory`. $(RED For internal use.)
     Slice!(Contiguous, [N], F*) _data;
     /// Grid iterators. $(RED For internal use.)

source/mir/interpolate/linear.d

@@ -23,6 +23,8 @@ import mir.internal.utility;
 public import mir.interpolate: atInterval;
 import mir.interpolate;
 
+@optmath:
+
 /++
 Constructs multivariate linear interpolant with nodes on rectilinear grid.
 
@@ -43,6 +45,8 @@ template linear(T, size_t N = 1, FirstGridIterator = immutable(T)*, NextGridIter
     private alias GridIterators = AliasSeq!(FirstGridIterator, NextGridIterators);
     private alias GridVectors = Linear!(T, N, GridIterators).GridVectors;
 
+@optmath:
+
     /++
     Params:
         grid = immutable `x` values for interpolant
@@ -382,6 +386,18 @@ struct LinearKernel(X)
     X w0 = 0;
     X w1 = 0;
 
+    ///
+    auto lightConst()() const @property
+    {
+        return LinearKernel!X(step, w0, w1);
+    }
+
+    ///
+    auto lightImmutable()() immutable @property
+    {
+        return LinearKernel!X(step, w0, w1);
+    }
+
     ///
     this()(X x0, X x1, X x)
     {

source/mir/interpolate/package.d

@@ -23,6 +23,9 @@ import std.traits: isInstanceOf;
 import mir.primitives;
 import mir.functional: RefTuple;
 import mir.ndslice.slice: Slice, Contiguous;
+import mir.math.common: optmath;
+
+@optmath:
 
 package ref iter(alias s)() { return s._iterator; };
 package alias GridVector(It) = Slice!(Contiguous, [1], It);

source/mir/interpolate/pchip.d

@@ -19,10 +19,10 @@ import std.traits;
 import std.meta: AliasSeq;
 import mir.ndslice.slice;
 import mir.array.primitives;
-import mir.math.common: optmath;
+import mir.math.common: fmamath;
 import mir.ndslice.internal: ConstIfPointer;
 
-@optmath:
+@fmamath:
 
 /++
 Constructs piecewise cubic hermite interpolating polynomial with nodes on rectilinear grid.
@@ -44,7 +44,7 @@ template pchip(T, size_t N = 1, FirstGridIterator = immutable(T)*, NextGridItera
         `points` and `values` must have the same length >= 3
     Returns: $(SUBREF spline, Spline)
     +/
-    Spline!(T, N, GridIterators) pchip(SliceKind ykind, yIterator)(
+    @fmamath Spline!(T, N, GridIterators) pchip(SliceKind ykind, yIterator)(
         GridVectors grid,
         scope Slice!(ykind, [N], yIterator) values) @safe
     {

source/mir/interpolate/spline.d

@@ -26,11 +26,13 @@ import std.meta;
 import mir.array.primitives;
 import mir.functional;
 import mir.internal.utility: Iota;
-import mir.math.common: optmath;
+import mir.math.common: fmamath;
 import mir.ndslice.internal;
 import mir.ndslice.slice;
 import mir.ndslice.traits;
 
+@fmamath:
+
 ///
 @safe pure nothrow unittest
 {
@@ -320,8 +322,6 @@ unittest
     // assert(appreq(d[1][1][1], y_x0x1x2));
 }
 
-@optmath:
-
 /++
 Constructs multivariate cubic spline in symmetrical form with nodes on rectilinear grid.
 Result has continues second derivatives throughout the curve / nd-surface.
@@ -438,6 +438,8 @@ struct Spline(F, size_t N = 1, FirstGridIterator = immutable(F)*, NextGridIterat
     package alias GridIterators = AliasSeq!(FirstGridIterator, NextGridIterators);
     package alias GridVectors = staticMap!(GridVector, GridIterators);
 
+@fmamath:
+
     /// Aligned buffer allocated with `mir.internal.memory`. $(RED For internal use.)
     Slice!(Contiguous, [N], F[2 ^^ N]*) _data;
     /// Grid iterators. $(RED For internal use.)