de.lmu.ifi.dbs.elki.database.relation

Class AbstractRelation<O>

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.database.relation.AbstractRelation<O>

Type Parameters:

O - Data type

All Implemented Interfaces:

DatabaseQuery, Relation<O>, HierarchicalResult, Result

Direct Known Subclasses:

ConvertToStringView, DBIDView, MaterializedDoubleRelation, MaterializedRelation, ProjectedView, ProxyView

public abstract class AbstractRelation<O>
extends AbstractHierarchicalResult
implements Relation<O>

Abstract base class for relations.

Since:

0.1

Author:

Erich Schubert

Field Summary

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Constructor Summary

Constructors

Constructor and Description
AbstractRelation() Constructor.

Method Summary

Modifier and Type	Method and Description
DistanceQuery<O>	getDistanceQuery(DistanceFunction<? super O> distanceFunction, java.lang.Object... hints) Get the distance query for a particular distance function.
KNNQuery<O>	getKNNQuery(DistanceQuery<O> distanceQuery, java.lang.Object... hints) Get a KNN query object for the given distance query.
protected abstract Logging	getLogger() Get the class logger.
RangeQuery<O>	getRangeQuery(DistanceQuery<O> distanceQuery, java.lang.Object... hints) Get a range query object for the given distance query.
RKNNQuery<O>	getRKNNQuery(DistanceQuery<O> distanceQuery, java.lang.Object... hints) Get a rKNN query object for the given distance query.
SimilarityQuery<O>	getSimilarityQuery(SimilarityFunction<? super O> similarityFunction, java.lang.Object... hints) Get the similarity query for a particular similarity function.
RangeQuery<O>	getSimilarityRangeQuery(SimilarityQuery<O> simQuery, java.lang.Object... hints) Get a range query object for the given similarity query.

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

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.database.relation.Relation

forEach, get, getDataTypeInformation, getDBIDs, getKNNQuery, getRangeQuery, getRKNNQuery, getSimilarityRangeQuery, iterDBIDs, size

Methods inherited from interface de.lmu.ifi.dbs.elki.result.HierarchicalResult

getHierarchy, setHierarchy

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Constructor Detail

AbstractRelation

public AbstractRelation()

Constructor.

Method Detail

getDistanceQuery

public DistanceQuery<O> getDistanceQuery(DistanceFunction<? super O> distanceFunction,
                                         java.lang.Object... hints)

Description copied from interface: Relation

Get the distance query for a particular distance function.

Specified by:

getDistanceQuery in interface Relation<O>

Parameters:

distanceFunction - Distance function to use

hints - Optimizer hints (optional)

Returns:

Instance to query the database with this distance

getSimilarityQuery

public SimilarityQuery<O> getSimilarityQuery(SimilarityFunction<? super O> similarityFunction,
                                             java.lang.Object... hints)

Description copied from interface: Relation

Get the similarity query for a particular similarity function.

Specified by:

getSimilarityQuery in interface Relation<O>

Parameters:

similarityFunction - Similarity function to use

hints - Optimizer hints (optional)

Returns:

Instance to query the database with this similarity

getKNNQuery

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

Description copied from interface: Relation

Get a KNN query object for the given distance query. When possible, this will use an index, but it may default to an expensive linear scan. Hints include:

• Integer: maximum value for k needed
• DatabaseQuery.HINT_BULK bulk query needed

Specified by:

getKNNQuery in interface Relation<O>

Parameters:

distanceQuery - Distance query

hints - Optimizer hints (optional)

Returns:

KNN Query object

getRangeQuery

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

Description copied from interface: Relation

Get a range query object for the given distance query. (Range queries in ELKI refers to radius-based ranges, not rectangular query windows.) When possible, this will use an index, but it may default to an expensive linear scan. Hints include:

• Distance object: Maximum query range
• DatabaseQuery.HINT_BULK bulk query needed

Specified by:

getRangeQuery in interface Relation<O>

Parameters:

distanceQuery - Distance query

hints - Optimizer hints (optional)

Returns:

KNN Query object

getSimilarityRangeQuery

public RangeQuery<O> getSimilarityRangeQuery(SimilarityQuery<O> simQuery,
                                             java.lang.Object... hints)

Description copied from interface: Relation

Get a range query object for the given similarity query. (Range queries in ELKI refers to radius-based ranges, not rectangular query windows.) When possible, this will use an index, but it may default to an expensive linear scan. Hints include:

• Distance object: Maximum query range
• DatabaseQuery.HINT_BULK bulk query needed

Specified by:

getSimilarityRangeQuery in interface Relation<O>

Parameters:

simQuery - Similarity query

hints - Optimizer hints (optional)

Returns:

KNN Query object

getRKNNQuery

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

Description copied from interface: Relation

Get a rKNN query object for the given distance query. When possible, this will use an index, but it may default to an expensive linear scan. Hints include:

• Integer: maximum value for k needed
• DatabaseQuery.HINT_BULK bulk query needed

Specified by:

getRKNNQuery in interface Relation<O>

Parameters:

distanceQuery - Distance query

hints - Optimizer hints (optional)

Returns:

KNN Query object

getLogger

protected abstract Logging getLogger()

Get the class logger.

Returns:

Logger