qsort_rs/lib.rs
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
//! qsort-rs: A quick sort algorithm that accepts any type and non-recursive approach.
//!
//! ## How to use this function
//!
//! ```rust
//! use qsort_rs::qsort;
//!
//! #[derive(Ord, PartialEq, PartialOrd, Eq, Debug)]
//! struct Student {
//! name: String,
//! age: u32,
//! gender: String,
//! }
//!
//! let mut arr = [
//! Student {
//! name: String::from("Zed"),
//! age: 3,
//! gender: String::from("Male"),
//! },
//! Student {
//! name: String::from("Aubrey"),
//! age: 13,
//! gender: String::from("Female"),
//! },
//! Student {
//! name: String::from("Jaime"),
//! age: 6,
//! gender: String::from("Male"),
//! },
//! Student {
//! name: String::from("Irene"),
//! age: 8,
//! gender: String::from("Female"),
//! },
//! Student {
//! name: String::from("Ren"),
//! age: 9,
//! gender: String::from("Male"),
//! },
//! ];
//!
//! qsort::sort(&mut arr, |low, high| low.name <= high.name);
//!
//! assert_eq!(
//! arr,
//! [
//! Student {
//! name: "Aubrey".to_string(),
//! age: 13,
//! gender: "Female".to_string()
//! },
//! Student {
//! name: "Irene".to_string(),
//! age: 8,
//! gender: "Female".to_string()
//! },
//! Student {
//! name: "Jaime".to_string(),
//! age: 6,
//! gender: "Male".to_string()
//! },
//! Student {
//! name: "Ren".to_string(),
//! age: 9,
//! gender: "Male".to_string()
//! },
//! Student {
//! name: "Zed".to_string(),
//! age: 3,
//! gender: "Male".to_string()
//! }
//! ]
//! )
//! ```
//!
pub mod qsort;
#[cfg(test)]
mod tests;