1use std::error::Error;
4use std::fmt;
5
6#[derive(Debug, Clone, PartialEq)]
8pub enum HmmError {
9 NotFitted,
11 LengthsMismatch {
13 total: usize,
15 n_samples: usize,
17 },
18 ScalingUnderflow,
22 InvalidParameter(String),
24 DimensionMismatch(String),
26 NotPositiveDefinite(String),
28}
29
30impl fmt::Display for HmmError {
31 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
32 match self {
33 HmmError::NotFitted => write!(f, "model is not fitted"),
34 HmmError::LengthsMismatch { total, n_samples } => write!(
35 f,
36 "lengths array sums to {total} but {n_samples} samples were provided"
37 ),
38 HmmError::ScalingUnderflow => write!(
39 f,
40 "forward pass failed; for sequences with negligible probability under \
41 the model consider the `log` implementation"
42 ),
43 HmmError::InvalidParameter(msg) => write!(f, "invalid parameter: {msg}"),
44 HmmError::DimensionMismatch(msg) => write!(f, "dimension mismatch: {msg}"),
45 HmmError::NotPositiveDefinite(msg) => {
46 write!(f, "matrix is not symmetric positive-definite: {msg}")
47 }
48 }
49 }
50}
51
52impl Error for HmmError {}
53
54pub type Result<T> = std::result::Result<T, HmmError>;