de.lmu.ifi.dbs.elki.algorithm
Class NullAlgorithm<V extends NumberVector<V,?>>
java.lang.Object
de.lmu.ifi.dbs.elki.logging.AbstractLoggable
de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<V,Result>
de.lmu.ifi.dbs.elki.algorithm.NullAlgorithm<V>
- Type Parameters:
V
- Vector type
- All Implemented Interfaces:
- Algorithm<V,Result>, Parameterizable
public class NullAlgorithm<V extends NumberVector<V,?>>
- extends AbstractAlgorithm<V,Result>
Null Algorithm, which does nothing.
Can be used to e.g. just visualize a data set.
- Author:
- Erich Schubert
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable, shortDescription |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
NullAlgorithm
public NullAlgorithm()
- Empty constructor. Nothing to do.
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).
getDescription
public Description getDescription()
- Describe the algorithm and it's use.
- Returns:
- a description of the algorithm
getResult
public Result getResult()
- Return a result object
- Returns:
- the result of the algorithm