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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
#![warn(missing_docs)]
//! Vecs searching, indexing, ranking, sorting, merging, reversing, intersecting, printing, etc.
/// Implementation of trait Indices for `&[usize]`
pub mod indices;
/// Implementation of trait Mutops for `&mut[T]`
pub mod mutops;
/// Utilities for serializing, writing and printing (optionally in colours) generic vectors.
pub mod printing;
/// Implementation of trait Search for Range<T>
pub mod search;
/// Implementation of trait Vecops for `&[T]`
pub mod vecops;
use core::{cmp::Reverse, ops::Range};
use printing::*;
use std::{collections::BinaryHeap, fs::File, io, io::Write};
/// Macro `here!()` gives `&str` with the `file:line path::function-name` of where it was called from.
#[macro_export]
macro_rules! here {
() => {{
fn f() {}
fn type_name_of<T>(_: T) -> &'static str {
std::any::type_name::<T>()
}
let name = type_name_of(f);
format!("\n{}:{} {}", file!(), line!(), &name[..name.len() - 3])
}};
}
/// struct for minimum value, its index, maximum value, its index
#[derive(Default)]
pub struct MinMax<T> {
/// Minimum value
pub min: T,
/// Subscript (index) of the minimum
pub minindex: usize,
/// Maximum value
pub max: T,
/// Subscript (index) of the maximum
pub maxindex: usize,
}
/// Display implementation for MinMax struct
impl<T> std::fmt::Display for MinMax<T>
where
T: Clone + std::fmt::Display,
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(
f,
"min: {GR}{}{UN}, minindex: {YL}{}{UN}, max: {GR}{}{UN}, maxindex: {YL}{}{UN}",
self.min, self.minindex, self.max, self.maxindex
)
}
}
/// Trait to serialize tuples `&(T,T)` and `&(T,T,T)` and
/// slices `&[T]`, `&[&[T]]`, `&[Vec<T>]`.
/// Suitable for printing or writing to files pairs, triplets,
/// all kinds of Vecs and slices and irregularly shaped 2D matrices.
/// All are converted into Strings and optionally decorated and coloured.
/// Included are methods and constants to render the resulting String
/// in six primary bold ANSI terminal colours.
pub trait Printing<T>
where
Self: Sized,
{
/// Printable in red
fn rd(self) -> String {
format!("{RD}{}{UN}", self.to_str())
}
/// Printable in green
fn gr(self) -> String {
format!("{GR}{}{UN}", self.to_str())
}
/// Printable in blue
fn bl(self) -> String {
format!("{BL}{}{UN}", self.to_str())
}
/// Printable in yellow
fn yl(self) -> String {
format!("{YL}{}{UN}", self.to_str())
}
/// Printable in magenta
fn mg(self) -> String {
format!("{MG}{}{UN}", self.to_str())
}
/// Printable in cyan
fn cy(self) -> String {
format!("{CY}{}{UN}", self.to_str())
}
/// Method to write vector(s) to file f (space separated, without brackets).
/// Passes up io errors
fn wvec(self, f: &mut File) -> Result<(), io::Error> {
Ok(write!(*f, "{} ", self.to_plainstr())?)
}
/// Method to print vector(s) to stdout (space separated,without brackets).
fn pvec(self) {
print!("{} ", self.to_plainstr())
}
/// Method to serialize.
/// Decorates Vecs with square brackets and tuples with round ones.
/// Implementation code is in `printing.rs`.
fn to_str(self) -> String;
/// Method to serialize in minimal form (space separated, no brackets)
/// Implementation code is in `printing.rs`.
fn to_plainstr(self) -> String;
}
/// Binary search algoritms implemented on RangeInclusive<T>.
/// Using a closure `cmpr` to sample and compare data to captured target.
pub trait Search<T, U> {
/// Unchecked first hit or insert order, and the final search range.
fn binary_any(&self, cmpr: U) -> (T, Range<T>);
/// General Binary Search, returns the range of all matching items
fn binary_all(&self, cmpr: U) -> Range<T>;
}
/// Methods to manipulate indices of `Vec<usize>` type.
pub trait Indices {
/// Indices::newindex(n) creates a new index without reordering
fn newindex(n: usize) -> Vec<usize> {
Vec::from_iter(0..n)
}
/// Invert an index - turns a sort order into rank order and vice-versa
fn invindex(self) -> Vec<usize>;
/// complement of an index - reverses the ranking order
fn complindex(self) -> Vec<usize>;
/// Collect values from `v` in the order of indices in self.
fn unindex<T>(self, v: &[T], ascending: bool) -> Vec<T>
where
T: Clone;
/// Correlation coefficient of two &[usize] slices.
/// Pearsons on raw data, Spearman's when applied to ranks.
fn ucorrelation(self, v: &[usize]) -> f64;
/// Potentially useful clone-recast of &[usize] to Vec<f64>
fn indx_to_f64(self) -> Vec<f64>;
}
/// Methods to manipulate generic Vecs and slices of type `&[T]`
pub trait Vecops<T> {
/// Helper function to copy and cast entire &[T] to `Vec<f64>`.
fn tof64(self) -> Vec<f64>
where
T: Clone,
f64: From<T>;
/// Maximum value in self
fn maxt(self) -> T
where
T: PartialOrd + Clone;
/// Minimum value in self
fn mint(self) -> T
where
T: PartialOrd + Clone;
/// Minimum and maximum values in self
fn minmaxt(self) -> (T, T)
where
T: PartialOrd + Clone;
/// Returns MinMax{min, minindex, max, maxindex}
fn minmax(self) -> MinMax<T>
where
T: PartialOrd + Clone;
/// MinMax of n items starting at subscript i
fn minmax_slice(self, i: usize, n: usize) -> MinMax<T>
where
T: PartialOrd + Clone;
/// MinMax of a subset of self, defined by its idx subslice between i,i+n.
fn minmax_indexed(self, idx: &[usize], i: usize, n: usize) -> MinMax<T>
where
T: PartialOrd + Clone;
/// Reversed copy of self
fn revs(self) -> Vec<T>
where
T: Clone;
/// Repeated items removed
fn sansrepeat(self) -> Vec<T>
where
T: PartialEq + Clone;
/// Some(subscript) of the first occurence of m, or None
fn member(self, m: T, forward: bool) -> Option<usize>
where
T: PartialEq + Clone;
/// Counts partially equal occurrences of val by simple linear search of an unordered set
fn occurs(self, val: T) -> usize
where
T: PartialOrd;
/// Unites (concatenates) two unsorted slices. For union of sorted slices, use `merge`
fn unite_unsorted(self, v: &[T]) -> Vec<T>
where
T: Clone;
/// Unites two ascending index-sorted slices.
fn unite_indexed(self, ix1: &[usize], v2: &[T], ix2: &[usize]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Intersects two ascending explicitly sorted generic vectors.
fn intersect(self, v2: &[T]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Intersects two ascending index sorted vectors.
fn intersect_indexed(self, ix1: &[usize], v2: &[T], ix2: &[usize]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Removes items of sorted v2 from sorted self.
fn diff(self, v2: &[T]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Removes items of v2 from self using their sort indices.
fn diff_indexed(self, ix1: &[usize], v2: &[T], ix2: &[usize]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Divides an unordered set into three: items smaller than pivot, equal, and greater
fn partition(self, pivot: T) -> (Vec<T>, Vec<T>, Vec<T>)
where
T: PartialOrd + Clone;
/// Divides an unordered set into three by the pivot. The results are subscripts to self
fn partition_indexed(self, pivot: T) -> (Vec<usize>, Vec<usize>, Vec<usize>)
where
T: PartialOrd + Clone;
/// Binary Search. Automatic descending order detection.
fn binsearch(self, target: &T) -> Range<usize>
where
T: PartialOrd + Copy;
/// Binary Search via index. Automatic descending order detection
fn binsearch_indexed(self, idx: &[usize], target: &T) -> Range<usize>
where
T: PartialOrd + Copy;
/// Merges (unites) two sorted sets, result is also sorted
fn merge(self, v2: &[T]) -> Vec<T>
where
T: PartialOrd + Clone;
/// Merges (unites) two sets, using their sort indices, giving also the resulting sort index
fn merge_indexed(self, idx1: &[usize], v2: &[T], idx2: &[usize]) -> (Vec<T>, Vec<usize>)
where
T: PartialOrd + Clone;
/// Used by `merge_indexed`
fn merge_indices(self, idx1: &[usize], idx2: &[usize]) -> Vec<usize>
where
T: PartialOrd + Clone;
/// Stable Merge sort main method, giving sort index
fn mergesort_indexed(self) -> Vec<usize>
where
T: PartialOrd + Clone;
/// Utility used by mergesort_indexed
fn mergesortslice(self, i: usize, n: usize) -> Vec<usize>
where
T: PartialOrd + Clone;
/// Stable Merge sort, explicitly sorted result obtained via mergesort_indexed
fn sortm(self, ascending: bool) -> Vec<T>
where
T: PartialOrd + Clone;
/// Rank index obtained via mergesort_indexed
fn rank(self, ascending: bool) -> Vec<usize>
where
T: PartialOrd + Clone;
/// Utility, swaps any two items into ascending order
fn isorttwo(self, idx: &mut [usize], i0: usize, i1: usize)
where
T: PartialOrd;
/// Utility, sorts any three items into ascending order
fn isortthree(self, idx: &mut [usize], i0: usize, i1: usize, i2: usize)
where
T: PartialOrd;
/// Stable hash sort giving sort index
fn hashsort_indexed(self, quantify: impl Copy + Fn(&T) -> f64) -> Vec<usize>
where
T: PartialOrd + Clone;
/// Utility used by hashsort_indexed
fn hashsortslice(
self,
idx: &mut [usize],
i: usize,
n: usize,
min: f64,
max: f64,
quantify: impl Copy + Fn(&T) -> f64,
) where
T: PartialOrd + Clone;
/// Stable hash sort. Returns new sorted data vector (ascending or descending)
fn sorth(self, quantify: impl Copy + Fn(&T) -> f64, ascending: bool) -> Vec<T>
where
T: PartialOrd + Clone;
/// Heap of k smallest items in no particular order, except the first one is maximum
fn smallest_k(&self, k: usize) -> BinaryHeap<&T>
where
T: Ord;
/// Heap of k biggest items in no particular order, except the first one is minimum
fn biggest_k(&self, k: usize) -> BinaryHeap<Reverse<&T>>
where
T: Ord;
}
/// Mutable Operators on `&mut[T]`
pub trait Mutops<T> {
/// Sorts a mutable slice in place.
fn mutquicksort(self)
where
T: PartialOrd;
/// mutable reversal, general utility
fn mutrevs(self);
/// utility that mutably swaps two indexed items into ascending order
fn mutsorttwo(self, i0: usize, i1: usize) -> bool
where
T: PartialOrd;
/// utility that mutably bubble sorts three indexed items into ascending order
fn mutsortthree(self, i0: usize, i1: usize, i2: usize)
where
T: PartialOrd;
/// Possibly the fastest sort for long lists. Wrapper for `muthashsortslice`.
fn muthashsort(self, quantify: impl Copy + Fn(&T) -> f64)
where
T: PartialOrd + Clone;
/// Sorts n items from i in self. Used by muthashsort.
fn muthashsortslice(
self,
i: usize,
n: usize,
min: f64,
max: f64,
quantify: impl Copy + Fn(&T) -> f64,
) where
T: PartialOrd + Clone;
}