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

use std::error::Error;
use std::fmt::{self, Display};

pub type Result<T> = std::result::Result<T, KMeansError>;

/// An error when modeling a KMeans algorithm
#[derive(Debug)]
pub enum KMeansError {
    /// When any of the hyperparameters are set the wrong value
    InvalidValue(String),
    /// When inertia computation fails
    InertiaError(String),
    /// When fitting algorithm does not converge
    NotConverged(String),
}

impl Display for KMeansError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::InvalidValue(message) => write!(f, "Invalid value encountered: {}", message),
            Self::InertiaError(message) => write!(f, "Fitting failed: {}", message),
            Self::NotConverged(message) => write!(f, "Fitting failed: {}", message),
        }
    }
}

impl Error for KMeansError {}