Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.algorithm
Class DummyAlgorithm<V extends NumberVector<V,?>>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<V,Result>
          extended by de.lmu.ifi.dbs.elki.algorithm.DummyAlgorithm<V>
Type Parameters:
V - Vector type
All Implemented Interfaces:
Algorithm<V,Result>, Parameterizable

@Title(value="Dummy Algorithm")
@Description(value="The algorithm executes a 10NN query on all data points, and can be used in unit testing")
public class DummyAlgorithm<V extends NumberVector<V,?>>
extends AbstractAlgorithm<V,Result>

Dummy Algorithm, which just iterates over all points once, doing a 10NN query each. Useful in testing e.g. index structures and as template for custom algorithms.

Author:
Erich Schubert

Field Summary
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug, logger
 
Constructor Summary
DummyAlgorithm(Parameterization config)
          Constructor, adhering to Parameterizable
 
Method Summary
protected  Result runInTime(Database<V> database)
          Iterates over all points in the database.
 
Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm
isTime, isVerbose, run, setTime, setVerbose
 
Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debugFine, debugFiner, debugFinest, exception, progress, verbose, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DummyAlgorithm

public DummyAlgorithm(Parameterization config)
Constructor, adhering to Parameterizable

Parameters:
config - Parameterization
Method Detail

runInTime

protected Result runInTime(Database<V> database)
                    throws IllegalStateException
Iterates over all points in the database.

Specified by:
runInTime in class AbstractAlgorithm<V extends NumberVector<V,?>,Result>
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).

Release 0.3 (2010-03-31_1612)