Update documentation to remove most explicit references to ArrayBase

akern40 · akern40 · commit 98ddf72ae9d2 · 2025-11-09T09:39:29.000-05:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -14,7 +14,7 @@ repository = "https://github.com/rust-ndarray/ndarray-stats"
 documentation = "https://docs.rs/ndarray-stats/"
 readme = "README.md"
 
-description = "Statistical routines for ArrayBase, the n-dimensional array data structure provided by ndarray."
+description = "Statistical routines for the n-dimensional array data structures provided by ndarray."
 
 keywords = ["array", "multidimensional", "statistics", "matrix", "ndarray"]
 categories = ["data-structures", "science"]
diff --git a/README.md b/README.md
@@ -5,16 +5,17 @@
 [![Crate](https://img.shields.io/crates/v/ndarray-stats.svg)](https://crates.io/crates/ndarray-stats)
 [![Documentation](https://docs.rs/ndarray-stats/badge.svg)](https://docs.rs/ndarray-stats)
 
-This crate provides statistical methods for [`ndarray`]'s `ArrayBase` type.
+This crate provides statistical methods for [`ndarray`]'s `ArrayRef` type.
 
 Currently available routines include:
-- order statistics (minimum, maximum, median, quantiles, etc.);
-- summary statistics (mean, skewness, kurtosis, central moments, etc.)
-- partitioning;
-- correlation analysis (covariance, pearson correlation);
-- measures from information theory (entropy, KL divergence, etc.);
-- deviation functions (distances, counts, errors, etc.);
-- histogram computation.
+
+-   order statistics (minimum, maximum, median, quantiles, etc.);
+-   summary statistics (mean, skewness, kurtosis, central moments, etc.)
+-   partitioning;
+-   correlation analysis (covariance, pearson correlation);
+-   measures from information theory (entropy, KL divergence, etc.);
+-   deviation functions (distances, counts, errors, etc.);
+-   histogram computation.
 
 See the [documentation](https://docs.rs/ndarray-stats) for more information.
 
@@ -32,98 +33,102 @@ ndarray-stats = "0.6.0"
 
 ## Releases
 
-* **0.6.0**
-
-  * Breaking changes
-    * Minimum supported Rust version: `1.64.0`
-    * Updated to `ndarray:v0.16.0`
-    * Updated to `approx:v0.5.0`
-
-  * Updated to `ndarray-rand:v0.15.0`
-  * Updated to `indexmap:v2.4`
-  * Updated to `itertools:v0.13`
-
-  *Contributors*: [@bluss](https://github.com/bluss)
-
-* **0.5.1**
-  * Fixed bug in implementation of `MaybeNaN::remove_nan_mut` for `f32` and
-    `f64` for views with non-standard layouts. Before this fix, the bug could
-    cause incorrect results, buffer overflows, etc., in this method and others
-    which use it. Thanks to [@JacekCzupyt](https://github.com/JacekCzupyt) for
-    reporting the issue (#89).
-  * Minor docs improvements.
-
-  *Contributors*: [@jturner314](https://github.com/jturner314), [@BenMoon](https://github.com/BenMoon)
-
-* **0.5.0**
-  * Breaking changes
-    * Minimum supported Rust version: `1.49.0`
-    * Updated to `ndarray:v0.15.0`
-
-  *Contributors*: [@Armavica](https://github.com/armavica), [@cassiersg](https://github.com/cassiersg)
-
-* **0.4.0**
-  * Breaking changes
-    * Minimum supported Rust version: `1.42.0`
-  * New functionality:
-    * Summary statistics:
-      * Weighted variance
-      * Weighted standard deviation
-  * Improvements / breaking changes:
-    * Documentation improvements for Histograms
-    * Updated to `ndarray:v0.14.0`
- 
-  *Contributors*: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@LukeMathWalker](https://github.com/LukeMathWalker), [@lebensterben](https://github.com/lebensterben), [@xd009642](https://github.com/xd009642)
-
-* **0.3.0**
-
-  * Breaking changes
-    * Minimum supported Rust version: `1.37`
-  * New functionality:
-    * Deviation functions:
-      * Counts equal/unequal
-      * `l1`, `l2`, `linf` distances
-      * (Root) mean squared error
-      * Peak signal-to-noise ratio
-    * Summary statistics:
-      * Weighted sum
-      * Weighted mean
-  * Improvements / breaking changes:
-    * Updated to `ndarray:v0.13.0`
-  
-  *Contributors*: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker)
-
-* **0.2.0**
-
-  * Breaking changes
-    * All `ndarray-stats`' extension traits are now impossible to implement by
-      users of the library (see [#34])
-    * Redesigned error handling across the whole crate, standardising on `Result`
-  * New functionality:
-    * Summary statistics:
-      * Harmonic mean
-      * Geometric mean
-      * Central moments
-      * Kurtosis
-      * Skewness
-    * Information theory:
-      * Entropy
-      * Cross-entropy
-      * Kullback-Leibler divergence
-    * Quantiles and order statistics:
-      * `argmin` / `argmin_skipnan`
-      * `argmax` / `argmax_skipnan`
-      * Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`)
-  * Fixes:
-    * Reduced occurrences of overflow for `interpolate::midpoint`
-
-  *Contributors*: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik)
-
-  [#34]: https://github.com/rust-ndarray/ndarray-stats/issues/34
-
-* **0.1.0**
-
-  * Initial release by @LukeMathWalker and @jturner314.
+-   **0.6.0**
+
+    -   Breaking changes
+
+        -   Minimum supported Rust version: `1.64.0`
+        -   Updated to `ndarray:v0.16.0`
+        -   Updated to `approx:v0.5.0`
+
+    -   Updated to `ndarray-rand:v0.15.0`
+    -   Updated to `indexmap:v2.4`
+    -   Updated to `itertools:v0.13`
+
+    _Contributors_: [@bluss](https://github.com/bluss)
+
+-   **0.5.1**
+
+    -   Fixed bug in implementation of `MaybeNaN::remove_nan_mut` for `f32` and
+        `f64` for views with non-standard layouts. Before this fix, the bug could
+        cause incorrect results, buffer overflows, etc., in this method and others
+        which use it. Thanks to [@JacekCzupyt](https://github.com/JacekCzupyt) for
+        reporting the issue (#89).
+    -   Minor docs improvements.
+
+    _Contributors_: [@jturner314](https://github.com/jturner314), [@BenMoon](https://github.com/BenMoon)
+
+-   **0.5.0**
+
+    -   Breaking changes
+        -   Minimum supported Rust version: `1.49.0`
+        -   Updated to `ndarray:v0.15.0`
+
+    _Contributors_: [@Armavica](https://github.com/armavica), [@cassiersg](https://github.com/cassiersg)
+
+-   **0.4.0**
+
+    -   Breaking changes
+        -   Minimum supported Rust version: `1.42.0`
+    -   New functionality:
+        -   Summary statistics:
+            -   Weighted variance
+            -   Weighted standard deviation
+    -   Improvements / breaking changes:
+        -   Documentation improvements for Histograms
+        -   Updated to `ndarray:v0.14.0`
+
+    _Contributors_: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@LukeMathWalker](https://github.com/LukeMathWalker), [@lebensterben](https://github.com/lebensterben), [@xd009642](https://github.com/xd009642)
+
+-   **0.3.0**
+
+    -   Breaking changes
+        -   Minimum supported Rust version: `1.37`
+    -   New functionality:
+        -   Deviation functions:
+            -   Counts equal/unequal
+            -   `l1`, `l2`, `linf` distances
+            -   (Root) mean squared error
+            -   Peak signal-to-noise ratio
+        -   Summary statistics:
+            -   Weighted sum
+            -   Weighted mean
+    -   Improvements / breaking changes:
+        -   Updated to `ndarray:v0.13.0`
+
+    _Contributors_: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker)
+
+-   **0.2.0**
+
+    -   Breaking changes
+        -   All `ndarray-stats`' extension traits are now impossible to implement by
+            users of the library (see [#34])
+        -   Redesigned error handling across the whole crate, standardising on `Result`
+    -   New functionality:
+        -   Summary statistics:
+            -   Harmonic mean
+            -   Geometric mean
+            -   Central moments
+            -   Kurtosis
+            -   Skewness
+        -   Information theory:
+            -   Entropy
+            -   Cross-entropy
+            -   Kullback-Leibler divergence
+        -   Quantiles and order statistics:
+            -   `argmin` / `argmin_skipnan`
+            -   `argmax` / `argmax_skipnan`
+            -   Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`)
+    -   Fixes:
+        -   Reduced occurrences of overflow for `interpolate::midpoint`
+
+    _Contributors_: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik)
+
+    [#34]: https://github.com/rust-ndarray/ndarray-stats/issues/34
+
+-   **0.1.0**
+
+    -   Initial release by @LukeMathWalker and @jturner314.
 
 ## Contributing
 
diff --git a/src/histogram/histograms.rs b/src/histogram/histograms.rs
@@ -71,7 +71,7 @@ impl<A: Ord> Histogram<A> {
     }
 }
 
-/// Extension trait for `ArrayBase` providing methods to compute histograms.
+/// Extension trait for `ArrayRef` providing methods to compute histograms.
 pub trait HistogramExt<A> {
     /// Returns the [histogram](https://en.wikipedia.org/wiki/Histogram)
     /// for a 2-dimensional array of points `M`.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,4 @@
-//! The [`ndarray-stats`] crate exposes statistical routines for `ArrayBase`,
+//! The [`ndarray-stats`] crate exposes statistical routines for `ArrayRef`,
 //! the *n*-dimensional array data structure provided by [`ndarray`].
 //!
 //! Currently available routines include:
diff --git a/src/maybe_nan/mod.rs b/src/maybe_nan/mod.rs
@@ -260,7 +260,7 @@ impl<T> NotNone<T> {
     }
 }
 
-/// Extension trait for `ArrayBase` providing NaN-related functionality.
+/// Extension trait for `ArrayRef` providing NaN-related functionality.
 pub trait MaybeNanExt<A, D>
 where
     A: MaybeNan,
diff --git a/src/quantile/mod.rs b/src/quantile/mod.rs
@@ -8,7 +8,7 @@ use ndarray::{RemoveAxis, Zip};
 use noisy_float::types::N64;
 use std::cmp;
 
-/// Quantile methods for `ArrayBase`.
+/// Quantile methods for `ArrayRef`.
 pub trait QuantileExt<A, D>
 where
     D: Dimension,
diff --git a/src/summary_statistics/mod.rs b/src/summary_statistics/mod.rs
@@ -4,7 +4,7 @@ use ndarray::{Array, ArrayRef, Axis, Dimension, Ix1, RemoveAxis};
 use num_traits::{Float, FromPrimitive, Zero};
 use std::ops::{Add, AddAssign, Div, Mul};
 
-/// Extension trait for `ArrayBase` providing methods
+/// Extension trait for `ArrayRef` providing methods
 /// to compute several summary statistics (e.g. mean, variance, etc.).
 pub trait SummaryStatisticsExt<A, D>
 where

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ impl<A: Ord> Histogram<A> {`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`
`74`		-/// Extension trait for `ArrayBase` providing methods to compute histograms.
	`74`	+/// Extension trait for `ArrayRef` providing methods to compute histograms.
`75`	`75`	`pub trait HistogramExt<A> {`
`76`	`76`	`/// Returns the [histogram](https://en.wikipedia.org/wiki/Histogram)`
`77`	`77`	/// for a 2-dimensional array of points `M`.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! The [`ndarray-stats`] crate exposes statistical routines for `ArrayBase`,
	`1`	+//! The [`ndarray-stats`] crate exposes statistical routines for `ArrayRef`,
`2`	`2`	//! the n-dimensional array data structure provided by [`ndarray`].
`3`	`3`	`//!`
`4`	`4`	`//! Currently available routines include:`
Original file line number	Diff line number	Diff line change
`@@ -260,7 +260,7 @@ impl<T> NotNone<T> {`
`260`	`260`	`}`
`261`	`261`	`}`
`262`	`262`
`263`		-/// Extension trait for `ArrayBase` providing NaN-related functionality.
	`263`	+/// Extension trait for `ArrayRef` providing NaN-related functionality.
`264`	`264`	`pub trait MaybeNanExt<A, D>`
`265`	`265`	`where`
`266`	`266`	`A: MaybeNan,`