de.lmu.ifi.dbs.elki.index.lsh

Class InMemoryLSHIndex.Instance

java.lang.Object

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

de.lmu.ifi.dbs.elki.index.AbstractRefiningIndex<V>

de.lmu.ifi.dbs.elki.index.lsh.InMemoryLSHIndex.Instance

All Implemented Interfaces:

Index, KNNIndex<V>, RangeIndex<V>, Result

Enclosing class:

InMemoryLSHIndex<V>

public class InMemoryLSHIndex.Instance
extends AbstractRefiningIndex<V>
implements KNNIndex<V>, RangeIndex<V>

Instance of a LSH index for a single relation.

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	InMemoryLSHIndex.Instance.LSHKNNQuery Class for handling kNN queries against the LSH index.
protected class	InMemoryLSHIndex.Instance.LSHRangeQuery Class for handling kNN queries against the LSH index.

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.index.AbstractRefiningIndex

AbstractRefiningIndex.AbstractKNNQuery, AbstractRefiningIndex.AbstractRangeQuery

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.ArrayList<? extends LocalitySensitiveHashFunction<? super V>>	hashfunctions Hash functions to use.
(package private) java.util.ArrayList<it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap<DBIDs>>	hashtables The actual table
private int	numberOfBuckets Number of buckets to use.

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

relation

Constructor Summary

Constructors

Constructor and Description
Instance(Relation<V> relation, java.util.ArrayList<? extends LocalitySensitiveHashFunction<? super V>> hashfunctions, int numberOfBuckets) Constructor.

Method Summary

Modifier and Type	Method and Description
protected DBIDs	getCandidates(V obj) Get the candidates: points which have at least one hash bucket in common.
KNNQuery<V>	getKNNQuery(DistanceQuery<V> distanceQuery, java.lang.Object... hints) Get a KNN query object for the given distance query and k.
Logging	getLogger() Get the class logger.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
RangeQuery<V>	getRangeQuery(DistanceQuery<V> distanceQuery, java.lang.Object... hints) Get a range query object for the given distance query and k.
java.lang.String	getShortName() A short name for the result, useful for file names.
void	initialize() Initialize the index.

Methods inherited from class de.lmu.ifi.dbs.elki.index.AbstractRefiningIndex

countRefinements, logStatistics, refine

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

logStatistics

Field Detail

hashfunctions

java.util.ArrayList<? extends LocalitySensitiveHashFunction<? super V>> hashfunctions

Hash functions to use.

hashtables

java.util.ArrayList<it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap<DBIDs>> hashtables

The actual table

numberOfBuckets

private int numberOfBuckets

Number of buckets to use.

Constructor Detail

Instance

public Instance(Relation<V> relation,
                java.util.ArrayList<? extends LocalitySensitiveHashFunction<? super V>> hashfunctions,
                int numberOfBuckets)

Constructor.

Parameters:

relation - Relation to index.

hashfunctions - Hash functions.

Method Detail

getLongName

public java.lang.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>

Returns:

result name

getShortName

public java.lang.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>

Returns:

result name

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

getLogger

public Logging getLogger()

Description copied from class: AbstractRefiningIndex

Get the class logger.

Specified by:

getLogger in class AbstractRefiningIndex<V>

Returns:

Logger

getKNNQuery

public KNNQuery<V> getKNNQuery(DistanceQuery<V> distanceQuery,
                               java.lang.Object... hints)

Description copied from interface: KNNIndex

Get a KNN query object for the given distance query and k. This function MAY return null, when the given distance is not supported!

Specified by:

getKNNQuery in interface KNNIndex<V>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getRangeQuery

public RangeQuery<V> getRangeQuery(DistanceQuery<V> distanceQuery,
                                   java.lang.Object... hints)

Description copied from interface: RangeIndex

Get a range query object for the given distance query and k. This function MAY return null, when the given distance is not supported!

Specified by:

getRangeQuery in interface RangeIndex<V>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getCandidates

protected DBIDs getCandidates(V obj)

Get the candidates: points which have at least one hash bucket in common.

Parameters:

obj - Query object

Returns:

Candidates