de.lmu.ifi.dbs.elki.distance.distancefunction.external
Class FileBasedDoubleDistanceFunction<V extends DatabaseObject>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
          de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<V,DoubleDistance>
              de.lmu.ifi.dbs.elki.distance.distancefunction.external.FileBasedDoubleDistanceFunction<V>

Type Parameters:

V - Vector type

All Implemented Interfaces:

DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, Parameterizable

@Title(value="File based double distance for database objects.")
@Description(value="Loads double distance values from an external text file.")
public class FileBasedDoubleDistanceFunction<V extends DatabaseObject>
extends AbstractDistanceFunction<V,DoubleDistance>
implements Parameterizable

Provides a DistanceFunction that is based on double distances given by a distance matrix of an external file.

Author:

Elke Achtert

Field Summary

private Map<Pair<Integer,Integer>,DoubleDistance>	cache
static OptionID	MATRIX_ID OptionID for MATRIX_PARAM
private FileParameter	MATRIX_PARAM Parameter that specifies the name of the directory to be re-parsed.
private DistanceParser<V,DoubleDistance>	parser
static OptionID	PARSER_ID OptionID for PARSER_PARAM
private ObjectParameter<DistanceParser<V,DoubleDistance>>	PARSER_PARAM Optional parameter to specify the parsers to provide a database, must extend DistanceParser.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

distanceFactory

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

FileBasedDoubleDistanceFunction(Parameterization config)
Constructor, adhering to Parameterizable

Method Summary

DoubleDistance	distance(Integer id1, Integer id2) Returns the distance between the two objects specified by their objects ids.
DoubleDistance	distance(Integer id1, V o2) Returns the distance between the two specified objects.
DoubleDistance	distance(V o1, V o2) Computes the distance between two given DatabaseObjects according to this distance function.
Collection<Integer>	getIDs() Return a collection of all IDs in the cache.
private void	loadCache(File matrixfile)

Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

getDatabase, getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

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.distance.MeasurementFunction

getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

Field Detail

MATRIX_ID

public static final OptionID MATRIX_ID

OptionID for MATRIX_PARAM

MATRIX_PARAM

private final FileParameter MATRIX_PARAM

Parameter that specifies the name of the directory to be re-parsed.

Key: -distance.matrix

PARSER_ID

public static final OptionID PARSER_ID

OptionID for PARSER_PARAM

PARSER_PARAM

private final ObjectParameter<DistanceParser<V extends DatabaseObject,DoubleDistance>> PARSER_PARAM

Optional parameter to specify the parsers to provide a database, must extend DistanceParser. If this parameter is not set, NumberDistanceParser is used as parser for all input files.

Key: -distance.parser

parser

private DistanceParser<V extends DatabaseObject,DoubleDistance> parser

cache

private Map<Pair<Integer,Integer>,DoubleDistance> cache

Constructor Detail

FileBasedDoubleDistanceFunction

public FileBasedDoubleDistanceFunction(Parameterization config)

Constructor, adhering to Parameterizable

Parameters:

config - Parameterization

Method Detail

distance

public DoubleDistance distance(V o1,
                               V o2)

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface DistanceFunction<V extends DatabaseObject,DoubleDistance>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObject according to this distance function

distance

public DoubleDistance distance(Integer id1,
                               V o2)

Returns the distance between the two specified objects.

Specified by:

distance in interface DistanceFunction<V extends DatabaseObject,DoubleDistance>

Overrides:

distance in class AbstractDistanceFunction<V extends DatabaseObject,DoubleDistance>

Parameters:

id1 - first object id

o2 - second DatabaseObject

Returns:

the distance between the two objects specified by their objects ids

distance

public DoubleDistance distance(Integer id1,
                               Integer id2)

Returns the distance between the two objects specified by their objects ids. If a cache is used, the distance value is looked up in the cache. If the distance does not yet exists in cache, it will be computed an put to cache. If no cache is used, the distance is computed.

Specified by:

distance in interface DistanceFunction<V extends DatabaseObject,DoubleDistance>

Overrides:

distance in class AbstractDistanceFunction<V extends DatabaseObject,DoubleDistance>

Parameters:

id1 - first object id

id2 - second object id

Returns:

the distance between the two objects specified by their objects ids

loadCache

private void loadCache(File matrixfile)
                throws IOException

Throws:

IOException

getIDs

public Collection<Integer> getIDs()

Return a collection of all IDs in the cache.

Returns:

Collection of all IDs in the cache.