Skip to content

Commit 4aff84a

Browse files
committed
Remove autoformat of README
1 parent 98ddf72 commit 4aff84a

File tree

1 file changed

+99
-104
lines changed

1 file changed

+99
-104
lines changed

README.md

Lines changed: 99 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@
88
This crate provides statistical methods for [`ndarray`]'s `ArrayRef` type.
99

1010
Currently available routines include:
11-
12-
- order statistics (minimum, maximum, median, quantiles, etc.);
13-
- summary statistics (mean, skewness, kurtosis, central moments, etc.)
14-
- partitioning;
15-
- correlation analysis (covariance, pearson correlation);
16-
- measures from information theory (entropy, KL divergence, etc.);
17-
- deviation functions (distances, counts, errors, etc.);
18-
- histogram computation.
11+
- order statistics (minimum, maximum, median, quantiles, etc.);
12+
- summary statistics (mean, skewness, kurtosis, central moments, etc.)
13+
- partitioning;
14+
- correlation analysis (covariance, pearson correlation);
15+
- measures from information theory (entropy, KL divergence, etc.);
16+
- deviation functions (distances, counts, errors, etc.);
17+
- histogram computation.
1918

2019
See the [documentation](https://docs.rs/ndarray-stats) for more information.
2120

@@ -33,102 +32,98 @@ ndarray-stats = "0.6.0"
3332

3433
## Releases
3534

36-
- **0.6.0**
37-
38-
- Breaking changes
39-
40-
- Minimum supported Rust version: `1.64.0`
41-
- Updated to `ndarray:v0.16.0`
42-
- Updated to `approx:v0.5.0`
43-
44-
- Updated to `ndarray-rand:v0.15.0`
45-
- Updated to `indexmap:v2.4`
46-
- Updated to `itertools:v0.13`
47-
48-
_Contributors_: [@bluss](https://github.com/bluss)
49-
50-
- **0.5.1**
51-
52-
- Fixed bug in implementation of `MaybeNaN::remove_nan_mut` for `f32` and
53-
`f64` for views with non-standard layouts. Before this fix, the bug could
54-
cause incorrect results, buffer overflows, etc., in this method and others
55-
which use it. Thanks to [@JacekCzupyt](https://github.com/JacekCzupyt) for
56-
reporting the issue (#89).
57-
- Minor docs improvements.
58-
59-
_Contributors_: [@jturner314](https://github.com/jturner314), [@BenMoon](https://github.com/BenMoon)
60-
61-
- **0.5.0**
62-
63-
- Breaking changes
64-
- Minimum supported Rust version: `1.49.0`
65-
- Updated to `ndarray:v0.15.0`
66-
67-
_Contributors_: [@Armavica](https://github.com/armavica), [@cassiersg](https://github.com/cassiersg)
68-
69-
- **0.4.0**
70-
71-
- Breaking changes
72-
- Minimum supported Rust version: `1.42.0`
73-
- New functionality:
74-
- Summary statistics:
75-
- Weighted variance
76-
- Weighted standard deviation
77-
- Improvements / breaking changes:
78-
- Documentation improvements for Histograms
79-
- Updated to `ndarray:v0.14.0`
80-
81-
_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)
82-
83-
- **0.3.0**
84-
85-
- Breaking changes
86-
- Minimum supported Rust version: `1.37`
87-
- New functionality:
88-
- Deviation functions:
89-
- Counts equal/unequal
90-
- `l1`, `l2`, `linf` distances
91-
- (Root) mean squared error
92-
- Peak signal-to-noise ratio
93-
- Summary statistics:
94-
- Weighted sum
95-
- Weighted mean
96-
- Improvements / breaking changes:
97-
- Updated to `ndarray:v0.13.0`
98-
99-
_Contributors_: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker)
100-
101-
- **0.2.0**
102-
103-
- Breaking changes
104-
- All `ndarray-stats`' extension traits are now impossible to implement by
105-
users of the library (see [#34])
106-
- Redesigned error handling across the whole crate, standardising on `Result`
107-
- New functionality:
108-
- Summary statistics:
109-
- Harmonic mean
110-
- Geometric mean
111-
- Central moments
112-
- Kurtosis
113-
- Skewness
114-
- Information theory:
115-
- Entropy
116-
- Cross-entropy
117-
- Kullback-Leibler divergence
118-
- Quantiles and order statistics:
119-
- `argmin` / `argmin_skipnan`
120-
- `argmax` / `argmax_skipnan`
121-
- Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`)
122-
- Fixes:
123-
- Reduced occurrences of overflow for `interpolate::midpoint`
124-
125-
_Contributors_: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik)
126-
127-
[#34]: https://github.com/rust-ndarray/ndarray-stats/issues/34
128-
129-
- **0.1.0**
130-
131-
- Initial release by @LukeMathWalker and @jturner314.
35+
* **0.6.0**
36+
37+
* Breaking changes
38+
* Minimum supported Rust version: `1.64.0`
39+
* Updated to `ndarray:v0.16.0`
40+
* Updated to `approx:v0.5.0`
41+
42+
* Updated to `ndarray-rand:v0.15.0`
43+
* Updated to `indexmap:v2.4`
44+
* Updated to `itertools:v0.13`
45+
46+
*Contributors*: [@bluss](https://github.com/bluss)
47+
48+
* **0.5.1**
49+
* Fixed bug in implementation of `MaybeNaN::remove_nan_mut` for `f32` and
50+
`f64` for views with non-standard layouts. Before this fix, the bug could
51+
cause incorrect results, buffer overflows, etc., in this method and others
52+
which use it. Thanks to [@JacekCzupyt](https://github.com/JacekCzupyt) for
53+
reporting the issue (#89).
54+
* Minor docs improvements.
55+
56+
*Contributors*: [@jturner314](https://github.com/jturner314), [@BenMoon](https://github.com/BenMoon)
57+
58+
* **0.5.0**
59+
* Breaking changes
60+
* Minimum supported Rust version: `1.49.0`
61+
* Updated to `ndarray:v0.15.0`
62+
63+
*Contributors*: [@Armavica](https://github.com/armavica), [@cassiersg](https://github.com/cassiersg)
64+
65+
* **0.4.0**
66+
* Breaking changes
67+
* Minimum supported Rust version: `1.42.0`
68+
* New functionality:
69+
* Summary statistics:
70+
* Weighted variance
71+
* Weighted standard deviation
72+
* Improvements / breaking changes:
73+
* Documentation improvements for Histograms
74+
* Updated to `ndarray:v0.14.0`
75+
76+
*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)
77+
78+
* **0.3.0**
79+
80+
* Breaking changes
81+
* Minimum supported Rust version: `1.37`
82+
* New functionality:
83+
* Deviation functions:
84+
* Counts equal/unequal
85+
* `l1`, `l2`, `linf` distances
86+
* (Root) mean squared error
87+
* Peak signal-to-noise ratio
88+
* Summary statistics:
89+
* Weighted sum
90+
* Weighted mean
91+
* Improvements / breaking changes:
92+
* Updated to `ndarray:v0.13.0`
93+
94+
*Contributors*: [@munckymagik](https://github.com/munckymagik), [@nilgoyette](https://github.com/nilgoyette), [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker)
95+
96+
* **0.2.0**
97+
98+
* Breaking changes
99+
* All `ndarray-stats`' extension traits are now impossible to implement by
100+
users of the library (see [#34])
101+
* Redesigned error handling across the whole crate, standardising on `Result`
102+
* New functionality:
103+
* Summary statistics:
104+
* Harmonic mean
105+
* Geometric mean
106+
* Central moments
107+
* Kurtosis
108+
* Skewness
109+
* Information theory:
110+
* Entropy
111+
* Cross-entropy
112+
* Kullback-Leibler divergence
113+
* Quantiles and order statistics:
114+
* `argmin` / `argmin_skipnan`
115+
* `argmax` / `argmax_skipnan`
116+
* Optimized bulk quantile computation (`quantiles_mut`, `quantiles_axis_mut`)
117+
* Fixes:
118+
* Reduced occurrences of overflow for `interpolate::midpoint`
119+
120+
*Contributors*: [@jturner314](https://github.com/jturner314), [@LukeMathWalker](https://github.com/LukeMathWalker), [@phungleson](https://github.com/phungleson), [@munckymagik](https://github.com/munckymagik)
121+
122+
[#34]: https://github.com/rust-ndarray/ndarray-stats/issues/34
123+
124+
* **0.1.0**
125+
126+
* Initial release by @LukeMathWalker and @jturner314.
132127

133128
## Contributing
134129

0 commit comments

Comments
 (0)