auto-palette 0.9.2

🎨 A Rust library that extracts prominent color palettes from images automatically.
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

/// This module contains macros for assertions.
/// These macros are used to check if two values are approximately equal.
///
/// # Example
/// ```ignore
/// use auto_palette::assert_approx_eq;
///
/// assert_approx_eq!(1.0, 1.000001);        // This will pass
/// assert_approx_eq!(1.0, 1.0001);          // This will fail
/// assert_approx_eq!(1.0, 1.0001, 0.0002);  // This will pass
/// assert_approx_eq!(1.0, 1.0001, 0.00005); // This will fail
/// ```
#[macro_export]
macro_rules! assert_approx_eq {
    ($a:expr, $b:expr) => {
        let a = $a as f64;
        let b = $b as f64;
        let eps = 1.0e-6;
        let diff = (a - b).abs();
        assert!(
            diff < eps,
            "assertion failed: `|left-right| >= epsilon`\n  left: `{:?}`,\n right: `{:?}`\n  eps: `{:?}`\n  diff: `{:?}`",
            a,
            b,
            eps,
            diff
        );
    };
    ($a:expr, $b:expr, $eps:expr) => {
        let a = $a as f64;
        let b = $b as f64;
        let eps = $eps;
        let diff = (a - b).abs();
        assert!(
            eps > 0.0,
            "epsilon must be positive, but got: `{:?}`",
            eps
        );
        assert!(
            diff < eps,
            "assertion failed: `|left-right| >= epsilon`\n  left: `{:?}`,\n right: `{:?}`\n  eps: `{:?}`\n  diff: `{:?}`",
            a,
            b,
            eps,
            diff
        );
    };
}

#[macro_export]
macro_rules! assert_color_eq {
    ($left:expr, $right:expr) => {
        let tolerance = 1.0;
        let delta = $left.delta_e(&$right);
        assert!(
            delta < tolerance,
            "assertion failed: `|left-right| >= tolerance`\n  left: `{:?}`,\n right: `{:?}`\n  tolerance: `{:?}`\n  delta: `{:?}`",
            $left,
            $right,
            tolerance,
            delta
        );
    };
    ($left:expr, $right:expr, $tolerance:expr) => {
        let delta = $left.delta_e(&$right);
        assert!(
            $tolerance >= 0.0,
            "tolerance must be greater than or equal to zero, but got: `{:?}`",
            $tolerance
        );
        assert!(
            delta < $tolerance,
            "assertion failed: `|left-right| >= tolerance`\n  left: `{:?}`,\n right: `{:?}`\n  tolerance: `{:?}`\n  delta: `{:?}`",
            $left,
            $right,
            $tolerance,
            delta
        );
    };
}

#[cfg(test)]
mod test {
    use std::str::FromStr;

    use crate::color::Color;

    #[test]
    fn test_assert_approx_eq() {
        assert_approx_eq!(1.0, 1.000001);
    }

    #[test]
    #[should_panic(expected = "assertion failed: `|left-right| >= epsilon`")]
    fn test_assert_approx_eq_fail() {
        assert_approx_eq!(1.0, 1.0001);
    }

    #[test]
    fn test_assert_approx_eq_with_eps() {
        assert_approx_eq!(1.0, 1.001, 1.0e-2);
    }

    #[test]
    #[should_panic(expected = "assertion failed: `|left-right| >= epsilon`")]
    fn test_assert_approx_eq_fail_with_eps() {
        assert_approx_eq!(1.0, 1.0001, 0.00005);
    }

    #[test]
    #[should_panic(expected = "epsilon must be positive, but got: `0.0`")]
    fn test_assert_approx_eq_zero_eps() {
        assert_approx_eq!(1.0, 1.0001, 0.0);
    }

    #[test]
    fn test_assert_color_eq() {
        let color1: Color<f64> = Color::from_str("#eb367f").unwrap();
        let color2: Color<f64> = Color::from_str("#eb367f").unwrap();
        assert_color_eq!(color1, color2);
    }

    #[test]
    fn test_assert_color_eq_with_tolerance() {
        let color1: Color<f64> = Color::from_str("#eb367f").unwrap();
        let color2: Color<f64> = Color::from_str("#ec367f").unwrap();
        assert_color_eq!(color1, color2, 1.0);
    }

    #[test]
    #[should_panic(expected = "assertion failed: `|left-right| >= tolerance`")]
    fn test_assert_color_eq_fail() {
        let color1: Color<f64> = Color::from_str("#eb367f").unwrap();
        let color2: Color<f64> = Color::from_str("#ee367f").unwrap();
        assert_color_eq!(color1, color2);
    }

    #[test]
    #[should_panic(expected = "assertion failed: `|left-right| >= tolerance`")]
    fn test_assert_color_eq_fail_with_tolerance() {
        let color1: Color<f64> = Color::from_str("#eb367f").unwrap();
        let color2: Color<f64> = Color::from_str("#ec367f").unwrap();
        assert_color_eq!(color1, color2, 1e-6);
    }

    #[test]
    #[should_panic(
        expected = "tolerance must be greater than or equal to zero, but got: `-0.0001`"
    )]
    fn test_assert_color_eq_zero_tolerance() {
        let color1: Color<f64> = Color::from_str("#eb367f").unwrap();
        let color2: Color<f64> = Color::from_str("#ec367f").unwrap();
        assert_color_eq!(color1, color2, -1e-4);
    }
}