Fix truncated statistical distributions

- When a statistical distribution is truncated using the 'from' and 'to'
  arguments, it is now made sure that it retains the same mean value.
- Fixed other bug.

Author: rquey

VERSIONS

@@ -1,5 +1,6 @@
-New in 4.5.1-1 (12 Sep 2022):
+New in 4.5.1-2 (11 Oct 2022):
 - documentation: made minor improvement.
+- fixed truncated statistical distributions (from and to).
 
 New in 4.5.0 (07 Sep 2022):
 - module -T: fixed -morpho cube, added -statcell and -statvox

doc/conf.py

@@ -11,8 +11,8 @@
 import sphinx_rtd_theme
 
 project = u'Neper'
-version = u'4.5.1-1'
-release = u'4.5.1-1'
+version = u'4.5.1-2'
+release = u'4.5.1-2'
 author = u'Romain Quey'
 copyright = u'Romain Quey'
 language = 'en'

doc/exprskeys.rst

@@ -107,7 +107,9 @@ The following table lists the statistical distributions.  Custom endpoints (not
 :data:`custom(<file_name>)`                   custom
 ============================================= ==================== ======================================
 
-:data:`mean` represents the mean (or centre), and :data:`sigma` represents the standard deviation (or scale, :math:`> 0`). :data:`gamma` depends on the distribution function (see the above table). For all distributions, custom endpoints can be added as last arguments, as :data:`<from_value>,\<to_value\>`, where :data:`from_value` is the lower endpoint and :data:`to_value` is the upper endpoint. The parameter keywords do not need to be provided, but, when they are, the parameters can be given in any order, as in :data:`moffat(gamma=1,from=0,to=1,sigma=0.1,mean=0.5)`.  Endpoints are considered inclusive by default, but exclusive endpoints can be specified using :data:`fromexclusive=\<from_value\>` and :data:`toexclusive=\<to_value\>` (:data:`frominclusive=\<from_value\>` and :data:`toinclusive=\<to_value\>` can be used for inclusive endpoints).  String completion is available for the keywords.  Finally, a sum of distributions of increasing averages can be provided, as in :data:`0.3*lognormal(0.5,0.1)+0.7*normal(1,0.1)`.
+:data:`<mean>` represents the mean (or centre), and :data:`<sigma>` represents the standard deviation (or scale, :math:`> 0`). :data:`<gamma>` depends on the distribution function (see the above table). For all distributions, custom endpoints can be added as last arguments, as :data:`<from_value>,\<to_value\>`, where :data:`<from_value>` is the lower endpoint and :data:`<to_value>` is the upper endpoint. The parameter keywords do not need to be provided, but, when they are, the parameters can be given in any order, as in :data:`moffat(gamma=1,from=0,to=1,sigma=0.1,mean=0.5)`.  Endpoints are considered inclusive by default, but exclusive endpoints can be specified using :data:`fromexclusive=\<from_value\>` and :data:`toexclusive=\<to_value\>` (:data:`frominclusive=\<from_value\>` and :data:`toinclusive=\<to_value\>` can be used for inclusive endpoints).  String completion is available for the keywords.  Finally, a sum of distributions of increasing averages can be provided, as in :data:`0.3*lognormal(0.5,0.1)+0.7*normal(1,0.1)`.
+
+.. attention:: When :data:`from` and/or :data:`to` are used, they should preferably be so that the distribution retains the same mean; otherwise, the distribution is shifted after truncation to match the specified mean.
 
 In the case of the :data:`custom` distribution, the numerical distribution must be provided in the file. The file must contain the x and y values of the distribution on successive lines.  The x values must be provided in ascending order and form a regular grid.  The distribution must contain at least 3 points and does not need to integrate to 1.
 

src/CMakeLists.txt

@@ -7,7 +7,7 @@ if(POLICY CMP0077)
   cmake_policy(SET CMP0077 NEW)
 endif()
 
-set(NEPER_VERSION \"4.5.1-1\")
+set(NEPER_VERSION \"4.5.1-2\")
 project(neper)
 
 if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.8.1)

src/contrib/ut/src/ut_fct/ut_fct.c

@@ -560,6 +560,13 @@ ut_fct_numericalfct (struct FCT Fct, double min, double max, int size,
       sum += ut_fct_binwidth (*pFct2, i) * (*pFct2).y[i];
     }
     ut_array_1d_scale ((*pFct2).y, (*pFct2).size, FctC.area / sum);
+
+    double xmean = 0;
+    for (i = 0; i < (*pFct2).size; i++)
+      xmean += (*pFct2).x[i] * (*pFct2).y[i] * ut_fct_binwidth (*pFct2, i);
+
+    // it is necessary to fix the distribution when (unbalanced) from and to bounds are specified
+    ut_array_1d_addval ((*pFct2).x, (*pFct2).size, (*pFct2).mean - xmean, (*pFct2).x);
   }
 
   (*pFct2).interp_type = (gsl_interp_type *) gsl_interp_cspline;

src/neper_t/net_tess/net_tess_opt/net_tess_opt_init/net_tess_opt_init2.cpp

@@ -317,6 +317,8 @@ net_tess_opt_init_target (struct IN_T In, struct MTESS MTess,
           }
 
           Fct[j].sigma /= mean;
+          Fct[j].from /= mean;
+          Fct[j].to /= mean;
         }
       }
 

