de.lmu.ifi.dbs.elki.algorithm
Class AbstractAlgorithm<O extends DatabaseObject,R extends Result>

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<O,R>

Type Parameters:

O - the type of DatabaseObjects handled by this Algorithm

R - the type of result to retrieve from this Algorithm

All Implemented Interfaces:

Algorithm<O,R>, Parameterizable

Direct Known Subclasses:

APRIORI, ByLabelClustering, ByLabelHierarchicalClustering, CASH, CLIQUE, ComputeROCCurve, COPAC, DiSH, DistanceBasedAlgorithm, DummyAlgorithm, EM, ERiC, NullAlgorithm, ProjectedClustering, ProjectedDBSCAN, SNNClustering, SOD, TrivialAllInOne, TrivialAllNoise

public abstract class AbstractAlgorithm<O extends DatabaseObject,R extends Result>
extends AbstractParameterizable
implements Algorithm<O,R>

AbstractAlgorithm sets the values for flags verbose and time.

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. Beware to make correct use of parameter settings via the facilities provided within AbstractParameterizable as commented with constructor and methods.

Author:

Arthur Zimek

Field Summary

private boolean	time Holds the value of TIME_FLAG.
private Flag	TIME_FLAG Flag to request output of performance time.
private boolean	verbose Holds the value of VERBOSE_FLAG.
private Flag	VERBOSE_FLAG Flag to allow verbose messages while performing the algorithm.

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

protected

AbstractAlgorithm() Adds the flags VERBOSE_FLAG and TIME_FLAG to the option handler.

Method Summary

boolean	isTime() Returns whether the performance time of the algorithm should be assessed.
boolean	isVerbose() Returns whether verbose messages should be printed while executing the algorithm.
R	run(Database<O> database) Calls the runInTime()-method of extending classes.
protected abstract R	runInTime(Database<O> database) The run method encapsulated in measure of runtime.
List<String>	setParameters(List<String> args) Calls the super method and sets additionally the values of the flags VERBOSE_FLAG and TIME_FLAG.
void	setTime(boolean time) Sets whether whether the time should be assessed while executing the algorithm.
void	setVerbose(boolean verbose) Sets whether verbose messages should be printed while executing the algorithm.

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.algorithm.Algorithm

getDescription, getResult

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable

checkGlobalParameterConstraints, collectOptions, getParameters, shortDescription

Field Detail

VERBOSE_FLAG

private final Flag VERBOSE_FLAG

Flag to allow verbose messages while performing the algorithm.

Key: -verbose

verbose

private boolean verbose

Holds the value of VERBOSE_FLAG.

TIME_FLAG

private final Flag TIME_FLAG

Flag to request output of performance time.

Key: -time

time

private boolean time

Holds the value of TIME_FLAG.

Constructor Detail

AbstractAlgorithm

protected AbstractAlgorithm()

Adds the flags VERBOSE_FLAG and TIME_FLAG to the option handler. Any extending class should call this constructor, then add further parameters. Subclasses can add further parameters using AbstractParameterizable.addOption(de.lmu.ifi.dbs.elki.utilities.optionhandling.Option)

Method Detail

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException

Calls the super method and sets additionally the values of the flags VERBOSE_FLAG and TIME_FLAG.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class AbstractParameterizable

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

isTime

public boolean isTime()

Returns whether the performance time of the algorithm should be assessed.

Returns:

true, if output of performance time is requested, false otherwise

isVerbose

public boolean isVerbose()

Returns whether verbose messages should be printed while executing the algorithm.

Returns:

true, if verbose messages should be printed while executing the algorithm, false otherwise

setVerbose

public void setVerbose(boolean verbose)

Description copied from interface: Algorithm

Sets whether verbose messages should be printed while executing the algorithm.

Specified by:

setVerbose in interface Algorithm<O extends DatabaseObject,R extends Result>

Parameters:

verbose - the flag to allow verbose messages while performing the algorithm

setTime

public void setTime(boolean time)

Description copied from interface: Algorithm

Sets whether whether the time should be assessed while executing the algorithm.

Specified by:

setTime in interface Algorithm<O extends DatabaseObject,R extends Result>

Parameters:

time - the flag to request output of performance time

run

public final R run(Database<O> database)
                           throws IllegalStateException

Calls the runInTime()-method of extending classes. Measures and prints the runtime and, in case of an index based database, the I/O costs of this method.

Specified by:

run in interface Algorithm<O extends DatabaseObject,R extends 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).

runInTime

protected abstract R runInTime(Database<O> database)
                                       throws IllegalStateException

The run method encapsulated in measure of runtime. An extending class needs not to take care of runtime itself.

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