de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants
Class AbstractMTreeFactory<O,D extends Distance<D>,N extends AbstractMTreeNode<O,D,N,E>,E extends MTreeEntry<D>,I extends AbstractMTree<O,D,N,E> & Index>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.index.tree.TreeIndexFactory<O,I>
      extended by de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.AbstractMTreeFactory<O,D,N,E,I>
Type Parameters:
O - Object type
D - Distance type
N - Node type
E - Entry type
I - Index type
All Implemented Interfaces:
IndexFactory<O,I>, InspectionUtilFrequentlyScanned, Parameterizable
Direct Known Subclasses:
AbstractMkTreeUnifiedFactory, MkAppTreeFactory, MkCopTreeFactory, MTreeFactory

public abstract class AbstractMTreeFactory<O,D extends Distance<D>,N extends AbstractMTreeNode<O,D,N,E>,E extends MTreeEntry<D>,I extends AbstractMTree<O,D,N,E> & Index>
extends TreeIndexFactory<O,I>

Abstract factory for various MTrees


Nested Class Summary
static class AbstractMTreeFactory.Parameterizer<O,D extends Distance<D>>
          Parameterization class.
 
Field Summary
static OptionID DISTANCE_FUNCTION_ID
          Parameter to specify the distance function to determine the distance between database objects, must extend DistanceFunction.
protected  DistanceFunction<O,D> distanceFunction
          Holds the instance of the distance function specified by DISTANCE_FUNCTION_ID.
 
Fields inherited from class de.lmu.ifi.dbs.elki.index.tree.TreeIndexFactory
CACHE_SIZE_ID, cacheSize, FILE_ID, fileName, PAGE_SIZE_ID, pageSize
 
Constructor Summary
AbstractMTreeFactory(String fileName, int pageSize, long cacheSize, DistanceFunction<O,D> distanceFunction)
          Constructor.
 
Method Summary
 TypeInformation getInputTypeRestriction()
          Get the input type restriction used for negotiating the data query.
 
Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.TreeIndexFactory
instantiate, makePageFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISTANCE_FUNCTION_ID

public static final OptionID DISTANCE_FUNCTION_ID
Parameter to specify the distance function to determine the distance between database objects, must extend DistanceFunction.

Key: -mtree.distancefunction

Default value: EuclideanDistanceFunction


distanceFunction

protected DistanceFunction<O,D extends Distance<D>> distanceFunction
Holds the instance of the distance function specified by DISTANCE_FUNCTION_ID.

Constructor Detail

AbstractMTreeFactory

public AbstractMTreeFactory(String fileName,
                            int pageSize,
                            long cacheSize,
                            DistanceFunction<O,D> distanceFunction)
Constructor.

Parameters:
fileName -
pageSize -
cacheSize -
distanceFunction -
Method Detail

getInputTypeRestriction

public TypeInformation getInputTypeRestriction()
Description copied from interface: IndexFactory
Get the input type restriction used for negotiating the data query.

Returns:
Type restriction

Release 0.4.0 (2011-09-20_1324)