# tensorflow::ops::ScatterAdd Class Reference

# tensorflow::ops::ScatterAdd

`#include <state_ops.h>`

Adds sparse updates to a variable reference.

## Summary

This operation computes

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

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

# 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 contributions add.

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 add to `ref`.

<br />

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

- use_locking: If True, the addition 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-add#classtensorflow_1_1ops_1_1_scatter_add_1aebad5eb3382d85a98694a67516fb31be(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-add#classtensorflow_1_1ops_1_1_scatter_add_1a784b3e2e01f007a9c99a4bed4d2a52a7(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-add/attrs#structtensorflow_1_1ops_1_1_scatter_add_1_1_attrs & attrs)` ||

| ### Public attributes ||
|---|---|
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-add#classtensorflow_1_1ops_1_1_scatter_add_1a3f10d947b38ba138d7b4b3841a6f86e9` | `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-add#classtensorflow_1_1ops_1_1_scatter_add_1a10b0695ddf8f2320ea456a07d4d203b6` | `::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-add#classtensorflow_1_1ops_1_1_scatter_add_1a1dc28df0910552341f7da76eee369656() const ` | `::tensorflow::Node *` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-add#classtensorflow_1_1ops_1_1_scatter_add_1a038d19ab294d54a525dd26c1f4c6a44c() const ` | ` `` ` |
| `https://www.tensorflow.org/versions/r2.3/api_docs/cc/class/tensorflow/ops/scatter-add#classtensorflow_1_1ops_1_1_scatter_add_1af3d320c18d631efb10dafef8fc14483e() const ` | ` `` ` |

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

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

## Public attributes

### operation

```
Operation operation
```

### output_ref

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

## Public functions

### ScatterAdd

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

### ScatterAdd

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