phomo 0.6.0

A photo mosaic generation library
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

/// A module which contains structs which implement the [`Solve`](crate::solvers::Solve) trait. These structs are used to
/// solve the assignment problem.
use crate::{error::PhomoError, DistanceMatrix};

pub mod auction;
pub mod error;
pub mod greedy;
pub mod hungarian;

/// Common configuration for the solvers.
#[derive(Debug, Clone)]
pub struct SolverConfig {
    pub max_tile_occurrences: usize,
}

impl Default for SolverConfig {
    fn default() -> Self {
        SolverConfig {
            max_tile_occurrences: 1,
        }
    }
}

/// The Solve trait is implemented by structs which solve the assignment problem.
pub trait Solve {
    /// Solves the assignment problem using the solver.
    ///
    /// # Arguments
    /// - `distance_matrix`: The distance matrix.
    ///
    /// # Errors
    /// - [`PhomoError::SolverError``]: An error occurred while solving the assignment problem.
    fn solve(&mut self, distance_matrix: &DistanceMatrix) -> Result<Vec<usize>, PhomoError>;
}