vq 0.2.0

A vector quantization library for Rust
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

use thiserror::Error;

/// Crate-specific error type for Vq operations.
#[derive(Debug, Error)]
pub enum VqError {
    /// Vectors have different dimensions where they were expected to match.
    #[error("Dimension mismatch: expected {expected}, found {found}")]
    DimensionMismatch { expected: usize, found: usize },

    /// Input data is empty when at least one element is required.
    #[error("Empty input: at least one vector is required")]
    EmptyInput,

    /// A configuration parameter is invalid (e.g., k=0, levels > 256).
    #[error("Invalid parameter '{parameter}': {reason}")]
    InvalidParameter {
        parameter: &'static str,
        reason: String,
    },

    /// Input data contains invalid values (NaN, Infinity, etc.).
    #[error("Invalid data: {0}")]
    InvalidData(String),

    /// FFI operation failed.
    #[error("FFI error: {0}")]
    FfiError(String),
}

/// A specialized Result type for Vq operations.
pub type VqResult<T> = std::result::Result<T, VqError>;