---
title: "gather(withUpdatesTensor:indicesTensor:axis:batchDimensions:name:)"
framework: metalperformanceshadersgraph
role: symbol
role_heading: Instance Method
path: "metalperformanceshadersgraph/mpsgraph/gather(withupdatestensor:indicestensor:axis:batchdimensions:name:)"
---

# gather(withUpdatesTensor:indicesTensor:axis:batchDimensions:name:)

Creates a Gather operation and returns the result tensor.

## Declaration

```swift
func gather(withUpdatesTensor updatesTensor: MPSGraphTensor, indicesTensor: MPSGraphTensor, axis: Int, batchDimensions: Int, name: String?) -> MPSGraphTensor
```

## Parameters

- `updatesTensor`: Tensor containing slices to be inserted into the result tensor.
- `indicesTensor`: Tensor containg the updates indices to read slices from
- `axis`: The dimension on which to perform the gather
- `batchDimensions`: The number of batch dimensions
- `name`: The name for the operation.

## Return Value

Return Value A valid MPSGraphTensor object

## Discussion

Discussion Gathers the values in updatesTensor to the result tensor along the indices in indicesTensor. The gather is defined as B = batchDims  U = updates.rank  P = res.rank  Q = inds.rank  res[p_{0},...p_{axis-1}, i_{B},...,i_{Q}, ...,p_{axis+1},...,p{U-1}] =  updates[p_{0},...p_{axis-1}, indices[p_{0},...,p_{B-1},i_{B},...,i_{Q}, ...,p_{axis+1},...,p{U-1}]  The tensors have the following shape requirements P = Q-B + U-1  indices.shape[0:B] = updates.shape[0:B] = res.shape[0:B]  res.shape[0:axis] = updates.shape[0:axis]  res.shape[axis:axis+Q-B] = indices.shape[B:]  res.shape[axis+1+Q-B:] = updates.shape[axis+1:]