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

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

@Title(value="Dummy Algorithm")
@Description(value="The algorithm executes a euclidena 10NN query on all data points, and can be used in unit testing")
public class DummyAlgorithm<O extends NumberVector<?,?>>
extends AbstractAlgorithm<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. If you are looking for an algorithm that does nothing, you must use NullAlgorithm instead. While this algorithm doesn't produce a result, it still performs rather expensive operations.


Field Summary
private static Logging logger
          The logger for this class.
 
Constructor Summary
DummyAlgorithm()
          Constructor, adhering to Parameterizable
 
Method Summary
 TypeInformation[] getInputTypeRestriction()
          Get the input type restriction used for negotiating the data query.
protected  Logging getLogger()
          Get the (STATIC) logger for this class.
 Result run(Database database, Relation<O> relation)
          Run the algorithm.
 
Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm
makeParameterDistanceFunction, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

private static final Logging logger
The logger for this class.

Constructor Detail

DummyAlgorithm

public DummyAlgorithm()
Constructor, adhering to Parameterizable

Method Detail

run

public Result run(Database database,
                  Relation<O> relation)
Run the algorithm.

Parameters:
database - Database
relation - Relation
Returns:
Null result

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<Result>
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<Result>
Returns:
the static logger

Release 0.4.0 (2011-09-20_1324)