VPTree.Factory (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.index.tree.metrical.vptree.VPTree.Factory<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

IndexFactory<O>

Enclosing class:

VPTree<O>
```
@Alias("vp")
public static class VPTree.Factory<O extends NumberVector>
extends java.lang.Object
implements IndexFactory<O>
```
Index factory for the VP-Tree

Author:

Robert Gehde

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VPTree.Factory.Par<O extends NumberVector>
Parameterization class.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) Distance<? super O>`	`distance`	Distance Function
`(package private) RandomFactory`	`random`	Random factory
`(package private) int`	`sampleSize`	Sample size
`(package private) int`	`truncate`	Truncation parameter

Constructor Summary

Constructors
Constructor Description

Factory(Distance<? super O> distFunc, RandomFactory random, int sampleSize, int truncate)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TypeInformation`	`getInputTypeRestriction()`	Get the input type restriction used for negotiating the data query.
`VPTree<O>`	`instantiate(Relation<O> relation)`	Sets the database in the distance function of this index (if existing).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - distance
```
Distance<? super O extends NumberVector> distance
```
    Distance Function
  - random
```
RandomFactory random
```
    Random factory
  - sampleSize
```
int sampleSize
```
    Sample size
  - truncate
```
int truncate
```
    Truncation parameter
- Constructor Detail
  - Factory
```
public Factory(Distance<? super O> distFunc,
               RandomFactory random,
               int sampleSize,
               int truncate)
```
    Constructor.
- Method Detail
  - instantiate
```
public VPTree<O> instantiate(Relation<O> relation)
```
    Description copied from interface: IndexFactory
    
    Sets the database in the distance function of this index (if existing).
    
    Specified by:
    
    instantiate in interface IndexFactory<O extends NumberVector>
    
    Parameters:
    
    relation - the relation to index
  - getInputTypeRestriction
```
public TypeInformation getInputTypeRestriction()
```
    Description copied from interface: IndexFactory
    
    Get the input type restriction used for negotiating the data query.
    
    Specified by:
    
    getInputTypeRestriction in interface IndexFactory<O extends NumberVector>
    
    Returns:
    
    Type restriction