de.lmu.ifi.dbs.elki.index.projected

Class ProjectedIndex<O,I>

java.lang.Object

de.lmu.ifi.dbs.elki.index.projected.ProjectedIndex<O,I>

Type Parameters:

O - Outer object type.

I - Inner object type.

All Implemented Interfaces:

Index, KNNIndex<O>, RangeIndex<O>, RKNNIndex<O>, Result

Direct Known Subclasses:

LatLngAsECEFIndex, LngLatAsECEFIndex

public class ProjectedIndex<O,I>
extends Object
implements KNNIndex<O>, RKNNIndex<O>, RangeIndex<O>

Class to index data in an arbitrary projection only. Note: be careful when using this class, as it may/will yield incorrect distances, depending on your projection! It may be desirable to use a modified index that corrects for this error, or supports specific combiantions only. See LatLngAsECEFIndex and LngLatAsECEFIndex for example indexes that support only a specific (good) combination. FIXME: add refinement to bulk queries!

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectedIndex.Factory<O,I> Index factory.
(package private) class	ProjectedIndex.ProjectedKNNQuery Class to proxy kNN queries.
(package private) class	ProjectedIndex.ProjectedRangeQuery Class to proxy range queries.
(package private) class	ProjectedIndex.ProjectedRKNNQuery Class to proxy RkNN queries.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Index	inner Inner index.
(package private) double	kmulti Multiplier for k.
private static Logging	LOG Class logger
(package private) boolean	norefine Refinement disable flag.
(package private) Projection<O,I>	proj Projection.
(package private) Counter	refinements Count the number of distance refinements computed.
(package private) Relation<O>	relation The relation we predend to index.
(package private) Relation<I>	view The view that we really index.

Constructor Summary

Constructors

Constructor and Description
ProjectedIndex(Relation<O> relation, Projection<O,I> proj, Relation<I> view, Index inner, boolean norefine, double kmulti) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private void	countRefinement() Count a single distance refinement.
KNNQuery<O>	getKNNQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a KNN query object for the given distance query and k.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
RangeQuery<O>	getRangeQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a range query object for the given distance query and k.
RKNNQuery<O>	getRKNNQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a KNN query object for the given distance query and k.
String	getShortName() A short name for the result, useful for file names.
void	initialize() Initialize the index.
void	logStatistics() Send statistics to the logger, if enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final Logging LOG

Class logger

inner

Index inner

Inner index.

proj

Projection<O,I> proj

Projection.

relation

Relation<O> relation

The relation we predend to index.

view

Relation<I> view

The view that we really index.

norefine

boolean norefine

Refinement disable flag.

kmulti

double kmulti

Multiplier for k.

refinements

final Counter refinements

Count the number of distance refinements computed.

Constructor Detail

ProjectedIndex

public ProjectedIndex(Relation<O> relation,
              Projection<O,I> proj,
              Relation<I> view,
              Index inner,
              boolean norefine,
              double kmulti)

Constructor.

Parameters:

relation - Relation to index.

proj - Projection to use.

view - View to use.

inner - Index to wrap.

norefine - Refinement disable flag.

kmulti - Multiplicator for k

Method Detail

countRefinement

private void countRefinement()

Count a single distance refinement.

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

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

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

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

getKNNQuery

public KNNQuery<O> getKNNQuery(DistanceQuery<O> distanceQuery,
                      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<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getRangeQuery

public RangeQuery<O> getRangeQuery(DistanceQuery<O> distanceQuery,
                          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<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getRKNNQuery

public RKNNQuery<O> getRKNNQuery(DistanceQuery<O> distanceQuery,
                        Object... hints)

Description copied from interface: RKNNIndex

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:

getRKNNQuery in interface RKNNIndex<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null