de.lmu.ifi.dbs.elki.algorithm.clustering
Interface OPTICSTypeAlgorithm<D extends Distance<D>>

Type Parameters:
D - Distance type
All Superinterfaces:
Algorithm, InspectionUtilFrequentlyScanned, Parameterizable
All Known Implementing Classes:
DeLiClu, HiCO, HiSC, OPTICS

public interface OPTICSTypeAlgorithm<D extends Distance<D>>
extends Algorithm

Interface for OPTICS type algorithms, that can be analysed by OPTICS Xi etc.


Method Summary
 D getDistanceFactory()
          Get the distance factory.
 int getMinPts()
          Get the minpts value used.
 ClusterOrderResult<D> run(Database database)
          Runs the algorithm.
 
Methods inherited from interface de.lmu.ifi.dbs.elki.algorithm.Algorithm
getInputTypeRestriction
 

Method Detail

run

ClusterOrderResult<D> run(Database database)
                                              throws IllegalStateException
Description copied from interface: Algorithm
Runs the algorithm.

Specified by:
run in interface Algorithm
Parameters:
database - the database to run the algorithm on
Returns:
the Result computed by this algorithm
Throws:
IllegalStateException - if the algorithm has not been initialized properly (e.g. the setParameters(String[]) method has been failed to be called).

getMinPts

int getMinPts()
Get the minpts value used. Needed for OPTICS Xi etc.

Returns:
minpts value

getDistanceFactory

D getDistanceFactory()
Get the distance factory. Needed for type checking (i.e. is number distance)

Returns:
distance factory

Release 0.4.0 (2011-09-20_1324)