de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans

Class KMedoidsPAM<V>

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<R>

de.lmu.ifi.dbs.elki.algorithm.AbstractDistanceBasedAlgorithm<V,Clustering<MedoidModel>>

de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.KMedoidsPAM<V>

Type Parameters:

V - vector datatype

All Implemented Interfaces:

Algorithm, ClusteringAlgorithm<Clustering<MedoidModel>>, DistanceBasedAlgorithm<V>

Direct Known Subclasses:

CLARA, KMedoidsFastPAM1, KMedoidsPAMReynolds

@Title(value="Partioning Around Medoids")
 @Priority(value=100)
 @Reference(authors="L. Kaufman, P. J. Rousseeuw",title="Clustering by means of Medoids",booktitle="Statistical Data Analysis Based on the L1-Norm and Related Methods",bibkey="books/misc/KauRou87") @Reference(authors="L. Kaufman, P. J. Rousseeuw",title="Partitioning Around Medoids (Program PAM)",booktitle="Finding Groups in Data: An Introduction to Cluster Analysis",url="https://doi.org/10.1002/9780470316801.ch2",bibkey="doi:10.1002/9780470316801.ch2")
public class KMedoidsPAM<V>
extends AbstractDistanceBasedAlgorithm<V,Clustering<MedoidModel>>
implements ClusteringAlgorithm<Clustering<MedoidModel>>

The original Partitioning Around Medoids (PAM) algorithm or k-medoids clustering, as proposed by Kaufman and Rousseeuw in "Clustering by means of Medoids".

Reference:

L. Kaufman, P. J. Rousseeuw
Clustering by means of Medoids
Statistical Data Analysis Based on the L1-Norm and Related Methods

Since:

0.5.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	KMedoidsPAM.Instance Instance for a single dataset.
static class	KMedoidsPAM.Parameterizer<V> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected KMedoidsInitialization<V>	initializer Method to choose initial means.
protected int	k The number of clusters to produce.
private static Logging	LOG The logger for this class.
protected int	maxiter The maximum number of iterations.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

ALGORITHM_ID

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

DISTANCE_FUNCTION_ID

Constructor Summary

Constructors

Constructor and Description
KMedoidsPAM(DistanceFunction<? super V> distanceFunction, int k, int maxiter, KMedoidsInitialization<V> initializer) Constructor.

Method Summary

Modifier and Type	Method and Description
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected Logging	getLogger() Get the (STATIC) logger for this class.
protected ArrayModifiableDBIDs	initialMedoids(DistanceQuery<V> distQ, DBIDs ids) Choose the initial medoids.
Clustering<MedoidModel>	run(Database database, Relation<V> relation) Run k-medoids
protected void	run(DistanceQuery<V> distQ, DBIDs ids, ArrayModifiableDBIDs medoids, WritableIntegerDataStore assignment) Run the main algorithm.

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractDistanceBasedAlgorithm

getDistanceFunction

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

run

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.algorithm.clustering.ClusteringAlgorithm

run

Field Detail

LOG

private static final Logging LOG

The logger for this class.

k

protected int k

The number of clusters to produce.

maxiter

protected int maxiter

The maximum number of iterations.

initializer

protected KMedoidsInitialization<V> initializer

Method to choose initial means.

Constructor Detail

KMedoidsPAM

public KMedoidsPAM(DistanceFunction<? super V> distanceFunction,
                   int k,
                   int maxiter,
                   KMedoidsInitialization<V> initializer)

Constructor.

Parameters:

distanceFunction - distance function

k - k parameter

maxiter - Maxiter parameter

initializer - Function to generate the initial means

Method Detail

run

public Clustering<MedoidModel> run(Database database,
                                   Relation<V> relation)

Run k-medoids

Parameters:

database - Database

relation - relation to use

Returns:

result

initialMedoids

protected ArrayModifiableDBIDs initialMedoids(DistanceQuery<V> distQ,
                                              DBIDs ids)

Choose the initial medoids.

Parameters:

distQ - Distance query

ids - IDs to choose from

Returns:

Initial medoids

run

protected void run(DistanceQuery<V> distQ,
                   DBIDs ids,
                   ArrayModifiableDBIDs medoids,
                   WritableIntegerDataStore assignment)

Run the main algorithm. Internal use, for easier subclassing, this primarily is a wrapper around "new Instance" for subclasses.

Parameters:

distQ - Distance query

ids - IDs to process

medoids - Current medoids

assignment - Cluster assignment output

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from class: AbstractAlgorithm

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface Algorithm

Specified by:

getInputTypeRestriction in class AbstractAlgorithm<Clustering<MedoidModel>>

Returns:

Type restriction

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<Clustering<MedoidModel>>

Returns:

the static logger