aggregationslib 0.1.3__tar.gz → 0.1.5.dev1__tar.gz

aggregationslib-0.1.5.dev1/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.2
+Name: aggregationslib
+Version: 0.1.5.dev1
+Summary: Python implementation of Arithmetic, quasi arithmetic and other aggregating functions
+Author: wgalka
+Project-URL: Homepage, https://github.com/wgalka/Means
+Project-URL: Download, https://github.com/wgalka/Means/releases/latest
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.2
+Requires-Dist: pynverse
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.4; extra == "test"
+
+Means
+=====
+
+Means, Aggregation functions…
+
+Aggregations functions are: - Conjuctive - the final aggregated value
+will always be influenced by the smallest value among the inputs. -
+Disjnuctive - the aggregated value will always be influenced by the
+largest value among the inputs.
+
+Example 1:
+^^^^^^^^^^
+
+.. code:: pycon
+
+   # example data
+   data = [0.2, 0.6, 0.7]
+   # configure function parameters
+   func1 = A_amn(p=0.5)
+   # use aggregation funciton
+   print(func1(data))
+
+   # Combine two aggregations - arithmetic mean and minimum
+   func2 = Combine2Aggregations(A_ar(), min)
+   # use combination of aggregation funciton
+   print(func2(data))
+
+Example2:
+^^^^^^^^^
+
+To get information about aggregation function you can use ``__str__()``
+or ‘**repr**\ ()’ methods.
+
+.. code:: pycon
+
+   func1 = A_amn(p=0.5)
+   print(func1)
+   >>>A_amn(0.5)
+
+   func2 = Combine2Aggregations(A_ar(), A_md())
+   print(func2)
+   >>>A_armd
+
+   func3 = Combine2Aggregations(A_ar(), A_pw(r=3))
+   print(func3.__repr__()) # function parameters are printed in order: func1, func2
+   >>>A_arpw(r=3)
+
+``exponential(y, r=1)`` is given by equation
+
+.. math::
+
+
+   A_6^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), where
+   r \in \mathbb{R}, r \neq 0
+
+Aggregation functions
+---------------------
+
+Aggregation function [1] is a mapping :math:`A:[0,1]^n\to[0,1]`,
+:math:`n \in \mathbb{N}`, :math:`n\ge 2` which is is increasing and
+fulfills two boundary conditions, namely :math:`A(0,\dots,0) = 0`,
+:math:`A(1,\dots,1) = 1`.
+
+The floowoing aggregation functions are implemented in this library:
+
+**Arithmetic mean**
+
+.. math:: A_{ar}(x_1,...,x_n)=\frac{1}{n}\sum \limits_{k=1}^{n} x_k
+
+**Quadratic mean**
+
+.. math::
+
+   A_{qd}(x_1,...,x_n)=\sqrt{\frac{1}{n}\sum
+   \limits_{k=1}^{n} x_k^2}
+
+**Product aggregation**
+
+.. math:: A_{\text{pr}}(x_1, x_2, \dots, x_n) = \prod_{k=1}^n x_k
+
+**Geometric mean**
+
+.. math::
+
+   A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
+   \limits_{k=1}^{n} x_k}
+
+**Harmonic mean**
+
+.. math::
+
+
+   A_{hm}(x_1,...,x_n) =
+   \begin{cases}
+   0, & \text{if } \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
+   \end{cases}
+
+**Power mean**
+
+.. math::
+
+
+   A_{pw}^{(r)}(x_1,...,x_n) =
+   \begin{cases}
+   0, & r < 0, \; \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \Big(\frac{1}{n} \sum\limits_{k=1}^{n} x_k^r \Big)^{\frac{1}{r}}, & \text{otherwise}
+   \end{cases}
+
+special cases of power means :math:`A_{\text{pw}}^r` [1] are: -
+Arithmetic Mean where r=1; - Quadratic Mean where r=2; - Harmonic Mean
+where r=-1; - Geometric Mean obtained as the limit
+:math:`\lim_{r \to 0} A_{\text{pw}}^r`.
+
+--------------
+
+**Exponential mean**
+
+.. math::
+
+   A_{ex}^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), \text{where
+   } r \in \mathbb{R}$, $r \neq 0
+
+**Lehmer mean**
+
+.. math::  A_{lm}(x_1,...,x_n)= \frac{\sum \limits_{k=1}^{n}x_k^r}{\sum \limits_{k=1}^{n}x_k^{r-1}} 
+
+**Arithmetic minimum mean**
+
+.. math::
+
+   A_{amn}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \min \limits_{1 \leq k \leq n}x_k,
+
+**Arithmetic maximum mean**
+
+.. math::
+
+   A_{amx}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \max \limits_{1\leq k \leq n}x_k,
+
+OWA
+~~~
+
+In the case of n = 2 (when only two values are aggregated) the
+calculation of the median and the Olympic aggregation are reduced to the
+case of calculating the arithmetic mean of the given values.
+
+**Median - ordered weighted aggregation**
+
+.. math::
+
+   A_{md}(x_1,\dots,x_n) =
+   \begin{cases}
+   y_{(n+1)/2},&\text{if $n$ is odd}\\
+   \frac{y_{n/2}+y_{(n/2)+1}}{2},&\text{if $n$ is even}
+   \end{cases},
+
+**Olimpic aggregation**
+
+.. math::  A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+:math:`\mathbf{A_{oln}^{p}}` **- Olimpic aggregation**
+
+We can specify how many greatest and smallest records remove
+
+.. math::  A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+--------------
+
+:math:`\mathbf{A_{ln}}` **- Logaritmic aggregation**
+
+https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
+
+.. math::
+
+
+   A_{ln}\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
+
+:math:`A^p_{A_1,A_2}` - convex combinations of aggregation functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can construct covex combination of aggregation functions as
+:math:`A^p_{A_1,A_2}=pA_1+(1-p)A_2`, where :math:`A_1, A_2` are
+aggregation functions and :math:`p \in [0,1]`.
+
+References
+----------
+
+1. Beliakov, G., Bustince, H., and Calvo, T.: A practical Guide to
+   Averaging Functions. Berlin: Springer Vol. 329, 2016.