tests/T/morphooptiobj_ad/ref.tess

@@ -8,164 +8,157 @@
   *crysym
    triclinic
   *seed
-   1 0.637316633924 0.339809602352 0.159391794127 0.492372510921
+   1 0.489604880648 0.290572351259 0.159391794127 0.492372510921
    2 0.452028974213 0.195589598124 0.501814614272 0.492372510921
   *ori
    rodrigues:active
   -2.444015198417    0.618305125773    2.829029762200
    0.441042954395    0.731096527047   -0.307369633254
  **vertex
- 13
-   1  1.000000000000 0.000000000000 0.000000000000     0
-   2  1.000000000000 1.000000000000 0.000000000000     0
-   3  0.000000000000 1.000000000000 0.000000000000     0
-   4  -0.000000000000 0.182517711481 -0.000000000000     0
-   5  -0.000000000000 1.000000000000 0.344303277031     0
-   6  1.000000000000 1.000000000000 0.885411079464     0
-   7  1.000000000000 -0.000000000000 0.464235866415     0
-   8  0.142063994776 -0.000000000000 -0.000000000000     0
-   9  0.000000000000 0.000000000000 0.000000000000     0
-  10  0.000000000000 0.000000000000 1.000000000000     0
-  11  0.000000000000 1.000000000000 1.000000000000     0
-  12  1.000000000000 1.000000000000 1.000000000000     0
-  13  1.000000000000 0.000000000000 1.000000000000     0
+ 12
+   1  0.000000000000 0.000000000000 0.000000000000     0
+   2  1.000000000000 0.000000000000 0.000000000000     0
+   3  1.000000000000 1.000000000000 0.000000000000     0
+   4  0.000000000000 1.000000000000 0.000000000000     0
+   5  -0.000000000000 -0.000000000000 0.211511044960     0
+   6  -0.000000000000 1.000000000000 0.488895458461     0
+   7  1.000000000000 1.000000000000 0.598630862249     0
+   8  1.000000000000 -0.000000000000 0.321246448748     0
+   9  0.000000000000 0.000000000000 1.000000000000     0
+  10  0.000000000000 1.000000000000 1.000000000000     0
+  11  1.000000000000 1.000000000000 1.000000000000     0
+  12  1.000000000000 0.000000000000 1.000000000000     0
  **edge
- 22
-   1  3 4 0
-   2  4 5 0
-   3  5 3 0
-   4  1 2 0
-   5  2 6 0
-   6  6 7 0
-   7  7 1 0
-   8  7 8 0
-   9  8 1 0
-  10  2 3 0
-  11  5 6 0
-  12  8 4 0
+ 20
+   1  4 1 0
+   2  1 5 0
+   3  5 6 0
+   4  6 4 0
+   5  2 3 0
+   6  3 7 0
+   7  7 8 0
+   8  8 2 0
+   9  1 2 0
+  10  8 5 0
+  11  3 4 0
+  12  6 7 0
   13  9 10 0
-  14  10 11 0
-  15  11 5 0
-  16  4 9 0
-  17  12 13 0
-  18  13 7 0
-  19  6 12 0
-  20  13 10 0
-  21  9 8 0
-  22  11 12 0
+  14  10 6 0
+  15  5 9 0
+  16  11 12 0
+  17  12 8 0
+  18  7 11 0
+  19  12 9 0
+  20  10 11 0
  **face
- 12
-   1 3 3 4 5
-     3 1 2 3
+ 11
+   1 4 4 1 5 6
+     4 1 2 3 4
     -0.000000000000 -1.000000000000 -0.000000000000 -0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   2 4 1 2 6 7
-     4 4 5 6 7
+   2 4 2 3 7 8
+     4 5 6 7 8
     1.000000000000 1.000000000000 0.000000000000 0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   3 3 1 7 8
-     3 -7 8 9
+   3 4 1 2 8 5
+     4 9 -8 10 -2
     -0.000000000000 -0.000000000000 -1.000000000000 -0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   4 4 2 3 5 6
