KNNProcessor (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.parallel.processor.KNNProcessor

All Implemented Interfaces:

Processor
```
public class KNNProcessor
extends java.lang.Object
implements Processor
```
Processor to compute the kNN of each object.

Since:

0.7.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class KNNProcessor.Instance
Instance for precomputing the kNN.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) int`	`k`	K parameter
`(package private) java.util.function.Supplier<KNNSearcher<DBIDRef>>`	`knnq`	KNN query object
`(package private) SharedObject<KNNList>`	`out`	Output channel to write to

Constructor Summary

Constructors
Constructor Description

KNNProcessor(int k, java.util.function.Supplier<KNNSearcher<DBIDRef>> knnq)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cleanup(Processor.Instance inst)`	Invoke cleanup.
`void`	`connectKNNOutput(SharedObject<KNNList> output)`	Connect the output channel.
`KNNProcessor.Instance`	`instantiate(Executor executor)`	Create an instance.

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

- Field Detail
  - k
```
int k
```
    K parameter
  - knnq
```
java.util.function.Supplier<KNNSearcher<DBIDRef>> knnq
```
    KNN query object
  - out
```
SharedObject<KNNList> out
```
    Output channel to write to
- Constructor Detail
  - KNNProcessor
```
public KNNProcessor(int k,
                    java.util.function.Supplier<KNNSearcher<DBIDRef>> knnq)
```
    Constructor.
    
    Parameters:
    
    k - K parameter
    
    knnq - Distance query to use
- Method Detail
  - connectKNNOutput
```
public void connectKNNOutput(SharedObject<KNNList> output)
```
    Connect the output channel.
    
    Parameters:
    
    output - Output channel
  - instantiate
```
public KNNProcessor.Instance instantiate(Executor executor)
```
    Description copied from interface: Processor
    
    Create an instance. May be called multiple times, for example for multiple threads.
    
    Specified by:
    
    instantiate in interface Processor
    
    Parameters:
    
    executor - Job executor
    
    Returns:
    
    Instance
  - cleanup
```
public void cleanup(Processor.Instance inst)
```
    Description copied from interface: Processor
    
    Invoke cleanup.
    
    Specified by:
    
    cleanup in interface Processor
    
    Parameters:
    
    inst - Instance to cleanup.