{aggregationslib-0.1.3 → aggregationslib-0.1.5.dev1}/README.md

@@ -74,29 +74,33 @@ $$A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
 
 **Harmonic mean**
 
+
+
 $$
-A_{hm}(x_1,...,x_n)=
-\left\{
-\begin{array}{ll}
-0, & \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+A_{hm}(x_1,...,x_n) =
+\begin{cases}
+0, & \text{if } \exists k,\, 1 \leq k \leq n : x_k = 0 \\
 \frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
-\end{array}
-\right.
+\end{cases}
 $$
 
 
 **Power mean**
 
-$$A_{pw}^{(r)}(x_1,...,x_n)=\left\{  \begin{array}{ll}
-0, & r<0, \;  \exists k,\, 1 \leq k \leq n : x_k = 0   \\
-\Big(\frac{1}{n}\sum \limits_{k=1}^{n} x_k^r\Big)^{\frac{1}{r}},& \text{otherwise}
-\end{array} \right.$$
+$$
+A_{pw}^{(r)}(x_1,...,x_n) =
+\begin{cases}
+0, & r < 0, \; \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+\Big(\frac{1}{n} \sum\limits_{k=1}^{n} x_k^r \Big)^{\frac{1}{r}}, & \text{otherwise}
+\end{cases}
+$$
+
 
 special cases of power means $A_{\text{pw}}^r$ [1] are:
-- Arithmetic Mean $A_{\text{ar}}$, where $r=1$;
-- Quadratic Mean $A_{\text{qd}}$, where $r=2$;
-- Harmonic Mean $A_{\text{hm}}$, where $r=-1$;
-- Geometric Mean $A_{\text{gm}}$, obtained as the limit $\lim_{r \to 0} A_{\text{pw}}^r$.
+- Arithmetic Mean where r=1;
+- Quadratic Mean where r=2;
+- Harmonic Mean where r=-1;
+- Geometric Mean  obtained as the limit $\lim_{r \to 0} A_{\text{pw}}^r$.
 
 
 ----
@@ -140,7 +144,7 @@ y_{(n+1)/2},&\text{if $n$ is odd}\\
 
 $$ A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.$$
 
-**Olimpic aggregation**
+$\mathbf{A_{oln}^{p}}$ **- Olimpic aggregation**
 
 We can specify how many greatest and smallest records remove
 
@@ -148,12 +152,12 @@ $$ A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \q
 
 --------------------
 
-**$A_{ln}$ - Logaritmic aggregation**
+$\mathbf{A_{ln}}$ **- Logaritmic aggregation**
 
 https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
 
 $$
-L\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
+A_{ln}\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
 $$
 
 ### $A^p_{A_1,A_2}$ - convex combinations of aggregation functions

aggregationslib-0.1.5.dev1/README.rst

@@ -0,0 +1,193 @@
+Means
+=====
+
+Means, Aggregation functions…
+
+Aggregations functions are: - Conjuctive - the final aggregated value
+will always be influenced by the smallest value among the inputs. -
+Disjnuctive - the aggregated value will always be influenced by the
+largest value among the inputs.
+
+Example 1:
+^^^^^^^^^^
+
+.. code:: pycon
+
+   # example data
+   data = [0.2, 0.6, 0.7]
+   # configure function parameters
+   func1 = A_amn(p=0.5)
+   # use aggregation funciton
+   print(func1(data))
+
+   # Combine two aggregations - arithmetic mean and minimum
+   func2 = Combine2Aggregations(A_ar(), min)
+   # use combination of aggregation funciton
+   print(func2(data))
+
+Example2:
+^^^^^^^^^
+
+To get information about aggregation function you can use ``__str__()``
+or ‘**repr**\ ()’ methods.
+
+.. code:: pycon
+
+   func1 = A_amn(p=0.5)
+   print(func1)
+   >>>A_amn(0.5)
+
+   func2 = Combine2Aggregations(A_ar(), A_md())
+   print(func2)
+   >>>A_armd
+
+   func3 = Combine2Aggregations(A_ar(), A_pw(r=3))
+   print(func3.__repr__()) # function parameters are printed in order: func1, func2
+   >>>A_arpw(r=3)
+
+``exponential(y, r=1)`` is given by equation
+
+.. math::
+
+
+   A_6^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), where
+   r \in \mathbb{R}, r \neq 0
+
+Aggregation functions
+---------------------
+
+Aggregation function [1] is a mapping :math:`A:[0,1]^n\to[0,1]`,
+:math:`n \in \mathbb{N}`, :math:`n\ge 2` which is is increasing and
+fulfills two boundary conditions, namely :math:`A(0,\dots,0) = 0`,
+:math:`A(1,\dots,1) = 1`.
+
+The floowoing aggregation functions are implemented in this library:
+
+**Arithmetic mean**
+
+.. math:: A_{ar}(x_1,...,x_n)=\frac{1}{n}\sum \limits_{k=1}^{n} x_k
+
+**Quadratic mean**
+
+.. math::
+
+   A_{qd}(x_1,...,x_n)=\sqrt{\frac{1}{n}\sum
+   \limits_{k=1}^{n} x_k^2}
+
+**Product aggregation**
+
+.. math:: A_{\text{pr}}(x_1, x_2, \dots, x_n) = \prod_{k=1}^n x_k
+
+**Geometric mean**
+
+.. math::
+
+   A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
+   \limits_{k=1}^{n} x_k}
+
+**Harmonic mean**
+
+.. math::
+
+
+   A_{hm}(x_1,...,x_n) =
+   \begin{cases}
+   0, & \text{if } \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
+   \end{cases}
+
+**Power mean**
+
+.. math::
+
+
+   A_{pw}^{(r)}(x_1,...,x_n) =
+   \begin{cases}
+   0, & r < 0, \; \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \Big(\frac{1}{n} \sum\limits_{k=1}^{n} x_k^r \Big)^{\frac{1}{r}}, & \text{otherwise}
+   \end{cases}
+
+special cases of power means :math:`A_{\text{pw}}^r` [1] are: -
+Arithmetic Mean where r=1; - Quadratic Mean where r=2; - Harmonic Mean
+where r=-1; - Geometric Mean obtained as the limit
+:math:`\lim_{r \to 0} A_{\text{pw}}^r`.
+
+--------------
+
+**Exponential mean**
+
+.. math::
+
+   A_{ex}^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), \text{where
+   } r \in \mathbb{R}$, $r \neq 0
+
+**Lehmer mean**
+
+.. math::  A_{lm}(x_1,...,x_n)= \frac{\sum \limits_{k=1}^{n}x_k^r}{\sum \limits_{k=1}^{n}x_k^{r-1}} 
+
+**Arithmetic minimum mean**
+
+.. math::
+
+   A_{amn}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \min \limits_{1 \leq k \leq n}x_k,
+
+**Arithmetic maximum mean**
+
+.. math::
+
+   A_{amx}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \max \limits_{1\leq k \leq n}x_k,
+
+OWA
+~~~
+
+In the case of n = 2 (when only two values are aggregated) the
+calculation of the median and the Olympic aggregation are reduced to the
+case of calculating the arithmetic mean of the given values.
+
+**Median - ordered weighted aggregation**
+
+.. math::
+
+   A_{md}(x_1,\dots,x_n) =
+   \begin{cases}
+   y_{(n+1)/2},&\text{if $n$ is odd}\\
+   \frac{y_{n/2}+y_{(n/2)+1}}{2},&\text{if $n$ is even}
+   \end{cases},
+
+**Olimpic aggregation**
+
+.. math::  A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+:math:`\mathbf{A_{oln}^{p}}` **- Olimpic aggregation**
+
+We can specify how many greatest and smallest records remove
+
+.. math::  A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+--------------
+
+:math:`\mathbf{A_{ln}}` **- Logaritmic aggregation**
+
+https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
+
+.. math::
+
+
+   A_{ln}\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
+
+:math:`A^p_{A_1,A_2}` - convex combinations of aggregation functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can construct covex combination of aggregation functions as
+:math:`A^p_{A_1,A_2}=pA_1+(1-p)A_2`, where :math:`A_1, A_2` are
+aggregation functions and :math:`p \in [0,1]`.
+
+References
+----------
+
+1. Beliakov, G., Bustince, H., and Calvo, T.: A practical Guide to
+   Averaging Functions. Berlin: Springer Vol. 329, 2016.

