Struct KShapeResult 

#[non_exhaustive]
pub struct KShapeResult {
    pub centroids: FdMatrix,
    pub cluster: Vec<usize>,
    pub inertia: f64,
    pub iter: usize,
    pub converged: bool,
    pub n_init_best: usize,
}

Result of kshape_fd.

Carries the fitted centroids (k × m, already z-normalized) plus cluster assignments and fit diagnostics. KShapeResult::predict reuses the stored centroids directly — nothing is re-estimated on new data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

centroids: FdMatrix

Cluster centroids as a k × m FdMatrix (each row a z-normalized shape prototype).

cluster: Vec<usize>

Cluster assignment for each training series (values in 0..n_clusters).

inertia: f64

Total SBD inertia Σ_i SBD(series_i, centroid[cluster[i]]) of the returned run.

iter: usize

Number of Lloyd iterations the winning restart ran.

converged: bool

Whether the winning restart converged before hitting max_iter.

n_init_best: usize

Index of the restart (0-based) that produced this result.

Implementations

impl KShapeResult

pub fn centroids(&self) -> &FdMatrix

The fitted centroids (k × m, each row a z-normalized shape prototype).

pub fn cluster(&self) -> &[usize]

The per-series cluster assignments.

pub fn inertia(&self) -> f64

Total SBD inertia of the returned run.

pub fn n_clusters(&self) -> usize

The number of clusters (k).

pub fn predict(&self, new_data: &FdMatrix) -> Result<Vec<usize>, FdarError>

Assign new (out-of-sample) series to the fitted clusters.

Each new series is z-normalized and compared by sbd against every stored (already-z-normalized) centroid; the argmin cluster is returned. The centroids are used as-is, so predict(train_data) reproduces the training labels.

Errors

Returns FdarError::InvalidDimension if new_data is empty or its evaluation-grid width differs from the fitted centroids’ length m.

Trait Implementations

impl Clone for KShapeResult

fn clone(&self) -> KShapeResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KShapeResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KShapeResult

fn eq(&self, other: &KShapeResult) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KShapeResult