From dda1d1017b71a6433f79aad45abec04add74b998 Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:07:45 +0100 Subject: [PATCH 01/12] Use v0.8.0 for itertools --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 505419d4..72dfeb5a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -20,7 +20,7 @@ noisy_float = "0.1.8" num-integer = "0.1" num-traits = "0.2" rand = "0.6" -itertools = { version = "0.7.0", default-features = false } +itertools = { version = "0.8.0", default-features = false } indexmap = "1.0" [dev-dependencies] From 921bea18d52ba063d16d089565cafd9eb372d7b3 Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:08:04 +0100 Subject: [PATCH 02/12] Update version number --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 72dfeb5a..08f1c2ad 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ndarray-stats" -version = "0.1.0" +version = "0.2.0" authors = ["Jim Turner ", "LukeMathWalker "] license = "MIT/Apache-2.0" From 23c4d07285bef5739811a78563d99ddf79bd8d2a Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:19:33 +0100 Subject: [PATCH 03/12] Add release notes --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index fb383c10..a55cc4b9 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,30 @@ ndarray-stats = "0.1" ## Releases +* **0.2.0** + + * 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 + * Improvements: + * Redesigned error handling across the whole crate (standardise on `Result` with `ErrorKind` where needed) + + Contributors: @jturner314, @LukeMathWalker, @phungleson, @munckymagik + * **0.1.0** * Initial release by @LukeMathWalker and @jturner314. From 4e88a3ee8e96ae5ebc8f392df481208a9f4e709f Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:21:23 +0100 Subject: [PATCH 04/12] Nitpicks - we now have a solid amount of routines implemented --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a55cc4b9..9843ee08 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ the [documentation](https://docs.rs/ndarray-stats) for more information. [`ndarray`]: https://github.com/bluss/ndarray -Only some statistical routines are implemented. Please feel free to contribute -new functionality! +Please feel free to contribute new functionality! ## Using with Cargo @@ -42,11 +41,11 @@ ndarray-stats = "0.1" * `argmax` / `argmax_skipnan` * Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`) * Fixes: - * Reduced occurrences of overflow for interpolate::midpoint + * Reduced occurrences of overflow for `interpolate::midpoint` * Improvements: * Redesigned error handling across the whole crate (standardise on `Result` with `ErrorKind` where needed) - Contributors: @jturner314, @LukeMathWalker, @phungleson, @munckymagik + *Contributors*: @jturner314, @LukeMathWalker, @phungleson, @munckymagik * **0.1.0** From e3024d2f5356d3ec7c597f86c8ac0e97e062848f Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:22:40 +0100 Subject: [PATCH 05/12] Add links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9843ee08..9f688063 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ ndarray-stats = "0.1" * Improvements: * Redesigned error handling across the whole crate (standardise on `Result` with `ErrorKind` where needed) - *Contributors*: @jturner314, @LukeMathWalker, @phungleson, @munckymagik + *Contributors*: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik) * **0.1.0** From 1e6abba7f784f855cdc61cdb39dc001c22e564ec Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:22:55 +0100 Subject: [PATCH 06/12] Update version in Cargo.toml example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f688063..df77087a 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Please feel free to contribute new functionality! ```toml [dependencies] ndarray = "0.12.1" -ndarray-stats = "0.1" +ndarray-stats = "0.2" ``` ## Releases From c5281dfd61296ea7b2170927365d7a51b6aa333f Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:25:48 +0100 Subject: [PATCH 07/12] Add summary statistics to brief menu --- src/lib.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 6a7cdf38..c871bf35 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,7 +2,8 @@ //! the *n*-dimensional array data structure provided by [`ndarray`]. //! //! Currently available routines include: -//! - [order statistics] (minimum, maximum, quantiles, etc.); +//! - [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.); @@ -18,6 +19,7 @@ //! [`ndarray`]: https://github.com/rust-ndarray/ndarray //! [order statistics]: trait.QuantileExt.html //! [partitioning]: trait.Sort1dExt.html +//! [summary statistics]: trait.SummaryStatisticsExt.html //! [correlation analysis]: trait.CorrelationExt.html //! [measures from information theory]: trait.EntropyExt.html //! [histogram computation]: histogram/index.html From aace8d3469732ed22e23513c53c3b74c3c9ee958 Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:27:34 +0100 Subject: [PATCH 08/12] Add some info directly in the README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index df77087a..460995d9 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,19 @@ [![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. See -the [documentation](https://docs.rs/ndarray-stats) for more information. +This crate provides statistical methods for [`ndarray`]'s `ArrayBase` type. -[`ndarray`]: https://github.com/bluss/ndarray +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.); +- histogram computation. -Please feel free to contribute new functionality! +See the [documentation](https://docs.rs/ndarray-stats) for more information. + +Please feel free to contribute new functionality! A roadmap can be found [here](https://github.com/jturner314/ndarray-stats/issues/1). ## Using with Cargo From b387fa106817709e059f63be72bce6e093e5a939 Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Tue, 9 Apr 2019 20:28:07 +0100 Subject: [PATCH 09/12] Add ndarray link --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 460995d9..c27693fc 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ See the [documentation](https://docs.rs/ndarray-stats) for more information. Please feel free to contribute new functionality! A roadmap can be found [here](https://github.com/jturner314/ndarray-stats/issues/1). +[`ndarray`]: https://github.com/rust-ndarray/ndarray + ## Using with Cargo ```toml From 3864af56a61327d63dc8f1608a568a8da0eb24ff Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Fri, 12 Apr 2019 08:34:14 +0100 Subject: [PATCH 10/12] Drop ErrorKind --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c27693fc..4e82f989 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ ndarray-stats = "0.2" * Fixes: * Reduced occurrences of overflow for `interpolate::midpoint` * Improvements: - * Redesigned error handling across the whole crate (standardise on `Result` with `ErrorKind` where needed) + * Redesigned error handling across the whole crate, standardising on `Result` *Contributors*: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik) From 9788e579205c3072e23f6912b5a561ed81767a13 Mon Sep 17 00:00:00 2001 From: LukeMathWalker Date: Fri, 12 Apr 2019 09:04:53 +0100 Subject: [PATCH 11/12] Add a note on extension traits on the changelog --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4e82f989..deca17a9 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ ndarray-stats = "0.2" * Improvements: * Redesigned error handling across the whole crate, standardising on `Result` + All `ndarray-stats`' extension traits are now impossible to implement by users of the library (see [issue](https://github.com/jturner314/ndarray-stats/issues/34)) *Contributors*: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik) * **0.1.0** From e92ed1c3ae3fbebedb163b816b56cfb5ed9ad1c6 Mon Sep 17 00:00:00 2001 From: Jim Turner Date: Fri, 12 Apr 2019 18:40:00 -0400 Subject: [PATCH 12/12] Rearrange 0.2.0 changes --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index deca17a9..54fa5b3d 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,15 @@ ndarray-stats = "0.2" * Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`) * Fixes: * Reduced occurrences of overflow for `interpolate::midpoint` - * Improvements: + * Improvements / breaking changes: * Redesigned error handling across the whole crate, standardising on `Result` + * All `ndarray-stats`' extension traits are now impossible to implement by + users of the library (see [#34]) - All `ndarray-stats`' extension traits are now impossible to implement by users of the library (see [issue](https://github.com/jturner314/ndarray-stats/issues/34)) *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/jturner314/ndarray-stats/issues/34 + * **0.1.0** * Initial release by @LukeMathWalker and @jturner314.