This crate is written in 100% safe Rust.
Insert Rstats = "^1" in the Cargo.toml file, under [dependencies].
Use in your source files any of the following structs, as and when needed:
rust
use Rstats::{RE,RError,TriangMat,Mstats,MinMax};
and any of the following traits:
rust
use Rstats::{Stats,Vecg,Vecu8,MutVecg,VecVec,VecVecg};
and any of the following auxiliary functions:
rust
use Rstats::{noop,fromop,sumn,t_stat,unit_matrix,re_error};
The latest (nightly) version is always available in the github repository Rstats. Sometimes it may be (only in some details) a little ahead of the crates.io release versions.
It is highly recommended to read and run tests.rs for examples of usage. To run all the tests, use a single thread in order not to print the results in confusing mixed-up order:
bash
cargo test --release -- --test-threads=1 --nocapture
However, geometric_medians, which compares multithreading performance, should be run separately in multiple threads, as follows:
bash
cargo test -r geometric_medians -- --nocapture
Alternatively, just to get a quick idea of the methods provided and their usage, read the output produced by an automated test run. There are test logs generated for each new push to the github repository. Click the latest (top) one, then Rstats and then Run cargo test ... The badge at the top of this document lights up green when all the tests have passed and clicking it gets you to these logs as well.
Any compilation errors arising out of rstats crate indicate most likely that some of the dependencies are out of date. Issuing cargo update command will usually fix this.
Rstats has a small footprint. Only the best methods are implemented, primarily with Data Analysis and Machine Learning in mind. They include multidimensional ('nd' or 'hyperspace') analysis, i.e. characterising clouds of n points in space of d dimensions.
Several branches of mathematics: statistics, information theory, set theory and linear algebra are combined in this one consistent crate, based on the abstraction that they all operate on the same data objects (here Rust Vecs). The only difference being that an ordering of their components is sometimes assumed (in linear algebra, set theory) and sometimes it is not (in statistics, information theory, set theory).
Rstats begins with basic statistical measures, information measures, vector algebra and linear algebra. These provide self-contained tools for the multidimensional algorithms but they are also useful in their own right.
Non analytical (non parametric) statistics is preferred, whereby the 'random variables' are replaced by vectors of real data. Probabilities densities and other parameters are in preference obtained from the real data (pivotal quantity), not from some assumed distributions.
Linear algebra uses generic data structure Vec<Vec<T>> capable of representing irregular matrices.
Struct TriangMat is defined and used for symmetric, anti-symmetric, and triangular matrices, and their transposed versions, saving memory.
Our treatment of multidimensional sets of points is constructed from the first principles. Some original concepts, not found elsewhere, are defined and implemented here (see the next section).
Zero median vectors are generally preferred to commonly used zero mean vectors.
In n dimensions, many authors 'cheat' by using quasi medians (one dimensional (1d) medians along each axis). Quasi medians are a poor start to stable characterisation of multidimensional data. Also, they are actually slower to compute than is our gm (true geometric median), as soon as the number of dimensions exceeds trivial numbers.
Specifically, all such 1d measures are sensitive to the choice of axis and thus are affected by their rotation.
In contrast, our methods based on gm are axis (rotation) independent. Also, they are more stable, as medians have a 50% breakdown point (the maximum possible).
We compute geometric medians by methods gmedian and its parallel version par_gmedian in trait VecVec and their weighted versions wgmedian and par_wgmedian in trait VecVecg. It is mostly these efficient algorithms that make our new concepts described below practical.
For more detailed comments, plus some examples, see rstats in docs.rs. You may have to go directly to the modules source. These traits are implemented for existing 'out of this crate' rust Vec type and rust docs do not display 'implementations on foreign types' very well.
zero median points (or vectors) are obtained by moving the origin of the coordinate system to the median (in 1d), or to the gm (in nd). This is our proposed alternative to the commonly used zero mean points, obtained by moving the origin to the arithmetic mean (in 1d) or to the arithmetic centroid (in nd).
median correlation between two 1d sets of the same length.
We define this correlation similarly to Pearson, as cosine of an angle between two normalised samples of numbers, interpreted as coordinate vectors. Pearson first normalises each set by subtracting its mean from all components. Whereas we subtract the median, cf. zero median points in 1d, above. This conceptual clarity is one of the benefits of interpreting a data sample of length d as a single point (or vector) in d dimensional space.
gmedian, par_gmedian, wgmedian and par_wgmedian
our fast multidimensional geometric median (gm) algorithms.
madgm (median of distances from gm)
is our generalisation of mad (median of absolute deviations from median), to n dimensions. 1d median is replaced in nd by gm. Where mad was a robust measure of 1d data spread, madgm becomes a robust measure of nd data spread. We define it as: median(|pi-gm|,for i=1..n), where p1..pn are a sample of n data points, which are no longer scalars but d dimensional vectors.
tm_stat
t-stat, defined as (x-mean)/std, where std is standard deviation, is similar to familiar standard(z)-score, except that its scalar measures of central tendency and spread are obtained from the sample (pivotal quantity), rather than from the assumed population distribution. Here, we define improved tm_stat of single scalar observation x as: (x-median)/mad, replacing mean by median and std by mad.
tm_statistic
we then generalize tm_stat from scalar domain to vector domain of any number of dimensions, defining tm_statistic as |p-gm|/madgm, where p is now an observation point in nd space. The sample central tendency is now the geometric median gm vector and the spread is the madgm scalar. The (error) distance of observation p from gm is also a scalar. Thus tm_statistic is, just like tm_stat, a simple scalar measure, regardless the dimensionality of the vector space.
contribution
one of the key questions of Machine Learning (ML) is how to quantify the contribution that each example point (typically a member of some large nd set) makes to the recognition concept, or class, represented by that set. In answer to this, we define the contribution of a point p as the magnitude of displacement of gm, caused by adding p to the set. Generally, outlying points make greater contributions to the gm but not as much as to the centroid. The contribution depends not only on the radius of p but also on the radii of all other existing set points.
comediance
another new concept. It is similar to covariance. It is a triangular symmetric matrix, obtained by supplying covar with the geometric median instead of the usual centroid. Thus zero mean vectors are replaced by zero median vectors as the data for the covariance calculations. The results are similar but more stable with respect to the outliers.
outer hull is a subset of all zero median points p, such that no other points lie outside the normal plane through p. The points that do not satisfy this condition are called the internal points.
inner hull is a subset of all zero median points p, that do not lie outside the normal plane of any other point. Note that in a highly dimensional space up to all points may belong to both the inner and the outer hulls (as, for example, when they lie on a hypersphere).
insideness is a measure of likelihood of zero median point p belonging to a data cloud s. More specifically, it is the proportion of points belonging to s falling outside the normal through p. For example, all outer hull points have by definition insideness = 0. This is not nearly as fast as is simple distance of p from gm but it is more sophisticated, taking into account the local shape of s near p. Mahalanobis distance has a similar goal but is less specific. When s contains only precomputed outer hull points, the computation will be somewhat faster.
signature vector
Frequencies of points in all hemispheres. The origin will most often be the gm. For a new point p that needs to be classified, we can quickly estimate whether it lies in a well populated direction from gm. This could be done properly by projecting all the existing points onto unit p but that would be too slow, as there are typically too many such points. However, signature_vector needs to be precomputed only once and is then the only vector to be projected onto unit p. In keeping with the stability properties of medians, signature vector is only using counts of points, not their distances from gm.
centroid/centre/mean of an nd set.
Is the point, generally non member, that minimises its sum of squares of distances to all member points. The squaring makes it susceptible to outliers. Specifically, it is the d-dimensional arithmetic mean. 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 usage: Centroid = Centre = Arithmetic Mean.
quasi/marginal median
is the point minimising sums of distances separately in each dimension (its coordinates are medians along each axis). It is a mistaken concept which we do not recommend using.
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 its advantages over the geometric median are not clear.
true geometric median (gm)
is the point (generally non member), which minimises the sum of distances to all member points. This is the one we want. It is much less susceptible to outliers than the centroid. In addition, unlike quasi median, gm is rotation independent.
medoid
is the member of the set with the least sum of distances to all other members. Equivalently, the member which is the nearest to the gm (has the minimum radius).
outlier
is the member of the set with the greatest sum of distances to all other members. Equivalently, it is the point furthest from the gm (has the maximum radius).
Mahalanobis distance
is a scaled distance, whereby the scaling is derived from the axis of covariance / comediance of the data points cloud. Distances in the directions in which there are few points are increased and distances in the directions of significant covariances / comediances are decreased.
Cholesky-Banachiewicz matrix decomposition
decomposes any positive definite matrix S (often covariance or comediance) into a product of two triangular matrices: S = LL'. The eigenvalues and the determinant are easily obtained from the diagonal. We implemented it on TriangMat for maximum efficiency. Is used by mahalanobis distance.
Householder's decomposition
in cases where the precondition (positive definite matrix) for the Cholesky-Banachiewicz (LL') decomposition is not satisfied, Householder's (UR) decomposition is often the next best method. Implemented here with our memory efficient TriangMat struct.
wedge product, geometric product
products of the Grassman and Clifford algebras. Wedge product is used here to generalize the cross product of two vectors into any number of dimensions.
The main constituent parts of Rstats are its traits. The different traits are determined by the types of objects to be handled. The objects are mostly vectors of arbitrary length/dimensionality (d). The main traits are implementing methods applicable to:
Stats: a single vector (of numbers),Vecg: methods operating on two vectors, e.g. scalar product,Vecu8: some methods specialized for end-type u8,MutVecg: some of the above methods, mutating self,VecVec: methods operating on n vectors (rows of numbers),VecVecg: methods for n vectors, plus another generic argument, e.g. a vector of weights.The traits and their methods operate on arguments of their required categories. In classical statistical parlance, the main categories correspond to the number of 'random variables'.
Vec<Vec<T>> type is used for rectangular matrices (could also have irregular rows).
struct TriangMat is used for symmetric / antisymmetric / transposed / triangular matrices and wedge and geometric products. All instances of TriangMat store only n*(n+1)/2 items in a single flat vector, instead of n*n, thus almost halving the memory requirements. Their transposed versions only set up a flag kind >=3 that is interpreted by software, instead of unnecessarily rewriting the whole matrix. Thus saving some processing as well. All this is put to a good use in our implementation of the matrix decomposition methods.
The vectors' end types (of the actual data) are mostly generic: usually some numeric type. Copy trait bounds on these generic input types have been relaxed to Clone, to allow you to clone your own complex data end types in any way you choose. There is no difference to the users for ordinary simple types.
The computed results end types are mostly f64.
Rstats crate produces custom error RError:
rust
pub enum RError<T> where T:Sized+Debug {
/// Insufficient data
NoDataError(T),
/// Wrong kind/size of data
DataError(T),
/// Invalid result, such as prevented division by zero
ArithError(T),
/// Other error converted to RError
OtherError(T)
}
Each of its enum variants also carries a generic payload T. Most commonly this will be a String message, giving more helpful explanation, e.g.:
rust
if dif <= 0_f64 {
return Err(RError::ArithError(format!(
"cholesky needs a positive definite matrix {}", dif )));
};
format!(...) is used to insert values of variables to the payload String, as shown. These errors are returned and can then be automatically converted (with ?) to users' own errors. Some such error conversions are implemented at the bottom of errors.rs file and used in tests.rs.
There is a type alias shortening return declarations to, e.g.: Result<Vec<f64>,RE>, where
rust
pub type RE = RError<String>;
Convenience function re_error can be used to construct these errors with either String or &str payload messages, as follows:
rust
if denom == 0. {
return Err(re_error("arith","Attempted division by zero!"));
};
struct MStatsholds the central tendency of 1d data, e.g. some kind of mean or median, and its spread measure, e.g. standard deviation or 'mad'.
struct TriangMatholds triangular matrices of all kinds, as described in Implementation section above. Beyond the usual conversion to full matrix form, a number of (the best) Linear Algebra methods are implemented directly on TriangMat, in module triangmat.rs, such as:
mahalanobis.Some methods implemented for VecVecg also produce TriangMat matrices, specifically the covariance/comedience calculations: covar and wcovar. Their results are positive definite, which makes the most efficient Cholesky-Banachiewicz decomposition applicable.
Most methods in medians::Median trait and some methods in indxvec crate, e.g. hashort, find_any and find_all, require explicit closure passed to them, usually to tell them how to quantify input data of any type T, into f64. Variety of different quantifying methods can then be dynamically employed.
For example, in text analysis (&str type), it can be the word length, or the numerical value of its first few bytes, or the numerical value of its consonants, etc. Then we can sort them or find their means / medians / spreads under these different measures. We do not necessarily want to explicitly store all such quantifications, as data can be voluminous. Rather, we want to be able to compute any of them on demand.
noopis a shorthand dummy function to supply to these methods, when the data is already of f64 end type. The second line is the full equivalent version that can be used instead:
rust
noop
|f:&f64| *f
asopWhen T is a wide primitive type, such as i64, u64, usize, that can only be converted to f64 by explicit truncation, we can use:
rust
|f:&T| *f as f64
fromopWhen T is a narrow numeric type, or is convertible by an existing From implementation, and f64:From<T> has been duly added everywhere as a trait bound, then we can pass in one of these:
rust
fromop
|f:&T| (*f).clone().into()
All other cases were previously only possible with manual implementation written for the (global) From trait for each type and each different quantification method, whereby the different quantification would conflict with each other. Now the user can simply pass in a custom 'quantify' closure. This generality is obtained at the price of a small inconvenience: using the above signature closures in simple cases.
sumn: the sum of the sequence 1..n = n*(n+1)/2. It is also the size of a lower/upper triangular matrix.
t_stat: of a value x: (x-centre)/spread. In one dimension.
unit_matrix: - generates full square unit matrix.
re_error - helps to construct custom RE errors (see Errors above).
One dimensional statistical measures implemented for all numeric end 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 RError(s), such as an empty input. This means you have to apply ? to their results to pass the errors up, or explicitly match them to take recovery actions, depending on the error variant.
Included in this trait are:
Note that a fast implementation of 1d 'classic' medians is, as of version 1.1.0, provided in a separate crate medians.
Generic vector algebra operations between two slices &[T], &[U] of any (common) length (dimensions). Note that it may be necessary to invoke some using the 'turbofish' ::<type> syntax to indicate the type U of the supplied argument, e.g.:
rust
datavec.somemethod::<f64>(arg)
Methods implemented by this trait:
Contribution measure of a point's impact on the geometric medianNote that our median correlation is implemented in a separate crate medians.
Some simpler methods of this trait may be unchecked (for speed), so some caution with data is advisable.
A select few of the Stats and Vecg methods (e.g. mutable vector addition, subtraction and multiplication) are reimplemented under this trait, so that they can mutate self in-place. This is more efficient and convenient in some circumstances, such as in vector iterative methods.
However, these methods do not fit in with the functional programming style, as they do not explicitly return anything (their calls are statements with side effects, rather than expressions).
Some vector algebra as above that can be more efficient when the end type happens to be u8 (bytes). These methods have u8 appended to their names to avoid confusion with Vecg methods. These specific algorithms are different to their generic equivalents in Vecg.
Relationships between n vectors in d dimensions.
This (hyper-dimensional) data domain is denoted here as (nd). It is in nd where the main original contribution of this library lies. True geometric median (gm) is found by fast and stable iteration, using improved Weiszfeld's algorithm gmedian. This algorithm solves Weiszfeld's convergence and stability problems in the neighbourhoods of existing set points. Its variant, par_gmedian, employs multithreading for faster execution and gives otherwise the same result.
nd points,Methods which take an additional generic vector argument, such as a vector of weights for computing weighted geometric medians (where each point has its own weight). Matrices multiplications.
Version 1.3.0 - Renamed t_stat -> tm_stat and t_statistic -> tm_statistic to avoid potential confusion with classical t-statistic. Added insideness of nd points. Improved hulls algorithms and their tests. Changed sigvec and dotsig.
Version 1.2.52 - Added explicit inner_hull and outer_hull.
Version 1.2.51 - Upped dependency on medians to version 2.3.
Version 1.2.50 - Upped dependency on indxvec to version 1.8. Added error checking to 'contribution' methods in trait Vecg.
Version 1.2.49 - Added wradii. Some more code rationalizations.
Version 1.2.48 - Added also weighted scalar_wfn and vector_wfn to trait VecVecg. Also wdivsmed.
Version 1.2.47 - Added scalar_fn and vector_fn to trait VecVec. These apply arbitrary scalar valued or vector valued closures to all vectors in self. This generality allows some code rationalization.
Version 1.2.45 - Completed trait bounds relaxation and simplification. Some minor documentation improvements.
Version 1.2.44 - Swapped the sign of wedge so it agrees with convention.
Version 1.2.43 - Removed pseudoscalar method. The sine method now computes the correct oriented magnitude of the 2-blade directly from the wedge product. Added geometric product geometric. Added some methods to struct TriangMat for completeness. In particular, eigenvalues and determinant, which are both easily obtained after successful Cholesky decomposition.
Version 1.2.42 - Added wedge (product of Exterior Algebra), pseudoscalar and sine to trait Vecg. The sine method now always returns the correct anti reflexive sign, in any number of dimensions. The sign flips when the order of the vector operands is exchanged.
Version 1.2.41 - Added anglestat to VecVecg trait. Added convenience function re_error. Relaxed trait bounds in Vecg trait: U:Copy -> U:Clone. Renamed tukeydot,tukeyvec,wtukeyvec to more descriptive sigdot,sigvec,wsigvec and made them include orthogonal points.
Version 1.2.40 - Fixed dependencies in times 1.0.10 as well.