# tensorflow::ops::ScatterMin Class Reference

# tensorflow::ops::ScatterMin

`#include <state_ops.h>`

Reduces sparse updates into a variable reference using the `min` operation.

## Summary

This operation computes

```
# Scalar indices
ref[indices, ...] = min(ref[indices, ...], updates[...])

# Vector indices (for each i)
ref[indices[i], ...] = min(ref[indices[i], ...], updates[i, ...])

# High rank indices (for each i, ..., j)
ref[indices[i, ..., j], ...] = min(ref[indices[i, ..., j], ...], updates[i, ..., j, ...])
```

<br />

This operation outputs `ref` after the update is done. This makes it easier to chain operations that need to use the reset value.

Duplicate entries are handled correctly: if multiple `indices` reference the same location, their contributions combine.

Requires `updates.shape = indices.shape + ref.shape[1:]` or `updates.shape = []`.


![](https://www.tensorflow.org/static/versions/r2.3/api_docs/cc/images/ScatterAdd.png)

<br />

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- ref: Should be from a `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/variable#classtensorflow_1_1ops_1_1_variable` node.
- indices: A tensor of indices into the first dimension of `ref`.
- updates: A tensor of updated values to reduce into `ref`.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/scatter-min/attrs#structtensorflow_1_1ops_1_1_scatter_min_1_1_attrs`):

- use_locking: If True, the update will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

<br />

Returns:

- `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output`: = Same as `ref`. Returned as a convenience for operations that want to use the updated values after the update is done.

<br />

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a20672036c077b2295fe3b7f263f1cbbc(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates)` ||
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a970f0ae60aca198d4ff561223d356190(const ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates, const https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/scatter-min/attrs#structtensorflow_1_1ops_1_1_scatter_min_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a6b8f4f0a291a0a5110af72304126dfda` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a246255cec7f7a96a7aaec14b4b44b6b7` | `::https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1ad2e63dcee002a733c8a1c255be7b2683() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a8938d32752649aeaeba42f68891ababc() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1af6605bb1184a6c918a33ba5d6389874b() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min_1a81d4614aac5d7b4ec68e2513034b2970(bool x)` | `https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/scatter-min/attrs#structtensorflow_1_1ops_1_1_scatter_min_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ScatterMin::Attrs](https://www.tensorflow.org/versions/r2.3/api_docs/cc/struct/tensorflow/ops/scatter-min/attrs) | Optional attribute setters for [ScatterMin](https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-min#classtensorflow_1_1ops_1_1_scatter_min). |

## Public attributes

### operation

```
Operation operation
```

### output_ref

```
::tensorflow::Output output_ref
```

## Public functions

### ScatterMin

```
 ScatterMin(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input ref,
  ::tensorflow::Input indices,
  ::tensorflow::Input updates
)
```

### ScatterMin

```
 ScatterMin(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input ref,
  ::tensorflow::Input indices,
  ::tensorflow::Input updates,
  const ScatterMin::Attrs & attrs
)
```

### node

```
::tensorflow::Node * node() const 
```

### operator::tensorflow::Input

```
 operator::tensorflow::Input() const 
```

### operator::tensorflow::Output

```
 operator::tensorflow::Output() const 
```

## Public static functions

### UseLocking

```
Attrs UseLocking(
  bool x
)
```