Skip to content

Commit 1ea5088

Browse files
authored
[oneMath][stats] Add formulae to statistic routines (#623)
Added a Mathematical Notation rubric with formulae for better readability
1 parent 1171d81 commit 1ea5088

16 files changed

+180
-0
lines changed

source/elements/oneMath/source/domains/stats/onemath_stats_central_moment.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::central_moment function is used to compute an array of
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of central moments:
31+
32+
:math:`C^k(X) = \left( C^k_1(X), \; \dots, C^k_p(X) \right), \; C_i^k(X) = \frac{1}{W} \sum_{j=1}^{n} \omega_j \left( x_{ij} - M_i(X) \right)^k`
33+
34+
Where:
35+
36+
:math:`W = \sum_{j=1}^n \omega_j, \, i = 1, \dots, p, \; k = 2, 3, 4`
37+
38+
2839
.. _onemath_stats_central_moment_buffer:
2940

3041
central_moment (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_central_moment_user_mean.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::central_moment function is used to compute an array of
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of central moments:
31+
32+
:math:`C^k(X) = \left( C^k_1(X), \; \dots, C^k_p(X) \right), \; C_i^k(X) = \frac{1}{W} \sum_{j=1}^{n} \omega_j \left( x_{ij} - M_i(X) \right)^k`
33+
34+
Where:
35+
36+
:math:`W = \sum_{j=1}^n \omega_j, \, i = 1, \dots, p, \; k = 2, 3, 4`
37+
38+
2839
.. _onemath_stats_central_moment_user_mean_buffer:
2940

3041
central_moment with provided mean (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_central_sum.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::central_sum function is used to compute an array of cen
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of central sums:
31+
32+
:math:`S^k(X) = \left( S^k_1(X), \; \dots, S^k_p(X) \right), \; S^k_i(X) = \sum_{j=1}^{n} \omega_j \left( x_{ij} - S_i(X) \right)^k`
33+
34+
Where:
35+
36+
:math:`S_i(X) = \sum_{j=1}^n \omega_j x_{ij}, \; i = 1, \dots, p, \; k = 2, 3, 4`
37+
38+
2839
.. _onemath_stats_central_sum_buffer:
2940

3041
central_sum (Buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_central_sum_user_mean.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::central_sum function is used to compute an array of cen
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of central sums:
31+
32+
:math:`S^k(X) = \left( S^k_1(X), \; \dots, S^k_p(X) \right), \; S^k_i(X) = \sum_{j=1}^{n} \omega_j \left( x_{ij} - S_i(X) \right)^k`
33+
34+
Where:
35+
36+
:math:`S_i(X) = \sum_{j=1}^n \omega_j x_{ij}, \; i = 1, \dots, p, \; k = 2, 3, 4`
37+
38+
2839
.. _onemath_stats_central_sum_user_mean_buffer:
2940

3041
central_sum with provided mean (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_kurtosis.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::kurtosis function is used to compute a kurtosis array (
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of kurtosis values:
31+
32+
:math:`B(X) = \left( B_1(X), \; \dots, B_p(X) \right), \; B_i(X) = \frac{C^{(4)}_i(X)}{V^2_i(X)} - 3`
33+
34+
Where:
35+
36+
:math:`i = 1, \dots, p`
37+
38+
2839
.. _onemath_stats_kurtosis_buffer:
2940

3041
kurtosis (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_kurtosis_user_mean.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::kurtosis function is used to compute an array of kurtos
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of kurtosis values:
31+
32+
:math:`B(X) = \left( B_1(X), \; \dots, B_p(X) \right), \; B_i(X) = \frac{C^{(4)}_i(X)}{V^2_i(X)} - 3`
33+
34+
Where:
35+
36+
:math:`i = 1, \dots, p`
37+
38+
2839
.. _onemath_stats_kurtosis_user_mean_buffer:
2940

3041
kurtosis with provided mean (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_max.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::max function is used to compute a max values arrays (ma
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of maximum values:
31+
32+
:math:`\max(X) = \left( {\max}_1(X), \; \dots, {\max}_p(X) \right)`
33+
34+
Where:
35+
36+
:math:`i = 1, \dots, p`
37+
38+
2839
.. _onemath_stats_max_buffer:
2940

3041
max (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_mean.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::mean function is used to compute a mean array (mean val
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of mean values:
31+
32+
:math:`M(X) = \left( M_1(X), \; \dots, M_p(X) \right), \; M_i(X) = \frac{1}{W} \sum_{j=1}^n \omega_j x_{ij}`
33+
34+
Where:
35+
36+
:math:`W = \sum_{j=1}^n \omega_j, \; i = 1, \dots, p`
37+
38+
2839
.. _onemath_stats_mean_buffer:
2940

3041
mean (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_min.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ The oneapi::math::stats::min function is used to compute min arrays (min value f
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of minimum values:
31+
32+
:math:`\min(X) = \left( {\min}_1(X), \; \dots, {\min}_p(X) \right)`
33+
34+
Where:
35+
36+
:math:`i = 1, \dots, p`
37+
38+
2839
.. _onemath_stats_min_buffer:
2940

3041
min (buffer version)

source/elements/oneMath/source/domains/stats/onemath_stats_min_max.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,21 @@ The oneapi::math::stats::min_max function is used to compute min and max arrays
2525
* - ``double``
2626

2727

28+
.. rubric:: Mathematical Notation
29+
30+
Vector of maximum values:
31+
32+
:math:`\max(X) = \left( {\max}_1(X), \; \dots, {\max}_p(X) \right)`
33+
34+
Vector of minimum values:
35+
36+
:math:`\min(X) = \left( {\min}_1(X), \; \dots, {\min}_p(X) \right)`
37+
38+
Where:
39+
40+
:math:`i = 1, \dots, p`
41+
42+
2843
.. _onemath_stats_min_max_buffer:
2944

3045
min_max (buffer version)

0 commit comments

Comments
 (0)