# NearestNeighbors

public final class **NearestNeighbors** Selects the k nearest centers for each point.


Rows of points are assumed to be input points. Rows of centers are assumed to be
the list of candidate centers. For each point, the k centers that have least L2
distance to it are computed.

<br />

### Public Methods

|---|---|
| static [NearestNeighbors](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/NearestNeighbors) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/NearestNeighbors#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<java.lang.Float>,%20org.tensorflow.Operand<java.lang.Float>,%20org.tensorflow.Operand<java.lang.Long>))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\> points, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\> centers, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Long\> k) Factory method to create a class wrapping a new NearestNeighbors operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Float\> | [nearestCenterDistances](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/NearestNeighbors#nearestCenterDistances())() Matrix of shape (n, min(m, k)). |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\> | [nearestCenterIndices](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/NearestNeighbors#nearestCenterIndices())() Matrix of shape (n, min(m, k)). |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [NearestNeighbors](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/NearestNeighbors)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\> points, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\> centers, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Long\> k)

Factory method to create a class wrapping a new NearestNeighbors operation.

##### Parameters

| scope | current scope |
| points | Matrix of shape (n, d). Rows are assumed to be input points. |
| centers | Matrix of shape (m, d). Rows are assumed to be centers. |
| k | Number of nearest centers to return for each point. If k is larger than m, then only m centers are returned. |
|---|---|

##### Returns

- a new instance of NearestNeighbors

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Float\>
**nearestCenterDistances**
()

Matrix of shape (n, min(m, k)). Each row contains the squared L2 distance to the
corresponding center in nearest_center_indices.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\>
**nearestCenterIndices**
()

Matrix of shape (n, min(m, k)). Each row contains the indices of the centers
closest to the corresponding point, ordered by increasing distance.