Insert in your Cargo.toml file under [dependencies]
rstats = "^0.8"
and in your source file(s) use rstats:: followed by any of these functions and/or traits that you need: {functions, Stats, Vecf64, Vecu8, VecVecf64, VecVecu8, Mutvectors};
Rstats is primarily about characterising multidimensional sets of points, with applications to Machine Learning and Data Analysis. It begins with statistical measures and vector algebra, which provide some basic self-contained tools for the more interesting algorithms but can also be used in their own right.
Our treatment of multidimensional sets of points is constructed from the first principles. Some original concepts, not found elsewhere, are introduced and implemented here. Specifically, the new multidimensional (geometric) median algorithm. Also, the comediance matrix; a replacement for the covariance matrix. It is obtained simply by supplying covar with the geometric median instead of the centroid.
Zero median vectors are generally preferable to the commonly used zero mean vectors.
Most authors 'cheat' by using quasi medians (1-d medians along each axis). Quasi medians are a poor start to stable characterisation of multidimensional data. In a highly dimensional space, they are not even any easier to compute.
Specifically, all such 1-d measures are sensitive to the choice of axis.
Our methods based on the True Geometric Median, computed here by gmedian, are axis (rotation) independent from the first step.
The constituent parts of Rstats are Rust traits grouping together functions applicable to vectors of data of relevant end types.End type f64 is most commonly used. Facilities for other end types are limited. For lots of data of other end types, it is always possible to clone to f64, see for example the included utility function vecu8asvecf64.
Follow the documentation link. Then select a trait of interest to see the skeletal comments on the prototype function declarations in lib.rs. To see more detailed comments, plus some examples from the implementation files, scroll to the bottom of the trait and unclick [+] to the left of the implementations of the trait. To see the tests, consult tests/tests.rs.
To run the tests, use single thread. It will be slower but will produce the results in the right order:
cargo test --release -- --test-threads=1 --nocapture --color always
pub struct Med to hold median and quartiles
pub struct MStats to hold a mean and standard deviation
functions: wsum, genvec, genvecu8 (see documentation for the module functions.rs).
One dimensional statistical measures implemented for all 'numeric' types.
Its methods operate on one slice of generic data and take no arguments.
For example, s.amean() returns the arithmetic mean of the data in slice s.
These methods are checked and will report all kinds of errors, such as an empty input.
This means you have to call .unwrap() or something similar on their results.
Included in this trait are:
Vector algebra implemented on one or two &[f64] slices of any length (dimensionality):
This trait is sometimes unchecked (for speed), so some caution with data is advisable.
Some of the above functions are for memory efficiency reasons reimplemented in this trait so that they mutate self in place, instead of creating a new Vec. Clearly, they can only be applied to a mutable variable. They are useful in vector iterative methods. Beware that they work by side-effect and do not return anything, so they can not be chained.
Relationships of one vector to a set of vectors (of &[f64] end types):
Trait VecVec is entirely unchecked, so check your data upfront. This is the more sophisticated part of the library. The true geometric median is found iteratively.
Some of the above for vectors of vectors of bytes.
Centroid\Centre\Mean is the (generally non member) point that minimises the sum of squares of distances to all member points. Thus it is susceptible to outliers. Specifically, it is the n-dimensional arithmetic mean. By drawing physical analogy with gravity, it is sometimes called 'the centre of mass'. Centroid can also sometimes mean the member of the set which is the nearest to the Centre. Here we follow the common (if somewhat confusing) usage: Centroid = Centre = Arithmetic Mean.
Quasi\Marginal Median is the point minimising sums of distances separately in each dimension (its coordinates are 1-d medians along each axis). It is a mistaken concept which we do not use here.
Tukey Median is the point maximising Tukey's Depth, which is the minimum number of (outlying) points found in a hemisphere in any direction. Potentially useful concept but not yet implemented here, as its advantages over GM are not clear.
Medoid is the member of the set with the least sum of distances to all other members.
Outlier is the member of the set with the greatest sum of distances to all other members.
Median or the true geometric median (gm), is the point (generally non member), which minimises the sum of distances to all members. This is the one we want. It is much less susceptible to outliers and is rotation independent.
Zero median vector is obtained by subtracting the geometric median. This is a proposed alternative to the commonly used zero mean vector, obtained by subtracting the centroid.
Comediance is similar to covariance, except zero median vectors are used to compute it instead of zero mean vectors.
Version 0.8.3 Simplification of generic Stats. GSlice is no longer needed. The only restriction remaining is the necessity to explicitly convert &[i64] -> &[f64], using function statsg::i64tof64(s: &[i64]). All other end types are fine. This made possible the removal of two modules, statsf64.rs and stasi64.rs. They are now superceded by a single generic statsg.rs. This rationalisation work will continue with the remaining traits as well.
Version 0.8.2 Added statsgen.rs (generic) module to add the capability of applying the trait Stats to all numeric end types, as long as their slices are wrapped in GSlice(&s). This is a step towards more generality, as Stats methods can now work on all primitive numeric types. f64 and i64 remain as previously, so they should not be wrapped.
Version 0.8.0 Simplified, more stable version. Moved auxiliary macro here and functions wv,wi to crate indxvec. Tidied up the tests accordingly.
Version 0.7.17 Updated Cargo.toml dependency to indxvec = "^0.2".