auto-palette 0.8.1

🎨 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

use crate::{color::Color, math::FloatNumber};

/// The swatch representation containing the color, position, and population.
///
/// # Type Parameters
/// * `T` - The floating point type.
///
/// # Examples
/// ```
/// use std::str::FromStr;
///
/// use auto_palette::{
///     color::{Color, RGB},
///     Swatch,
/// };
///
/// let color: Color<f32> = Color::from_str("#ff0040").unwrap();
/// let swatch = Swatch::new(color, (5, 10), 384, 0.25);
/// assert_eq!(swatch.color().to_rgb(), RGB::new(255, 0, 64));
/// assert_eq!(swatch.position(), (5, 10));
/// assert_eq!(swatch.population(), 384);
/// assert_eq!(swatch.ratio(), 0.25);
/// ```
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Swatch<T>
where
    T: FloatNumber,
{
    color: Color<T>,
    position: (u32, u32),
    population: usize,
    ratio: T,
}

impl<T> Swatch<T>
where
    T: FloatNumber,
{
    /// Creates a new `Swatch` instance with the given color and population.
    ///
    /// # Arguments
    /// * `color` - The color of the swatch.
    /// * `position` - The position of the swatch.
    /// * `population` - The population of the swatch.
    /// * `ratio` - The ratio of the swatch to the total population.
    ///
    /// # Returns
    /// A new `Swatch` instance.
    pub fn new(color: Color<T>, position: (u32, u32), population: usize, ratio: T) -> Self {
        Self {
            color,
            position,
            population,
            ratio,
        }
    }

    /// Returns the color of this swatch.
    ///
    /// # Returns
    /// The color of this swatch.
    #[inline]
    #[must_use]
    pub fn color(&self) -> &Color<T> {
        &self.color
    }

    /// Returns the position of this swatch.
    ///
    /// # Returns
    /// The position of this swatch.
    /// The position is a tuple of the x and y coordinates.
    #[inline]
    #[must_use]
    pub fn position(&self) -> (u32, u32) {
        self.position
    }

    /// Returns the population of this swatch.
    ///
    /// # Returns
    /// The population of this swatch.
    #[inline]
    #[must_use]
    pub fn population(&self) -> usize {
        self.population
    }

    /// Returns the ratio of this swatch to the total population.
    ///
    /// # Returns
    /// The ratio of this swatch to the total population.
    #[inline]
    #[must_use]
    pub fn ratio(&self) -> T {
        self.ratio
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new_swatch() {
        // Act
        let color = Color::new(80.0, 0.0, 0.0);
        let swatch = Swatch::new(color.clone(), (5, 10), 384, 0.25);

        // Assert
        assert_eq!(swatch.color(), &color);
        assert_eq!(swatch.position(), (5, 10));
        assert_eq!(swatch.population(), 384);
    }
}