Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          extended by de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<V,Result>
              extended by 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

Field Summary
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
optionHandler
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug, logger
 
Constructor Summary
NullAlgorithm()
          Empty constructor.
 
Method Summary
 Description getDescription()
          Describe the algorithm and it's use.
 Result getResult()
          Return a result object
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, setParameters, setTime, setVerbose
 
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 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
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, collectOptions, getParameters, shortDescription
 

Constructor Detail

NullAlgorithm

public NullAlgorithm()
Empty constructor. Nothing to do.

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).

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

Release 0.2 (2009-07-06_1820)