Skip to main content

FunFemConfig

Struct FunFemConfig 

Source
#[non_exhaustive]
pub struct FunFemConfig { pub k: usize, pub ncomp: usize, pub p_disc: usize, pub max_iter: usize, pub tol: f64, pub seed: u64, }
Expand description

Configuration for funFEM discriminative-subspace clustering.

funFEM applies the Fisher-EM algorithm to functional data: it first extracts global FPC scores via fdata_to_pc_1d, then alternates between finding a discriminative subspace (maximising between-class vs within-class scatter) and running a GMM E/M step in that subspace.

§Divergence from R funFEM

This is a simplified Fisher-EM implementation. The discriminative subspace is found by computing W_soft^{-1} B_soft via Cholesky inversion followed by an SVD (instead of a proper generalized-eigenvalue solver), because no generalized-eigenvalue crate is used. The multi-pass outer loop re-estimates the subspace at each iteration. This diverges from the iterative schedule in the original paper (Bouveyron & Brunet, 2014) but gives practical cluster recovery on well-separated functional data.

§Example

use fdars_core::clustering_advanced::{funfem_cluster, FunFemConfig};
use fdars_core::matrix::FdMatrix;
use std::f64::consts::PI;

let m = 30;
let n = 12;
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..6 {
    for (j, &tj) in t.iter().enumerate() {
        col_major[i + j * n] = (2.0 * PI * tj).sin();
    }
}
for i in 6..12 {
    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 = FunFemConfig::default();
cfg.k = 2;
cfg.ncomp = 4;
let result = funfem_cluster(&data, &t, &cfg).unwrap();
assert_eq!(result.cluster.len(), n);

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.

§ncomp: usize

Number of global FPC components for the score space (default: 10). Clamped internally to min(n, m).

§p_disc: usize

Discriminative subspace dimension (default: 0 = auto = min(k-1, ncomp_eff)). Clamped to ncomp_eff if larger.

§max_iter: usize

Maximum outer Fisher-EM iterations (default: 50).

§tol: f64

Log-likelihood convergence tolerance (default: 1e-6).

§seed: u64

Random seed for k-means++ initialization (default: 42).

Trait Implementations§

Source§

impl Clone for FunFemConfig

Source§

fn clone(&self) -> FunFemConfig

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 FunFemConfig

Source§

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

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

impl Default for FunFemConfig

Source§

fn default() -> Self

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

impl PartialEq for FunFemConfig

Source§

fn eq(&self, other: &FunFemConfig) -> 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 FunFemConfig

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 = !

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

fn try_from(value: U) -> Result<T, !>

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