Function kmedoids::pammedsil

source ·
pub fn pammedsil<M, N, L>(
    mat: &M,
    k: usize,
    maxiter: usize
) -> (L, Vec<usize>, Vec<usize>, usize, usize)where
    N: Zero + PartialOrd + Copy,
    L: Float + Signed + AddAssign + From<N> + From<u32>,
    M: ArrayAdapter<N>,
Expand description

Run the original PAM BUILD algorithm combined with the PAMMEDSIL SWAP.

  • type M - matrix data type such as ndarray::Array2 or kmedoids::arrayadapter::LowerTriangle
  • type N - number data type such as u32 or f64
  • type L - number data type such as i64 or f64 for the loss (must be signed)
  • mat - a pairwise distance matrix
  • k - the number of medoids to pick
  • maxiter - the maximum number of iterations allowed

returns a tuple containing:

  • the final loss
  • the final cluster assignment
  • the final medoids
  • the number of iterations needed
  • the number of swaps performed


  • panics when the dissimilarity matrix is not square
  • panics when k is 0 or larger than N


Given a dissimilarity matrix of size 4 x 4, use:

let data = ndarray::arr2(&[[0,1,2,3],[1,0,4,5],[2,4,0,6],[3,5,6,0]]);
let (loss, assi, meds, n_iter, n_swap): (f64, _, _, _, _) = kmedoids::pamsil(&data, 2, 100);
println!("Loss is: {}", loss);