IndxVec

Usage

Import into your source file(s) macro here, trait Indices and functions as needed. The trait Indices is implemented on type &[usize], i.e. subscripts to slices/vectors. The functions are in module merge.rs. They usually take generic slices &[T] as arguments and produce new index vectors and/or other results. The following use statement imports everything:

use indxvec::{MinMax,here,wv,wi,Indices,merge::*};

It is highly recommended that you read and run tests/tests.rs to learn from examples of usage. To run the tests, use a single thread. It may be slower but it will write the results in the right order:

cargo test --release -- --test-threads=1 --nocapture --color always

Description

Indxvec is a self-contained crate in terms of the subject matter. It does not have any dependencies. Some of its primitive elements are used by higher level crates sets and rstats.

The tools included are: efficient ranking, sorting, merging, searching, set operations and indices manipulations. They are applicable to generic slices &[T]. Thus they will work on Rust primitive types but also on slices holding any arbitrarily complex end type T of your own, as long as you implement for it the required traits, mostly just PartialOrd and/or Copy.

Functions

are in the module src/merge.rs. They mostly take some generic slice(s) &[T] and produce the indices into them of type Vec<usize>, onto which the methods of the Indices trait can be conveniently chained. See the documentation.

Trait Index

The methods of this trait are implemented for slices of subscripts, i.e. they take the type &[usize] as input (self) and produce new index Vec<usize>, new data vector Vec<T>, or other results as appropriate.

Release Notes (Latest First)

Version 0.2.12 - added utility function printvv to prettyprint vectors of vectors.

Version 0.2.11 - added some badges and improved readme.

Version 0.2.9 - added struct MinMax for returning values from function 'minmax' and displaying them. Removed function wt used previously for displaying them as tuples.

Version 0.2.6 - added unindexf64 for convenience. Same as unindex but the output is always converted to Vec<f64>.

Version 0.2.5 - added memsearchdesc_indexed = binary search of a descending indexed set.

Version 0.2.4 - added helper function wt = write tuple. Added memsearchdesc = binary search of a descending set.

Version 0.2.3 - general tidying up and readme update.

Version 0.2.2 - prettification of tests: replaced GV and GI with functions wv and wi respectively. Added revindex to Indices trait, so that it can be functionally chained with its other methods.

Version 0.2.1 - moved GI from rstats to here. Fixed minmax.