Merge pull request #236 from jorenham/feature/kurt

Add `l_kurt` and `l_cokurt` aliases

lmo/__init__.py

@@ -1,31 +1,42 @@
-"""Lmo: Robust statistics with trimmed L-moments and L-comoments."""
-import sys
+"""
+Robust statistics with trimmed L-moments and L-comoments.
+"""
+
+import sys  # noqa: I001
 from typing import TYPE_CHECKING, Final
 
 from ._lm import (
-    l_kurtosis,
     l_loc,
-    l_moment,
-    l_moment_cov,
-    l_moment_influence,
-    l_ratio,
-    l_ratio_influence,
-    l_ratio_se,
     l_scale,
+    l_variation,
     l_skew,
+    l_kurtosis,
+
+    l_kurt,
+    l_moment,
+    l_ratio,
     l_stats,
+
+    l_moment_cov,
+    l_ratio_se,
     l_stats_se,
-    l_variation,
+
+    l_moment_influence,
+    l_ratio_influence,
+
     l_weights,
 )
 from ._lm_co import (
-    l_cokurtosis,
     l_coloc,
-    l_comoment,
-    l_coratio,
-    l_corr,
     l_coscale,
+
+    l_corr,
     l_coskew,
+    l_cokurtosis,
+    l_cokurt,
+
+    l_comoment,
+    l_coratio,
     l_costats,
 )
 from ._meta import get_version as _get_version
@@ -60,6 +71,7 @@
     'l_variation',
     'l_skew',
     'l_kurtosis',
+    'l_kurt',
 
     'l_moment',
     'l_ratio',
@@ -79,6 +91,7 @@
     'l_corr',
     'l_coskew',
     'l_cokurtosis',
+    'l_cokurt',
 
     'l_comoment',
     'l_coratio',

lmo/_lm.py

@@ -46,6 +46,7 @@
     'l_variation',
     'l_skew',
     'l_kurtosis',
+    'l_kurt',
 
     'l_moment_cov',
     'l_ratio_se',
@@ -923,6 +924,9 @@ def l_kurtosis(
     return l_ratio(a, 4, 2, trim=trim, axis=axis, dtype=dtype, **kwds)
 
 
+l_kurt = l_kurtosis
+
+
 def l_moment_cov(
     a: lnpt.AnyArrayFloat,
     r_max: AnyOrder,

lmo/_lm_co.py

@@ -27,6 +27,7 @@
     'l_corr',
     'l_coskew',
     'l_cokurtosis',
+    'l_cokurt',
 )
 
 
@@ -429,3 +430,6 @@ def l_cokurtosis(
         - [`lmo.l_kurtosis`][lmo.l_kurtosis]
     """
     return l_coratio(a, 4, 2, trim=trim, dtype=dtype, **kwds)
+
+
+l_cokurt = l_cokurtosis

lmo/contrib/scipy_stats.py

@@ -589,6 +589,8 @@ def l_kurtosis(
         """
         return float(self.l_ratio(4, 2, *args, trim=trim, **kwds))
 
+    l_kurt = l_kurtosis
+
     def l_moments_cov(
         self,
         r_max: int,
@@ -1448,6 +1450,8 @@ def l_skew(self, trim: AnyTrim = 0) -> float:  # noqa: D102
     def l_kurtosis(self, trim: AnyTrim = 0) -> float:  # noqa: D102
         return self.dist.l_kurtosis(*self.args, trim=trim, **self.kwds)
 
+    l_kurt = l_kurtosis
+
     def l_moments_cov(  # noqa: D102
         self,
         r_max: int,

lmo/distributions.py

@@ -861,6 +861,8 @@ def l_kurtosis(self, trim: AnyTrim | None = None) -> float:
         """
         return float(self.l_ratio(4, 2, trim=trim))
 
+    l_kurt = l_kurtosis
+
     # `rv_continuous` and `rv_frozen` compatibility
 
     @property