de.lmu.ifi.dbs.elki.index.preprocessed.preference

Class DiSHPreferenceVectorIndex<V extends NumberVector<?>>

java.lang.Object

de.lmu.ifi.dbs.elki.index.AbstractIndex<O>

de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex<NV,BitSet>

de.lmu.ifi.dbs.elki.index.preprocessed.preference.AbstractPreferenceVectorIndex<V>

de.lmu.ifi.dbs.elki.index.preprocessed.preference.DiSHPreferenceVectorIndex<V>

Type Parameters:

V - Vector type

All Implemented Interfaces:

Index, PreferenceVectorIndex<V>, Result

@Description(value="Computes the preference vector of objects of a certain database according to the DiSH algorithm.")
public class DiSHPreferenceVectorIndex<V extends NumberVector<?>>
extends AbstractPreferenceVectorIndex<V>
implements PreferenceVectorIndex<V>

Preprocessor for DiSH preference vector assignment to objects of a certain database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiSHPreferenceVectorIndex.Factory<V extends NumberVector<?>> Factory class.
static class	DiSHPreferenceVectorIndex.Strategy Available strategies for determination of the preference vector.

Field Summary

Fields

Modifier and Type	Field and Description
protected DoubleDistance[]	epsilon The epsilon value for each dimension.
private static Logging	LOG Logger to use.
protected int	minpts Threshold for minimum number of points in the neighborhood.
protected DiSHPreferenceVectorIndex.Strategy	strategy The strategy to determine the preference vector.

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex

storage

Fields inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

relation

Constructor Summary

Constructors

Constructor and Description
DiSHPreferenceVectorIndex(Relation<V> relation, DoubleDistance[] epsilon, int minpts, DiSHPreferenceVectorIndex.Strategy strategy) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private BitSet	determinePreferenceVector(Relation<V> relation, ModifiableDBIDs[] neighborIDs, StringBuilder msg) Determines the preference vector according to the specified neighbor ids.
private BitSet	determinePreferenceVectorByApriori(Relation<V> relation, ModifiableDBIDs[] neighborIDs, StringBuilder msg) Determines the preference vector with the apriori strategy.
private BitSet	determinePreferenceVectorByMaxIntersection(ModifiableDBIDs[] neighborIDs, StringBuilder msg) Determines the preference vector with the max intersection strategy.
protected Logging	getLogger() Get the classes static logger.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
String	getShortName() A short name for the result, useful for file names.
void	initialize() Initialize the index.
private RangeQuery<V,DoubleDistance>[]	initRangeQueries(Relation<V> relation, int dimensionality) Initializes the dimension selecting distancefunctions to determine the preference vectors.
void	logStatistics() Send statistics to the logger, if enabled.
private int	max(Map<Integer,ModifiableDBIDs> candidates) Returns the set with the maximum size contained in the specified map.
private int	maxIntersection(Map<Integer,ModifiableDBIDs> candidates, DBIDs set, ModifiableDBIDs result) Returns the index of the set having the maximum intersection set with the specified set contained in the specified map.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.preference.AbstractPreferenceVectorIndex

getPreferenceVector

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.index.preprocessed.preference.PreferenceVectorIndex

getPreferenceVector

Field Detail

LOG

private static final Logging LOG

Logger to use.

epsilon

protected DoubleDistance[] epsilon

The epsilon value for each dimension.

minpts

protected int minpts

Threshold for minimum number of points in the neighborhood.

strategy

protected DiSHPreferenceVectorIndex.Strategy strategy

The strategy to determine the preference vector.

Constructor Detail

DiSHPreferenceVectorIndex

public DiSHPreferenceVectorIndex(Relation<V> relation,
                         DoubleDistance[] epsilon,
                         int minpts,
                         DiSHPreferenceVectorIndex.Strategy strategy)

Constructor.

Parameters:

relation - Relation to use

epsilon - Epsilon value

minpts - MinPts value

strategy - Strategy

Method Detail

initialize

public void initialize()

Description copied from interface: Index

Initialize the index. For static indexes, this is the moment the index is bulk loaded.

Specified by:

initialize in interface Index

determinePreferenceVector

private BitSet determinePreferenceVector(Relation<V> relation,
                               ModifiableDBIDs[] neighborIDs,
                               StringBuilder msg)
                                  throws UnableToComplyException

Determines the preference vector according to the specified neighbor ids.

Parameters:

relation - the database storing the objects

neighborIDs - the list of ids of the neighbors in each dimension

msg - a string buffer for debug messages

Returns:

the preference vector

Throws:

UnableToComplyException

determinePreferenceVectorByApriori

private BitSet determinePreferenceVectorByApriori(Relation<V> relation,
                                        ModifiableDBIDs[] neighborIDs,
                                        StringBuilder msg)
                                           throws UnableToComplyException

Determines the preference vector with the apriori strategy.

Parameters:

relation - the database storing the objects

neighborIDs - the list of ids of the neighbors in each dimension

msg - a string buffer for debug messages

Returns:

the preference vector

Throws:

UnableToComplyException

determinePreferenceVectorByMaxIntersection

private BitSet determinePreferenceVectorByMaxIntersection(ModifiableDBIDs[] neighborIDs,
                                                StringBuilder msg)

Determines the preference vector with the max intersection strategy.

Parameters:

neighborIDs - the list of ids of the neighbors in each dimension

msg - a string buffer for debug messages

Returns:

the preference vector

max

private int max(Map<Integer,ModifiableDBIDs> candidates)

Returns the set with the maximum size contained in the specified map.

Parameters:

candidates - the map containing the sets

Returns:

the set with the maximum size

maxIntersection

private int maxIntersection(Map<Integer,ModifiableDBIDs> candidates,
                  DBIDs set,
                  ModifiableDBIDs result)

Returns the index of the set having the maximum intersection set with the specified set contained in the specified map.

Parameters:

candidates - the map containing the sets

set - the set to intersect with

result - the set to put the result in

Returns:

the set with the maximum size

initRangeQueries

private RangeQuery<V,DoubleDistance>[] initRangeQueries(Relation<V> relation,
                                              int dimensionality)

Initializes the dimension selecting distancefunctions to determine the preference vectors.

Parameters:

relation - the database storing the objects

dimensionality - the dimensionality of the objects

Returns:

the dimension selecting distancefunctions to determine the preference vectors

getLogger

protected Logging getLogger()

Description copied from class: AbstractPreprocessorIndex

Get the classes static logger.

Specified by:

getLogger in class AbstractPreprocessorIndex<V extends NumberVector<?>,BitSet>

Returns:

Logger

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Specified by:

getLongName in class AbstractIndex<V extends NumberVector<?>>

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Specified by:

getShortName in class AbstractIndex<V extends NumberVector<?>>

Returns:

result name

logStatistics

public void logStatistics()

Description copied from interface: Index

Send statistics to the logger, if enabled. Note: you must have set the logging level appropriately before initializing the index! Otherwise, the index might not have collected the desired statistics.

Specified by:

logStatistics in interface Index