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

Class MaterializeKNNPreprocessor<O>

java.lang.Object

de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex<O,KNNList>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor<O>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.MaterializeKNNPreprocessor<O>

Type Parameters:

O - the type of database objects the preprocessor can be applied to

All Implemented Interfaces:

DynamicIndex, Index, KNNIndex<O>, Result

Direct Known Subclasses:

MaterializeKNNAndRKNNPreprocessor

@Title(value="Materialize kNN Neighborhood preprocessor")
 @Description(value="Materializes the k nearest neighbors of objects of a database.")
 @Alias(value="de.lmu.ifi.dbs.elki.preprocessing.MaterializeKNNPreprocessor")
public class MaterializeKNNPreprocessor<O>
extends AbstractMaterializeKNNPreprocessor<O>
implements DynamicIndex

A preprocessor for annotation of the k nearest neighbors (and their distances) to each database object.

Used for example by LOF.

Since:

0.2

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaterializeKNNPreprocessor.Factory<O> The parameterizable factory.

Field Summary

Fields

Modifier and Type	Field and Description
protected KNNQuery<O>	knnQuery KNNQuery instance to use.
protected javax.swing.event.EventListenerList	listenerList Holds the listener.
private static Logging	LOG Logger to use.
private static boolean	usebulk Flag to use bulk operations.

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

distanceFunction, distanceQuery, k

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

relation, storage

Constructor Summary

Constructors

Constructor and Description
MaterializeKNNPreprocessor(Relation<O> relation, DistanceFunction<? super O> distanceFunction, int k) Constructor with preprocessing step.

Method Summary

Modifier and Type	Method and Description
void	addKNNListener(KNNListener l) Adds a KNNListener which will be invoked when the kNNs of objects are changing.
boolean	delete(DBIDRef id) Deletes the specified object from this index.
void	deleteAll(DBIDs ids) Deletes the specified objects from this index.
protected void	fireKNNsInserted(DBIDs insertions, DBIDs updates) Informs all registered KNNListener that new kNNs have been inserted and as a result some kNNs have been changed.
protected void	fireKNNsRemoved(DBIDs removals, DBIDs updates) Informs all registered KNNListener that existing kNNs have been removed and as a result some kNNs have been changed.
protected Logging	getLogger() Get the classes static logger.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
java.lang.String	getShortName() A short name for the result, useful for file names.
void	insert(DBIDRef id) Inserts the specified object into this index.
void	insertAll(DBIDs ids) Inserts the specified objects into this index.
void	logStatistics() Send statistics to the logger, if enabled.
protected void	objectsInserted(DBIDs ids) Called after new objects have been inserted, updates the materialized neighborhood.
protected void	objectsRemoved(DBIDs ids) Called after objects have been removed, updates the materialized neighborhood.
protected void	preprocess() The actual preprocessing step.
void	removeKNNListener(KNNListener l) Removes a KNNListener previously added with addKNNListener(de.lmu.ifi.dbs.elki.index.preprocessed.knn.KNNListener).
private ArrayDBIDs	updateKNNsAfterDeletion(DBIDs ids) Updates the kNNs of the RkNNs of the specified ids.
private ArrayDBIDs	updateKNNsAfterInsertion(DBIDs ids) Updates the kNNs of the RkNNs of the specified ids.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor

createStorage, get, getDistanceQuery, getK, getKNNQuery, initialize

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

initialize

Field Detail

LOG

private static final Logging LOG

Logger to use.

usebulk

private static final boolean usebulk

Flag to use bulk operations. TODO: right now, bulk is not that good - so don't use

See Also:

Constant Field Values

knnQuery

protected final KNNQuery<O> knnQuery

KNNQuery instance to use.

listenerList

protected final javax.swing.event.EventListenerList listenerList

Holds the listener.

Constructor Detail

MaterializeKNNPreprocessor

public MaterializeKNNPreprocessor(Relation<O> relation,
                                  DistanceFunction<? super O> distanceFunction,
                                  int k)

