color_counter 0.2.3

//! The region is a fraction of the color space,
//! designed as a bucket to segregate colors into
//! different groups.

use color_processing::Color;

/// The struct itself is just a data placeholder,
/// it has meaning only in context.
#[derive(Default)]
pub struct Region {
    data: Vec<(Color, usize)>,
}

impl Region {
    /// Create new empty region.
    pub fn new() -> Self {
        Self { data: Vec::new() }
    }

    /// Return the average color of this region.
    ///
    /// Note that this is not the average color of this region
    /// in space, but of the colors effectively contained in
    /// this region data.
    pub fn average_color(&self) -> Color {
        let sum_color = self.data.iter().fold((0.0, 0.0, 0.0), |sums, x| {
            let x = x.0.get_laba();

            (sums.0 + x.0, sums.1 + x.1, sums.2 + x.2)
        });

        let average_color = (
            sum_color.0 / self.data.len() as f64,
            sum_color.1 / self.data.len() as f64,
            sum_color.2 / self.data.len() as f64,
        );

        Color::new_lab(average_color.0, average_color.1, average_color.2)
    }

    /// Sort the colors inside the region by their frequency.
    pub fn sort_by_frequency(&mut self) {
        self.data.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap());
    }

    /// Push a new color with count into data holder.
    pub fn push(&mut self, color: Color, count: usize) {
        self.data.push((color, count))
    }

    /// Returns if the region is empty.
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    /// Returns an iterator for the region.
    pub fn iter<'s>(&'s self) -> impl Iterator<Item = &(Color, usize)> + 's {
        self.data.iter()
    }

    /// Returns the length of the region.
    pub fn len(&self) -> usize {
        self.data.len()
    }
}

/// Indexing is implemented for the region to
/// provide a easier access to (Color, usize)
/// elements.
impl std::ops::Index<usize> for Region {
    type Output = (Color, usize);

    /// Implement indexing for usize.
    fn index(&self, idx: usize) -> &(Color, usize) {
        &self.data[idx]
    }
}