Skip to main content

AlignClusterConfig

Struct AlignClusterConfig 

Source
#[non_exhaustive]
pub struct AlignClusterConfig { pub k: usize, pub max_iter: usize, pub seed: u64, pub use_amplitude_only: bool, pub elastic_lambda: f64, pub karcher_max_iter: usize, pub karcher_tol: f64, }
Expand description

Configuration for joint align-and-cluster (elastic k-means).

Alternates between updating per-cluster template curves (via Karcher mean in the elastic metric) and reassigning each curve to the nearest template by elastic distance. This is the only clusterer in this module that is shape-invariant — it finds clusters based on amplitude shape, not phase.

Reference: Inspired by Sangalli et al. (2010) joint clustering and alignment and the fdasrvf elastic k-means variant (Srivastava et al.).

§Example

use fdars_core::clustering_advanced::{align_cluster_fd, AlignClusterConfig};
use fdars_core::matrix::FdMatrix;
use std::f64::consts::PI;

let m = 25;
let n = 10;
let t: Vec<f64> = (0..m).map(|i| i as f64 / (m - 1) as f64).collect();
let mut col_major = vec![0.0_f64; n * m];
for i in 0..5 {
    for (j, &tj) in t.iter().enumerate() {
        col_major[i + j * n] = (2.0 * PI * tj).sin();
    }
}
for i in 5..10 {
    for (j, &tj) in t.iter().enumerate() {
        col_major[i + j * n] = (2.0 * PI * tj).sin() + 5.0;
    }
}
let data = FdMatrix::from_column_major(col_major, n, m).unwrap();

let mut cfg = AlignClusterConfig::default();
cfg.k = 2;
cfg.max_iter = 10;
cfg.karcher_max_iter = 8;
let result = align_cluster_fd(&data, &t, &cfg).unwrap();
assert_eq!(result.cluster.len(), n);
assert_eq!(result.templates.len(), 2);

Fields (Non-exhaustive)§

This struct is marked as 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.
§k: usize

Number of clusters (default: 2). Must be ≥ 1 and ≤ n.

§max_iter: usize

Maximum number of outer iterations (default: 20).

§seed: u64

Random seed for initial template selection (default: 42).

§use_amplitude_only: bool

If true, use amplitude_distance (shape-invariant); otherwise use elastic_distance (full Fisher-Rao distance including phase). Default: true.

§elastic_lambda: f64

Penalty weight for elastic_distance when use_amplitude_only = false (default: 0.0).

§karcher_max_iter: usize

Maximum inner iterations for Karcher mean (default: 15).

§karcher_tol: f64

Convergence tolerance for Karcher mean (default: 1e-4).

Trait Implementations§

Source§

impl Clone for AlignClusterConfig

Source§

fn clone(&self) -> AlignClusterConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AlignClusterConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AlignClusterConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AlignClusterConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AlignClusterConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V