Constructor with preprocessing step.

Parameters:

relation - Relation to preprocess

distanceFunction - the distance function to use

k - query k

Method Detail

preprocess

protected void preprocess()

The actual preprocessing step.

Specified by:

preprocess in class AbstractMaterializeKNNPreprocessor<O>

insert

public final void insert(DBIDRef id)

Description copied from interface: DynamicIndex

Inserts the specified object into this index.

Specified by:

insert in interface DynamicIndex

Parameters:

id - the object to be inserted

insertAll

public void insertAll(DBIDs ids)

Description copied from interface: DynamicIndex

Inserts the specified objects into this index. If a bulk load mode is implemented, the objects are inserted in one bulk.

Specified by:

insertAll in interface DynamicIndex

Parameters:

ids - the objects to be inserted

delete

public boolean delete(DBIDRef id)

Description copied from interface: DynamicIndex

Deletes the specified object from this index.

Specified by:

delete in interface DynamicIndex

Parameters:

id - Object to remove

Returns:

true if this index did contain the object, false otherwise

deleteAll

public void deleteAll(DBIDs ids)

Description copied from interface: DynamicIndex

Deletes the specified objects from this index.

Specified by:

deleteAll in interface DynamicIndex

Parameters:

ids - Objects to remove

objectsInserted

protected void objectsInserted(DBIDs ids)

Called after new objects have been inserted, updates the materialized neighborhood.

Parameters:

ids - the ids of the newly inserted objects

updateKNNsAfterInsertion

private ArrayDBIDs updateKNNsAfterInsertion(DBIDs ids)

Updates the kNNs of the RkNNs of the specified ids.

Parameters:

ids - the ids of newly inserted objects causing a change of materialized kNNs

Returns:

the RkNNs of the specified ids, i.e. the kNNs which have been updated

updateKNNsAfterDeletion

private ArrayDBIDs updateKNNsAfterDeletion(DBIDs ids)

Updates the kNNs of the RkNNs of the specified ids.

Parameters:

ids - the ids of deleted objects causing a change of materialized kNNs

Returns:

the RkNNs of the specified ids, i.e. the kNNs which have been updated

objectsRemoved

protected void objectsRemoved(DBIDs ids)

Called after objects have been removed, updates the materialized neighborhood.

Parameters:

ids - the ids of the removed objects

fireKNNsInserted

protected void fireKNNsInserted(DBIDs insertions,
                                DBIDs updates)

Informs all registered KNNListener that new kNNs have been inserted and as a result some kNNs have been changed.

Parameters:

insertions - the ids of the newly inserted kNNs

updates - the ids of kNNs which have been changed due to the insertions

See Also:

KNNListener

fireKNNsRemoved

protected void fireKNNsRemoved(DBIDs removals,
                               DBIDs updates)

Informs all registered KNNListener that existing kNNs have been removed and as a result some kNNs have been changed.

Parameters:

removals - the ids of the removed kNNs

updates - the ids of kNNs which have been changed due to the removals

See Also:

KNNListener

addKNNListener

public void addKNNListener(KNNListener l)

Adds a KNNListener which will be invoked when the kNNs of objects are changing.

Parameters:

l - the listener to add

See Also:

removeKNNListener(de.lmu.ifi.dbs.elki.index.preprocessed.knn.KNNListener), KNNListener

removeKNNListener

public void removeKNNListener(KNNListener l)

Removes a KNNListener previously added with addKNNListener(de.lmu.ifi.dbs.elki.index.preprocessed.knn.KNNListener).

Parameters:

l - the listener to remove

See Also:

addKNNListener(de.lmu.ifi.dbs.elki.index.preprocessed.knn.KNNListener), KNNListener

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

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

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

getLogger

protected Logging getLogger()

Description copied from class: AbstractPreprocessorIndex

Get the classes static logger.

Specified by:

getLogger in class AbstractPreprocessorIndex<O,KNNList>

Returns:

Logger