min-max 0.1.8

max! and min! macros
Documentation 
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

//! # **min-max**: `max!` and `min!` macros for Rust
//!
//! [![crates.io](https://img.shields.io/crates/d/min-max.svg)](https://crates.io/crates/min-max)
//! [![crates.io](https://img.shields.io/crates/v/min-max.svg)](https://crates.io/crates/min-max)
//! [![crates.io](https://img.shields.io/crates/l/min-max.svg)](https://crates.io/crates/min-max)
//!
//! ## Why?
//!
//! Sometimes you want to find the maximum of a bunch of **scalars**. Usually you would write something like `max(x1, max(x2, max(x3, x4)))`. The `max!` macro provided by this crate simplifies that to `max!(x1, x2, x3, x4)`. (Note, for an **iterable** data structure, you would use `xx.iter().max()`).
//!
//! ## Usage
//!
//! Add this to your `Cargo.toml`:
//!
//! ```toml
//! min-max = "0.1"
//! ```
//!
//! Then, for example:
//!
//! ```rust
//! use min_max::*;
//!
//! fn main() {
//!     let max = max!(1, 5, 7, 2, 4, 9, 3);
//!     assert_eq!(max, 9);
//!     let min = min!(1, 5, 7, 2, 4, 9, 3);
//!     assert_eq!(min, 1);
//!     let min_max = min_max!(1, 5, 7, 2, 4, 9, 3);
//!     assert_eq!(min_max, (min, max));
//! }
//! ```
//!
//! ### Does it work on floats?
//!
//! Yep. But you need to use `max_partial!`/`min_partial!`
//!
//! ```rust
//! use min_max::*;
//!
//! fn main() {
//!     let partial_max = max_partial!(1.8f64, 5.8, 7.8, 2.8, 4.8, 9.8, 3.8);
//!     assert!((9.8 - partial_max).abs() < 1e-5);
//!     let partial_min = min_partial!(1.8f64, 5.8, 7.8, 2.8, 4.8, 9.8, 3.8);
//!     assert!((1.8 - partial_min).abs() < 1e-5);
//! }
//! ```
//!
//! ### What about `NaN`?
//!
//! Do not use when your data contains `NaN`. When `NaN` is at the end, `NaN` is returned. Otherwise, the min/max excluding `NaN` is returned.
//!
//! ```rust
//! use min_max::*;
//!
//! fn main() {
//!     let partial_max = max_partial!(1.8, 5.8, f64::NAN, 2.8, 4.8, 9.8, 3.8);
//!     assert!((9.8 - partial_max).abs() < 1e-5);
//!     let partial_max = max_partial!(1.8, 5.8, 2.8, 4.8, 9.8, 3.8, f64::NAN);
//!     assert!(partial_max.is_nan());
//!     let partial_min = min_partial!(1.8, 5.8, f64::NAN, 2.8, 4.8, 9.8, 3.8);
//!     assert!((1.8 - partial_min).abs() < 1e-5);
//!     let partial_min = max_partial!(1.8, 5.8, 2.8, 4.8, 9.8, 3.8, f64::NAN);
//!     assert!(partial_min.is_nan());
//! }
//! ```
//!
//! ### Can I use custom types?
//!
//! Sure, why not?
//!
//! ```rust
//! use min_max::*;
//!
//! #[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Clone, Copy)]
//! struct Point {
//!     x: u16,
//!     y: u16,
//! }
//!
//! fn main() {
//!     let a = Point { x: 5, y: 8 };
//!     let b = Point { x: 10, y: 92 };
//!     let c = Point { x: 0, y: 3 };
//!     let max = max!(a, b, c);
//!     assert_eq!(max, b);
//! }
//! ```
//!
//! ## What's going on under the hood?
//!
//! Well, `max!(x1, x2, x3)` expands to:
//!
//! ```ignore
//! std::cmp::max(x1, std::cmp::max(x2, std::cmp::max(x3)))
//! ```
//!
//! and so on. `min!` works similarly, but with `std::cmp::min`.
//!
//! `min_partial!` and `max_partial` uses the `min` and `max` functions from the [`partial-min-max` crate](https://crates.io/crates/partial-min-max).

pub use partial_min_max::{max, min};

/// Returns the maximum element of the arguments.
#[macro_export]
macro_rules! max {
    ($x:expr) => ( $x );
    ($x:expr, $($xs:expr),+) => {
        std::cmp::max($x, max!( $($xs),+ ))
    };
}

/// Returns the minimum element of the arguments.
#[macro_export]
macro_rules! min {
    ($x:expr) => ( $x );
    ($x:expr, $($xs:expr),+) => {
        std::cmp::min($x, min!( $($xs),+ ))
    };
}

/// Returns the minimum and maximum element of the arguments.
#[macro_export]
macro_rules! min_max {
    ($x:expr) => ( ($x, $x) );
    ($($xs:expr),+) => {
        (min!( $($xs),+ ), max!( $($xs),+ ))
    };
}

/// Returns the maximum element of the arguments. Uses [`partial_min_max::max`](https://docs.rs/partial-min-max/0.4.0/partial_min_max/fn.max.html) for comparison.
#[macro_export]
macro_rules! max_partial {
    ($x:expr) => ( $x );
    ($x:expr, $($xs:expr),+) => {
        max($x, max_partial!( $($xs),+ ))
    };
}

/// Returns the maximum element of the arguments. Uses [`partial_min_max::min`](https://docs.rs/partial-min-max/0.4.0/partial_min_max/fn.min.html) for comparison.
#[macro_export]
macro_rules! min_partial {
    ($x:expr) => ( $x );
    ($x:expr, $($xs:expr),+) => {
        min($x, min_partial!( $($xs),+ ))
    };
}

/// Returns the minimum and maximum element of the arguments. Uses [`partial_min_max::min`](https://docs.rs/partial-min-max/0.4.0/partial_min_max/fn.min.html) for comparison.
#[macro_export]
macro_rules! min_max_partial {
    ($x:expr) => ( ($x, $x) );
    ($($xs:expr),+) => {
        (min_partial!( $($xs),+ ), max_partial!( $($xs),+ ))
    };
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_int() {
        let max = max!(1, 5, 7, 2, 4, 9, 3);
        assert_eq!(max, 9);
        let min = min!(1, 5, 7, 2, 4, 9, 3);
        assert_eq!(min, 1);
        let min_max = min_max!(1, 5, 7, 2, 4, 9, 3);
        assert_eq!(min_max, (min, max));
    }

    #[test]
    fn test_float() {
        let partial_max = max_partial!(1.8f64, 5.8, 7.8, 2.8, 4.8, 9.8, 3.8);
        assert!((9.8 - partial_max).abs() < 1e-5);
        let partial_min = min_partial!(1.8f64, 5.8, 7.8, 2.8, 4.8, 9.8, 3.8);
        assert!((1.8 - partial_min).abs() < 1e-5);
    }

    #[test]
    fn test_struct() {
        #[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Clone, Copy)]
        struct Point {
            x: u16,
            y: u16,
        }

        let a = Point { x: 5, y: 8 };
        let b = Point { x: 10, y: 92 };
        let c = Point { x: 0, y: 3 };
        let max = max!(a, b, c);
        assert_eq!(max, b);
    }
}