Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.application.cache
Class CacheFloatDistanceInOnDiskMatrix<O extends DatabaseObject,N extends NumberDistance<N,D>,D extends Number>

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.application.AbstractApplication
              extended by de.lmu.ifi.dbs.elki.application.cache.CacheFloatDistanceInOnDiskMatrix<O,N,D>
All Implemented Interfaces:
Parameterizable

public class CacheFloatDistanceInOnDiskMatrix<O extends DatabaseObject,N extends NumberDistance<N,D>,D extends Number>
extends AbstractApplication

Wrapper to convert a traditional text-serialized result into a on-disk matrix for random access.

Author:
Erich Schubert

Field Summary
static OptionID CACHE_ID
          OptionID for CACHE_PARAM
private  FileParameter CACHE_PARAM
          Parameter that specifies the name of the directory to be re-parsed.
private  ClassParameter<DatabaseConnection<O>> DATABASE_CONNECTION_PARAM
          Parameter to specify the database connection to be used, must extend DatabaseConnection.
private  DatabaseConnection<O> databaseConnection
          Holds the database connection to have the algorithm run with.
private static boolean debugExtraCheckSymmetry
          Debug flag, to double-check all write operations.
private static boolean debugExtraCheckWrites
          Debug flag, to double-check all write operations.
private  DistanceFunction<O,N> distance
          Distance function that is to be cached.
static OptionID DISTANCE_ID
          OptionID for DISTANCE_PARAM
private  ClassParameter<DistanceFunction<O,N>> DISTANCE_PARAM
          Parameter that specifies the name of the directory to be re-parsed.
private static int FLOAT_SIZE
          Storage size: 4 bytes floats
 
Fields inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
INFORMATION
 
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
CacheFloatDistanceInOnDiskMatrix()
          Constructor.
 
Method Summary
static void main(String[] args)
          Main method, delegate to super class.
 void run()
          Runs the application.
 List<String> setParameters(List<String> args)
          Grabs all specified options from the option handler.
 
Methods inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
getRemainingParameters, isVerbose, runCLIApplication, usage
 
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
 

Field Detail

DATABASE_CONNECTION_PARAM

private final ClassParameter<DatabaseConnection<O extends DatabaseObject>> DATABASE_CONNECTION_PARAM
Parameter to specify the database connection to be used, must extend DatabaseConnection.

Key: -dbc

Default value: FileBasedDatabaseConnection


CACHE_ID

public static final OptionID CACHE_ID
OptionID for CACHE_PARAM


CACHE_PARAM

private final FileParameter CACHE_PARAM
Parameter that specifies the name of the directory to be re-parsed.

Key: -loader.diskcache


debugExtraCheckWrites

private static final boolean debugExtraCheckWrites
Debug flag, to double-check all write operations.

See Also:
Constant Field Values

debugExtraCheckSymmetry

private static final boolean debugExtraCheckSymmetry
Debug flag, to double-check all write operations.

See Also:
Constant Field Values

DISTANCE_ID

public static final OptionID DISTANCE_ID
OptionID for DISTANCE_PARAM


FLOAT_SIZE

private static final int FLOAT_SIZE
Storage size: 4 bytes floats

See Also:
Constant Field Values

DISTANCE_PARAM

private final ClassParameter<DistanceFunction<O extends DatabaseObject,N extends NumberDistance<N,D>>> DISTANCE_PARAM
Parameter that specifies the name of the directory to be re-parsed.

Key: -loader.distance


databaseConnection

private DatabaseConnection<O extends DatabaseObject> databaseConnection
Holds the database connection to have the algorithm run with.


distance

private DistanceFunction<O extends DatabaseObject,N extends NumberDistance<N,D>> distance
Distance function that is to be cached.

Constructor Detail

CacheFloatDistanceInOnDiskMatrix

public CacheFloatDistanceInOnDiskMatrix()
Constructor.

Method Detail

run

public void run()
Description copied from class: AbstractApplication
Runs the application.

Specified by:
run in class AbstractApplication

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException
Description copied from class: AbstractParameterizable
Grabs all specified options from the option handler. Any extending class should call this method first and return the returned array without further changes, but after setting further required parameters. An example for overwriting this method taking advantage from the previously (in superclasses) defined options would be:

 {
   List remainingParameters = super.setParameters(args);
   // set parameters for your class
   // for example like this:
   if(isSet(MY_PARAM_VALUE_PARAM))
   {
      myParamValue = getParameterValue(MY_PARAM_VALUE_PARAM);
   }
   .
   .
   .
   return remainingParameters;
   // or in case of attributes requesting parameters themselves
   // return parameterizableAttribbute.setParameters(remainingParameters);
 }
 

Specified by:
setParameters in interface Parameterizable
Overrides:
setParameters in class AbstractApplication
Parameters:
args - parameters to set the attributes accordingly to
Returns:
a list containing the unused parameters
Throws:
ParameterException - in case of wrong parameter-setting

main

public static void main(String[] args)
Main method, delegate to super class.

Parameters:
args -

Release 0.2 (2009-07-06_1820)