# tensorflow::ops::ScatterSub

`#include <state_ops.h>`

Subtracts sparse updates to a variable reference.

## Summary


```
    # Scalar indices
    ref[indices, ...] -= updates[...]
```

<br />


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

<br />


```
    # High rank indices (for each i, ..., j)
    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 (negated) contributions add.

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


![](https://www.tensorflow.org/static/versions/r1.15/api_docs/cc/images/ScatterSub.png)

<br />

Arguments:

- scope: A [Scope](https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- ref: Should be from a `https://www.tensorflow.org/versions/r1.15/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 subtract from `ref`.

<br />

Optional attributes (see `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/scatter-sub/attrs#structtensorflow_1_1ops_1_1_scatter_sub_1_1_attrs`):

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

<br />

Returns:

- `https://www.tensorflow.org/versions/r1.15/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/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1accaab23798d80024fa163b041b28ae18(const ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates)` ||
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a0d58697c440de66d32011584d4d4af87(const ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, ::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates, const https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/scatter-sub/attrs#structtensorflow_1_1ops_1_1_scatter_sub_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a12da77ac1285712dafa533731f8a25a3` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation` |
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a221096081c7f88c41de070a63a7c6206` | `::https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output` |

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a229e4f7695697fba5ea0443cf57de69c() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a20dec89b2f16e8219e280739f90678f6() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1a5b7275f0d303f4e35e97b6ebe31c1e94() const ` | ` `` ` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub_1aed39a07ee7c54561389ae9de845cb5ee(bool x)` | `https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/scatter-sub/attrs#structtensorflow_1_1ops_1_1_scatter_sub_1_1_attrs` |

| ### Structs ||
|---|---|
| [tensorflow::ops::ScatterSub::Attrs](https://www.tensorflow.org/versions/r1.15/api_docs/cc/struct/tensorflow/ops/scatter-sub/attrs) | Optional attribute setters for [ScatterSub](https://www.tensorflow.org/versions/r1.15/api_docs/cc/class/tensorflow/ops/scatter-sub#classtensorflow_1_1ops_1_1_scatter_sub). |

## Public attributes

### operation

```
Operation operation
```

### output_ref

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

## Public functions

### ScatterSub

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

### ScatterSub

```
 ScatterSub(
  const ::tensorflow::Scope & scope,
  ::tensorflow::Input ref,
  ::tensorflow::Input indices,
  ::tensorflow::Input updates,
  const ScatterSub::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
)
```