de.lmu.ifi.dbs.elki.algorithm

Class AbstractAlgorithm<R extends Result>

java.lang.Object

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

Type Parameters:

R - the result type

All Implemented Interfaces:

Algorithm

Direct Known Subclasses:

ABOD, AbstractAggarwalYuOutlier, AbstractBiclustering, AbstractClassifier, AbstractDistanceBasedAlgorithm, AbstractFrequentItemsetAlgorithm, AbstractNeighborhoodOutlier, AbstractNumberVectorDistanceBasedAlgorithm, AbstractPrimitiveDistanceBasedAlgorithm, AbstractProjectedClustering, AbstractProjectionAlgorithm, AffinityPropagationClusteringAlgorithm, ALOCI, AssociationRuleGeneration, BestOfMultipleKMeans, BIRCHLeafClustering, ByLabelClustering, ByLabelHierarchicalClustering, ByLabelOutlier, ByModelClustering, CASH, CenterOfMassMetaClustering, CLIQUE, COPAC, DiSH, DOC, DummyAlgorithm, EM, EMOutlier, ERiC, ExternalClustering, ExternalDoubleOutlierScore, FastOPTICS, FeatureBagging, FlexibleLOF, GaussianModel, GaussianUniformMixture, GeneralizedDBSCAN, GeneralizedOPTICS, HiCS, KMeansBisecting, KMeansOutlierDetection, KNNClassifier, KNNKernelDensityMinimaClustering, LibSVMOneClassOutlierDetection, LMCLUS, LoOP, NullAlgorithm, OfflineChangePointDetectionAlgorithm, OPTICSXi, OutRankS1, OUTRES, P3C, ParallelGeneralizedDBSCAN, RepresentativeUncertainClustering, RescaleMetaOutlierAlgorithm, SigniTrendChangeDetection, SimpleOutlierEnsemble, SNNClustering, SOD, SUBCLU, TrivialAllInOne, TrivialAllNoise, TrivialAllOutlier, TrivialAverageCoordinateOutlier, TrivialGeneratedOutlier, TrivialNoOutlier, UKMeans

public abstract class AbstractAlgorithm<R extends Result>
extends java.lang.Object
implements Algorithm

This class serves also as a model of implementing an algorithm within this framework. Any Algorithm that makes use of these flags may extend this class.

Since:

0.1

Author:

Arthur Zimek

Field Summary

Fields

Modifier and Type	Field and Description
static OptionID	ALGORITHM_ID Parameter to specify the algorithm to run.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAlgorithm() Constructor.

Method Summary

Modifier and Type	Method and Description
abstract TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected abstract Logging	getLogger() Get the (STATIC) logger for this class.
R	run(Database database) Runs the algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM_ID

public static final OptionID ALGORITHM_ID

Parameter to specify the algorithm to run.

Constructor Detail

AbstractAlgorithm

protected AbstractAlgorithm()

Constructor.

Method Detail

run

public R run(Database database)

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

getInputTypeRestriction

public abstract TypeInformation[] getInputTypeRestriction()

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

Specified by:

getInputTypeRestriction in interface Algorithm

Returns:

Type restriction

getLogger

protected abstract Logging getLogger()

Get the (STATIC) logger for this class.

Returns:

the static logger