-     4 10 -3 11 -5
+   4 4 3 4 6 7
+     4 11 -4 12 -6
     1.000000000000 0.000000000000 1.000000000000 0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   5 5 3 2 1 8 4
-     5 -10 -4 -9 12 -1
+   5 4 4 3 2 1
+     4 -11 -5 -9 -1
     -0.000000000000 -0.000000000000 -0.000000000000 -1.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   6 5 4 5 6 7 8
-     5 2 11 6 8 12
-    0.063398888782 0.446269928439 0.347357460644 -0.824733863441
+   6 4 5 6 7 8
+     4 3 12 7 10
+    -0.202685325651 0.105156475665 0.265809996786 -0.958273009760
      0 0 0.000000000000 0.000000000000 0.000000000000
-   7 5 9 10 11 5 4
-     5 13 14 15 -2 16
+   7 4 9 10 6 5
+     4 13 14 -3 15
     -0.000000000000 -1.000000000000 -0.000000000000 -0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   8 4 12 13 7 6
-     4 17 18 -6 19
+   8 4 11 12 8 7
+     4 16 17 -7 18
     1.000000000000 1.000000000000 0.000000000000 0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-   9 5 13 10 9 8 7
-     5 20 -13 21 -8 -18
+   9 4 12 9 5 8
+     4 19 -15 -10 -17
     -0.000000000000 -0.000000000000 -1.000000000000 -0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-  10 4 11 12 6 5
-     4 22 -19 -11 -15
+  10 4 10 11 7 6
+     4 20 -18 -12 -14
     1.000000000000 0.000000000000 1.000000000000 0.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
-  11 3 9 4 8
-     3 -16 -12 -21
-    -0.000000000000 -0.000000000000 -0.000000000000 -1.000000000000
-     0 0 0.000000000000 0.000000000000 0.000000000000
-  12 4 13 12 11 10
-     4 -17 -22 -14 -20
+  11 4 12 11 10 9
+     4 -16 -20 -13 -19
     1.000000000000 0.000000000000 0.000000000000 1.000000000000
      0 0 0.000000000000 0.000000000000 0.000000000000
  **polyhedron
  2
    1 6 1 2 3 4 5 -6
-   2 7 7 8 9 10 11 12 6
+   2 6 7 8 9 10 11 6
  **domain
   *general
    cube
   *vertex
    8
    1  0.000000000000 0.000000000000 0.000000000000 x0y0z0
-      1 9
-   2  1.000000000000 0.000000000000 0.000000000000 x1y0z0
       1 1
-   3  1.000000000000 1.000000000000 0.000000000000 x1y1z0
+   2  1.000000000000 0.000000000000 0.000000000000 x1y0z0
       1 2
-   4  0.000000000000 1.000000000000 0.000000000000 x0y1z0
+   3  1.000000000000 1.000000000000 0.000000000000 x1y1z0
       1 3
+   4  0.000000000000 1.000000000000 0.000000000000 x0y1z0
+      1 4
    5  0.000000000000 0.000000000000 1.000000000000 x0y0z1
-      1 10
+      1 9
    6  0.000000000000 1.000000000000 1.000000000000 x0y1z1
-      1 11
+      1 10
    7  1.000000000000 1.000000000000 1.000000000000 x1y1z1
-      1 12
+      1 11
    8  1.000000000000 0.000000000000 1.000000000000 x1y0z1
-      1 13
+      1 12
   *edge
    12
    1 2 4 6
      x0y1
-     2 3 15
+     2 4 14
    2 2 6 5
      x0z1
-     1 14
+     1 13
    3 2 5 1
      x0y0
-     1 13
+     2 2 15
    4 2 1 4
      x0z0
-     2 1 16
+     1 1
    5 2 2 8
      x1y0
-     2 7 18
+     2 8 17
    6 2 8 7
      x1z1
-     1 17
+     1 16
    7 2 7 3
      x1y1
-     2 5 19
+     2 6 18
    8 2 3 2
      x1z0
-     1 4
+     1 5
    9 2 5 8
      y0z1
-     1 20
+     1 19
   10 2 2 1
      y0z0
-     2 9 21
+     1 9
   11 2 4 3
      y1z0
-     1 10
+     1 11
   12 2 7 6
      y1z1
-     1 22
+     1 20
   *face
    6
    1 4 4 6 5 1
@@ -197,11 +190,11 @@
      plane
      4 0.000000000000 0.000000000000 0.000000000000 1.000000000000
      z0
-     2 5 11
+     1 5
    6 4 5 6 7 8
      4 2 12 6 9
      plane
      4 -1.000000000000 -0.000000000000 -0.000000000000 -1.000000000000
      z1
-     1 12
+     1 11
 ***end