ndarray-stats 0.6.0

Statistical routines for ArrayBase, the n-dimensional array data structure provided by ndarray.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# ndarray-stats

[![Coverage](https://codecov.io/gh/rust-ndarray/ndarray-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/rust-ndarray/ndarray-stats)
[![Dependencies status](https://deps.rs/repo/github/rust-ndarray/ndarray-stats/status.svg)](https://deps.rs/repo/github/rust-ndarray/ndarray-stats)
[![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.

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.

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/rust-ndarray/ndarray-stats/issues/1).

[`ndarray`]: https://github.com/rust-ndarray/ndarray

## Using with Cargo

```toml
[dependencies]
ndarray = "0.16"
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.

## Contributing

Please feel free to create issues and submit PRs.

## License

Copyright 2018–2024 `ndarray-stats` developers

Licensed under the [Apache License, Version 2.0](LICENSE-APACHE), or the [MIT
license](LICENSE-MIT), at your option. You may not use this project except in
compliance with those terms.