aggregationslib-0.1.5.dev1/aggregationslib.egg-info/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.2
+Name: aggregationslib
+Version: 0.1.5.dev1
+Summary: Python implementation of Arithmetic, quasi arithmetic and other aggregating functions
+Author: wgalka
+Project-URL: Homepage, https://github.com/wgalka/Means
+Project-URL: Download, https://github.com/wgalka/Means/releases/latest
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.2
+Requires-Dist: pynverse
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.4; extra == "test"
+
+Means
+=====
+
+Means, Aggregation functions…
+
+Aggregations functions are: - Conjuctive - the final aggregated value
+will always be influenced by the smallest value among the inputs. -
+Disjnuctive - the aggregated value will always be influenced by the
+largest value among the inputs.
+
+Example 1:
+^^^^^^^^^^
+
+.. code:: pycon
+
+   # example data
+   data = [0.2, 0.6, 0.7]
+   # configure function parameters
+   func1 = A_amn(p=0.5)
+   # use aggregation funciton
+   print(func1(data))
+
+   # Combine two aggregations - arithmetic mean and minimum
+   func2 = Combine2Aggregations(A_ar(), min)
+   # use combination of aggregation funciton
+   print(func2(data))
+
+Example2:
+^^^^^^^^^
+
+To get information about aggregation function you can use ``__str__()``
+or ‘**repr**\ ()’ methods.
+
+.. code:: pycon
+
+   func1 = A_amn(p=0.5)
+   print(func1)
+   >>>A_amn(0.5)
+
+   func2 = Combine2Aggregations(A_ar(), A_md())
+   print(func2)
+   >>>A_armd
+
+   func3 = Combine2Aggregations(A_ar(), A_pw(r=3))
+   print(func3.__repr__()) # function parameters are printed in order: func1, func2
+   >>>A_arpw(r=3)
+
+``exponential(y, r=1)`` is given by equation
+
+.. math::
+
+
+   A_6^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), where
+   r \in \mathbb{R}, r \neq 0
+
+Aggregation functions
+---------------------
+
+Aggregation function [1] is a mapping :math:`A:[0,1]^n\to[0,1]`,
+:math:`n \in \mathbb{N}`, :math:`n\ge 2` which is is increasing and
+fulfills two boundary conditions, namely :math:`A(0,\dots,0) = 0`,
+:math:`A(1,\dots,1) = 1`.
+
+The floowoing aggregation functions are implemented in this library:
+
+**Arithmetic mean**
+
+.. math:: A_{ar}(x_1,...,x_n)=\frac{1}{n}\sum \limits_{k=1}^{n} x_k
+
+**Quadratic mean**
+
+.. math::
+
+   A_{qd}(x_1,...,x_n)=\sqrt{\frac{1}{n}\sum
+   \limits_{k=1}^{n} x_k^2}
+
+**Product aggregation**
+
+.. math:: A_{\text{pr}}(x_1, x_2, \dots, x_n) = \prod_{k=1}^n x_k
+
+**Geometric mean**
+
+.. math::
+
+   A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
+   \limits_{k=1}^{n} x_k}
+
+**Harmonic mean**
+
+.. math::
+
+
+   A_{hm}(x_1,...,x_n) =
+   \begin{cases}
+   0, & \text{if } \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
+   \end{cases}
+
+**Power mean**
+
+.. math::
+
+
+   A_{pw}^{(r)}(x_1,...,x_n) =
+   \begin{cases}
+   0, & r < 0, \; \exists k,\, 1 \leq k \leq n : x_k = 0 \\
+   \Big(\frac{1}{n} \sum\limits_{k=1}^{n} x_k^r \Big)^{\frac{1}{r}}, & \text{otherwise}
+   \end{cases}
+
+special cases of power means :math:`A_{\text{pw}}^r` [1] are: -
+Arithmetic Mean where r=1; - Quadratic Mean where r=2; - Harmonic Mean
+where r=-1; - Geometric Mean obtained as the limit
+:math:`\lim_{r \to 0} A_{\text{pw}}^r`.
+
+--------------
+
+**Exponential mean**
+
+.. math::
+
+   A_{ex}^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
+   \Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), \text{where
+   } r \in \mathbb{R}$, $r \neq 0
+
+**Lehmer mean**
+
+.. math::  A_{lm}(x_1,...,x_n)= \frac{\sum \limits_{k=1}^{n}x_k^r}{\sum \limits_{k=1}^{n}x_k^{r-1}} 
+
+**Arithmetic minimum mean**
+
+.. math::
+
+   A_{amn}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \min \limits_{1 \leq k \leq n}x_k,
+
+**Arithmetic maximum mean**
+
+.. math::
+
+   A_{amx}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
+   (1-p) \max \limits_{1\leq k \leq n}x_k,
+
+OWA
+~~~
+
+In the case of n = 2 (when only two values are aggregated) the
+calculation of the median and the Olympic aggregation are reduced to the
+case of calculating the arithmetic mean of the given values.
+
+**Median - ordered weighted aggregation**
+
+.. math::
+
+   A_{md}(x_1,\dots,x_n) =
+   \begin{cases}
+   y_{(n+1)/2},&\text{if $n$ is odd}\\
+   \frac{y_{n/2}+y_{(n/2)+1}}{2},&\text{if $n$ is even}
+   \end{cases},
+
+**Olimpic aggregation**
+
+.. math::  A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+:math:`\mathbf{A_{oln}^{p}}` **- Olimpic aggregation**
+
+We can specify how many greatest and smallest records remove
+
+.. math::  A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.
+
+--------------
+
+:math:`\mathbf{A_{ln}}` **- Logaritmic aggregation**
+
+https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
+
+.. math::
+
+
+   A_{ln}\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
+
+:math:`A^p_{A_1,A_2}` - convex combinations of aggregation functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can construct covex combination of aggregation functions as
+:math:`A^p_{A_1,A_2}=pA_1+(1-p)A_2`, where :math:`A_1, A_2` are
+aggregation functions and :math:`p \in [0,1]`.
+
+References
+----------
+
+1. Beliakov, G., Bustince, H., and Calvo, T.: A practical Guide to
+   Averaging Functions. Berlin: Springer Vol. 329, 2016.

