auto-palette 0.5.0

🎨 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

use crate::math::{neighbors::neighbor::Neighbor, point::Point, FloatNumber};

/// Trait for neighbor search algorithms.
///
/// # Type Parameters
/// * `T` - The floating point type.
/// * `N` - The dimension of the points.
pub trait NeighborSearch<T, const N: usize>
where
    T: FloatNumber,
{
    /// Searches for the k nearest neighbors of a point.
    ///
    /// # Arguments
    /// * `query` - The query point to search for neighbors.
    /// * `k` - The number of neighbors to search for.
    ///
    /// # Returns
    /// The k nearest neighbors.
    #[allow(dead_code)]
    fn search(&self, query: &Point<T, N>, k: usize) -> Vec<Neighbor<T>>;

    /// Searches for the nearest neighbor of a point.
    ///
    /// # Arguments
    /// * `query` - The query point to search for a neighbor.
    ///
    /// # Returns
    /// The nearest neighbor.
    fn search_nearest(&self, query: &Point<T, N>) -> Option<Neighbor<T>>;

    /// Searches for the neighbors within a given radius of a point.
    ///
    /// # Arguments
    /// * `query` - The query point to search for neighbors.
    /// * `radius` - The radius within which to search for neighbors.
    ///
    /// # Returns
    /// The neighbors within the given radius.
    fn search_radius(&self, query: &Point<T, N>, radius: T) -> Vec<Neighbor<T>>;
}