# Gather

public final class **Gather** Gather slices from \`params\` axis \`axis\` according to \`indices\`.


\`indices\` must be an integer tensor of any dimension (usually 0-D or 1-D).
Produces an output tensor with shape \`params.shape\[:axis\] +
indices.shape\[batch_dims:\] + params.shape\[axis + 1:\]\` where:

    # Scalar indices (output is rank(params) - 1).
         output[a_0, ..., a_n, b_0, ..., b_n] =
           params[a_0, ..., a_n, indices, b_0, ..., b_n]
     
         # Vector indices (output is rank(params)).
         output[a_0, ..., a_n, i, b_0, ..., b_n] =
           params[a_0, ..., a_n, indices[i], b_0, ..., b_n]
     
         # Higher rank indices (output is rank(params) + rank(indices) - 1).
         output[a_0, ..., a_n, i, ..., j, b_0, ... b_n] =
           params[a_0, ..., a_n, indices[i, ..., j], b_0, ..., b_n]
     
![](https://www.tensorflow.org/images/Gather.png)


Note that on CPU, if an out of bound index is found, an error is returned.
On GPU, if an out of bound index is found, a 0 is stored in the
corresponding output value.


See also \`tf.batch_gather\` and [`tf.gather_nd`](https://www.tensorflow.org/api_docs/python/tf/gather_nd).

<br />

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [Gather.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather` |

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather#asOutput())() Returns the symbolic handle of a tensor. |
| static [Gather.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather.Options) | [batchDims](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather#batchDims(java.lang.Long))(Long batchDims) |
| static \<T, U extends Number, V extends Number\> [Gather](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.Operand<V>,%20org.tensorflow.op.core.Gather.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> params, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> indices, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<V\> axis, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather.Options) options) Factory method to create a class wrapping a new Gather operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather#output())() Values from \`params\` gathered from indices given by \`indices\`, with shape \`params.shape\[:axis\] + indices.shape + params.shape\[axis + 1:\]\`. |

### 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() |

From interface [org.tensorflow.Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)

|---|---|
| abstract [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |

## Public Methods

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

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.

<br />

#### public static [Gather.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather.Options)
**batchDims**
(Long batchDims)

<br />

#### public static [Gather](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather)\<T\>
**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)\<T\> params, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> indices, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<V\> axis, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gather.Options) options)

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

##### Parameters

| scope | current scope |
| params | The tensor from which to gather values. Must be at least rank \`axis + 1\`. |
| indices | Index tensor. Must be in range \`\[0, params.shape\[axis\])\`. |
| axis | The axis in \`params\` to gather \`indices\` from. Defaults to the first dimension. Supports negative indexes. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of Gather

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

Values from \`params\` gathered from indices given by \`indices\`, with
shape \`params.shape\[:axis\] + indices.shape + params.shape\[axis + 1:\]\`.