Performs k-means clustering on the input data. Supports both full Lloyd's iterations (with SIMD/GEMM acceleration) and mini-batch k-means for large data sets.
Usage
kmeans_cluster(
data,
k,
method = c("full", "minibatch"),
kmeans_params = params_kmeans(),
seed = 42L,
.verbose = TRUE
)Arguments
- data
Numerical matrix or data frame. The data to cluster, of shape samples x features. Will be coerced to a matrix.
- k
Integer. Number of clusters to create. Must be >= 2.
- method
Character. Clustering method. One of
"full"(Lloyd's algorithm) or"minibatch"(mini-batch k-means). Defaults to"full".- kmeans_params
Named list. K-means parameters, see
params_kmeans().- seed
Integer. Random seed for reproducibility. Defaults to
42L.- .verbose
Logical. Controls verbosity. Defaults to
TRUE.
Value
A named list with:
- centroids
Numeric matrix of shape k x features containing the final cluster centroids.
- assignments
Integer vector of length samples with cluster assignments (1-indexed).
Examples
d <- manifold_synthetic_data(type = "clusters", n_samples = 500L)
km <- kmeans_cluster(d$data, k = 4L, .verbose = FALSE)
km
#> KMeansCluster
#> method: full
#> metric: euclidean
#> k: 4
#> n: 500
#> sizes: min= 0 median= 68.5 max= 121