{aggregationslib-0.1.3 → aggregationslib-0.1.5.dev1}/aggregationslib.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 .gitignore
 LICENSE
 README.md
+README.rst
 pyproject.toml
 .github/workflows/python-publish.yml
 aggregationslib/__init__.py

{aggregationslib-0.1.3 → aggregationslib-0.1.5.dev1}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "aggregationslib"
 description = "Python implementation of Arithmetic, quasi arithmetic and other aggregating functions"
-readme = "README.md"
+readme = "README.rst"
 license = { file = "LICENSE" }
 requires-python = ">=3.12"
 authors = [

aggregationslib-0.1.3/PKG-INFO

@@ -1,185 +0,0 @@
-Metadata-Version: 2.2
-Name: aggregationslib
-Version: 0.1.3
-Summary: Python implementation of Arithmetic, quasi arithmetic and other aggregating functions
-Author: wgalka
-Project-URL: Homepage, https://github.com/wgalka/Means
-Project-URL: Download, https://github.com/wgalka/Means/releases/latest
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=2.2.2
-Requires-Dist: pynverse
-Provides-Extra: test
-Requires-Dist: pytest>=8.3.4; extra == "test"
-
-# Means
-Means, Aggregation functions...
-
-Aggregations functions are:
-- Conjuctive - the final aggregated value will always be influenced by the smallest value among the inputs.
-- Disjnuctive - the aggregated value will always be influenced by the largest value among the inputs.
-
-#### Example 1:
-
-```pycon
-# example data
-data = [0.2, 0.6, 0.7]
-# configure function parameters
-func1 = A_amn(p=0.5)
-# use aggregation funciton
-print(func1(data))
-
-# Combine two aggregations - arithmetic mean and minimum
-func2 = Combine2Aggregations(A_ar(), min)
-# use combination of aggregation funciton
-print(func2(data))
-```
-
-#### Example2:
-To get information about aggregation function you can use `__str__()` or '__repr__()' methods.
-
-```pycon
-func1 = A_amn(p=0.5)
-print(func1)
->>>A_amn(0.5)
-
-func2 = Combine2Aggregations(A_ar(), A_md())
-print(func2)
->>>A_armd
-
-func3 = Combine2Aggregations(A_ar(), A_pw(r=3))
-print(func3.__repr__()) # function parameters are printed in order: func1, func2
->>>A_arpw(r=3)
-```
-
-`exponential(y, r=1)` is given by equation
-
-$$
-A_6^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
-\Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), where
-r \in \mathbb{R}, r \neq 0
-$$
-
-## Aggregation functions
-
-Aggregation function [1] is a mapping
-$A:[0,1]^n\to[0,1]$, $n \in \mathbb{N}$, $n\ge 2$ which is is increasing and
-fulfills two boundary conditions, namely $A(0,\dots,0) = 0$, $A(1,\dots,1) = 1$.
-
-The floowoing aggregation functions are implemented in this library:
-
-**Arithmetic mean**
-
-$$A_{ar}(x_1,...,x_n)=\frac{1}{n}\sum \limits_{k=1}^{n} x_k$$
-
-**Quadratic mean**
-
-$$A_{qd}(x_1,...,x_n)=\sqrt{\frac{1}{n}\sum
-\limits_{k=1}^{n} x_k^2}$$
-
-**Product aggregation**
-
-$$A_{\text{pr}}(x_1, x_2, \dots, x_n) = \prod_{k=1}^n x_k$$
-
-**Geometric mean**
-
-$$A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
-\limits_{k=1}^{n} x_k}$$
-
-**Harmonic mean**
-
-$$
-A_{hm}(x_1,...,x_n)=
-\left\{
-\begin{array}{ll}
-0, & \exists k,\, 1 \leq k \leq n : x_k = 0 \\
-\frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
-\end{array}
-\right.
-$$
-
-
-**Power mean**
-
-$$A_{pw}^{(r)}(x_1,...,x_n)=\left\{  \begin{array}{ll}
-0, & r<0, \;  \exists k,\, 1 \leq k \leq n : x_k = 0   \\
-\Big(\frac{1}{n}\sum \limits_{k=1}^{n} x_k^r\Big)^{\frac{1}{r}},& \text{otherwise}
-\end{array} \right.$$
-
-special cases of power means $A_{\text{pw}}^r$ [1] are:
-- Arithmetic Mean $A_{\text{ar}}$, where $r=1$;
-- Quadratic Mean $A_{\text{qd}}$, where $r=2$;
-- Harmonic Mean $A_{\text{hm}}$, where $r=-1$;
-- Geometric Mean $A_{\text{gm}}$, obtained as the limit $\lim_{r \to 0} A_{\text{pw}}^r$.
-
-
-----
-
-**Exponential mean**
-
-$$A_{ex}^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
-\Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), \text{where
-} r \in \mathbb{R}$, $r \neq 0$$
-
-**Lehmer mean**
-
-$$ A_{lm}(x_1,...,x_n)= \frac{\sum \limits_{k=1}^{n}x_k^r}{\sum \limits_{k=1}^{n}x_k^{r-1}} $$
-
-**Arithmetic minimum mean**
-
-$$A_{amn}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
-(1-p) \min \limits_{1 \leq k \leq n}x_k,$$
-
-**Arithmetic maximum mean**
-
-$$A_{amx}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
-(1-p) \max \limits_{1\leq k \leq n}x_k,$$
-
-
-### OWA
-
-In the case of n = 2 (when only two values are aggregated) the
-calculation of the median and the Olympic aggregation are reduced to the case of calculating the
-arithmetic mean of the given values.
-
-**Median - ordered weighted aggregation**
-
-$$A_{md}(x_1,\dots,x_n) =
-\begin{cases}
-y_{(n+1)/2},&\text{if $n$ is odd}\\
-\frac{y_{n/2}+y_{(n/2)+1}}{2},&\text{if $n$ is even}
-\end{cases},$$
-
-**Olimpic aggregation**
-
-$$ A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.$$
-
-**Olimpic aggregation**
-
-We can specify how many greatest and smallest records remove
-
-$$ A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.$$
-
---------------------
-
-**$A_{ln}$ - Logaritmic aggregation**
-
-https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
-
-$$
-L\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
-$$
-
-### $A^p_{A_1,A_2}$ - convex combinations of aggregation functions
-
-We can construct covex combination of aggregation functions as $A^p_{A_1,A_2}=pA_1+(1-p)A_2$, where $A_1, A_2$ are aggregation functions and $p \in [0,1]$.
-
-
-
-## References
-
-1. Beliakov, G., Bustince, H., and Calvo, T.: A practical Guide to Averaging Functions.
-   Berlin: Springer Vol. 329, 2016.

aggregationslib-0.1.3/aggregationslib.egg-info/PKG-INFO

@@ -1,185 +0,0 @@
-Metadata-Version: 2.2
-Name: aggregationslib
-Version: 0.1.3
-Summary: Python implementation of Arithmetic, quasi arithmetic and other aggregating functions
-Author: wgalka
-Project-URL: Homepage, https://github.com/wgalka/Means
-Project-URL: Download, https://github.com/wgalka/Means/releases/latest
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=2.2.2
-Requires-Dist: pynverse
-Provides-Extra: test
-Requires-Dist: pytest>=8.3.4; extra == "test"
-
-# Means
-Means, Aggregation functions...
-
-Aggregations functions are:
-- Conjuctive - the final aggregated value will always be influenced by the smallest value among the inputs.
-- Disjnuctive - the aggregated value will always be influenced by the largest value among the inputs.
-
-#### Example 1:
-
-```pycon
-# example data
-data = [0.2, 0.6, 0.7]
-# configure function parameters
-func1 = A_amn(p=0.5)
-# use aggregation funciton
-print(func1(data))
-
-# Combine two aggregations - arithmetic mean and minimum
-func2 = Combine2Aggregations(A_ar(), min)
-# use combination of aggregation funciton
-print(func2(data))
-```
-
-#### Example2:
-To get information about aggregation function you can use `__str__()` or '__repr__()' methods.
-
-```pycon
-func1 = A_amn(p=0.5)
-print(func1)
->>>A_amn(0.5)
-
-func2 = Combine2Aggregations(A_ar(), A_md())
-print(func2)
->>>A_armd
-
-func3 = Combine2Aggregations(A_ar(), A_pw(r=3))
-print(func3.__repr__()) # function parameters are printed in order: func1, func2
->>>A_arpw(r=3)
-```
-
-`exponential(y, r=1)` is given by equation
-
-$$
-A_6^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
-\Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), where
-r \in \mathbb{R}, r \neq 0
-$$
-
-## Aggregation functions
-
-Aggregation function [1] is a mapping
-$A:[0,1]^n\to[0,1]$, $n \in \mathbb{N}$, $n\ge 2$ which is is increasing and
-fulfills two boundary conditions, namely $A(0,\dots,0) = 0$, $A(1,\dots,1) = 1$.
-
-The floowoing aggregation functions are implemented in this library:
-
-**Arithmetic mean**
-
-$$A_{ar}(x_1,...,x_n)=\frac{1}{n}\sum \limits_{k=1}^{n} x_k$$
-
-**Quadratic mean**
-
-$$A_{qd}(x_1,...,x_n)=\sqrt{\frac{1}{n}\sum
-\limits_{k=1}^{n} x_k^2}$$
-
-**Product aggregation**
-
-$$A_{\text{pr}}(x_1, x_2, \dots, x_n) = \prod_{k=1}^n x_k$$
-
-**Geometric mean**
-
-$$A_{gm}(x_1,...,x_n)=\sqrt[n]{\prod
-\limits_{k=1}^{n} x_k}$$
-
-**Harmonic mean**
-
-$$
-A_{hm}(x_1,...,x_n)=
-\left\{
-\begin{array}{ll}
-0, & \exists k,\, 1 \leq k \leq n : x_k = 0 \\
-\frac{n}{\sum\limits_{k=1}^{n} \frac{1}{x_k}}, & \text{otherwise}
-\end{array}
-\right.
-$$
-
-
-**Power mean**
-
-$$A_{pw}^{(r)}(x_1,...,x_n)=\left\{  \begin{array}{ll}
-0, & r<0, \;  \exists k,\, 1 \leq k \leq n : x_k = 0   \\
-\Big(\frac{1}{n}\sum \limits_{k=1}^{n} x_k^r\Big)^{\frac{1}{r}},& \text{otherwise}
-\end{array} \right.$$
-
-special cases of power means $A_{\text{pw}}^r$ [1] are:
-- Arithmetic Mean $A_{\text{ar}}$, where $r=1$;
-- Quadratic Mean $A_{\text{qd}}$, where $r=2$;
-- Harmonic Mean $A_{\text{hm}}$, where $r=-1$;
-- Geometric Mean $A_{\text{gm}}$, obtained as the limit $\lim_{r \to 0} A_{\text{pw}}^r$.
-
-
-----
-
-**Exponential mean**
-
-$$A_{ex}^{(r)}(x_1,...,x_n)= \frac{1}{r}\ln
-\Big(\frac{1}{n} \sum \limits_{k=1}^{n} e^{rx_k}\Big), \text{where
-} r \in \mathbb{R}$, $r \neq 0$$
-
-**Lehmer mean**
-
-$$ A_{lm}(x_1,...,x_n)= \frac{\sum \limits_{k=1}^{n}x_k^r}{\sum \limits_{k=1}^{n}x_k^{r-1}} $$
-
-**Arithmetic minimum mean**
-
-$$A_{amn}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
-(1-p) \min \limits_{1 \leq k \leq n}x_k,$$
-
-**Arithmetic maximum mean**
-
-$$A_{amx}^{(p)}(x_1,...,x_n)=\frac{p}{n}\sum \limits_{k=1}^{n} x_k+
-(1-p) \max \limits_{1\leq k \leq n}x_k,$$
-
-
-### OWA
-
-In the case of n = 2 (when only two values are aggregated) the
-calculation of the median and the Olympic aggregation are reduced to the case of calculating the
-arithmetic mean of the given values.
-
-**Median - ordered weighted aggregation**
-
-$$A_{md}(x_1,\dots,x_n) =
-\begin{cases}
-y_{(n+1)/2},&\text{if $n$ is odd}\\
-\frac{y_{n/2}+y_{(n/2)+1}}{2},&\text{if $n$ is even}
-\end{cases},$$
-
-**Olimpic aggregation**
-
-$$ A_{ol}(x_1,\dots,x_n) = \frac{1}{n-2} \sum \limits_{k=2}^{n-1}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.$$
-
-**Olimpic aggregation**
-
-We can specify how many greatest and smallest records remove
-
-$$ A_{oln}^{p}(x_1,\dots,x_n) = \frac{1}{n-2p} \sum \limits_{k=p}^{n-p}  y_k, \quad \text{where } \{y_1, \dots, y_n\} = \{x_1, \dots, x_n\},\ y_1 \leq y_2 \leq \dots \leq y_n.$$
-
---------------------
-
-**$A_{ln}$ - Logaritmic aggregation**
-
-https://www.researchgate.net/publication/228886844_Logarithmic_mean_for_several_arguments
-
-$$
-L\left(x_1, x_2, \ldots, x_n\right)=(n-1) ! \sum_{i=1}^n \frac{x_i}{\prod_{\substack{j=1 \\ j \neq i}}^n \log \left(x_i / x_j\right)}
-$$
-
-### $A^p_{A_1,A_2}$ - convex combinations of aggregation functions
-
-We can construct covex combination of aggregation functions as $A^p_{A_1,A_2}=pA_1+(1-p)A_2$, where $A_1, A_2$ are aggregation functions and $p \in [0,1]$.
-
-
-
-## References
-
-1. Beliakov, G., Bustince, H., and Calvo, T.: A practical Guide to Averaging Functions.
-   Berlin: Springer Vol. 329, 2016.