# tensorflow::ops::ScatterNdSub Class Reference

# tensorflow::
ops::
ScatterNdSub

`
#include <state_ops.h>
`


Applies sparse subtraction to individual values or slices in a
[Variable](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/variable#classtensorflow_1_1ops_1_1_variable)
.

## Summary


within a given variable according to
`
indices
`
.


`
ref
`
is a
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor
`
with rank
`
P
`
and
`
indices
`
is a
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor
`
of rank
`
Q
`
.


`
indices
`
must be integer tensor, containing indices into
`
ref
`
. It must be shape
`
[d_0, ..., d_{Q-2}, K]
`
where
`
0 < K <= P
`
.


The innermost dimension of
`
indices
`
(with length
`
K
`
) corresponds to indices into elements (if
`
K = P
`
) or slices (if
`
K < P
`
) along the
`
K
`
th dimension of
`
ref
`
.


`
updates
`
is
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor
`
of rank
`
Q-1+P-K
`
with shape:


```
[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]]
```

<br />


For example, say we want to subtract 4 scattered elements from a rank-1 tensor with 8 elements. In Python, that subtraction would look like this:


```
ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1], [7]])
updates = tf.constant([9, 10, 11, 12])
sub = tf.scatter_nd_sub(ref, indices, updates)
with tf.Session() as sess:
  print sess.run(sub)
```

<br />


The resulting update to ref would look like this:

```
[1, -9, 3, -6, -4, 6, 7, -4]
```

<br />


See
`
tf.scatter_nd
`
for more details about how to make updates to slices.


Args:

- scope: A [Scope](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object
- ref: A mutable [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor) . Should be from a [Variable](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/variable#classtensorflow_1_1ops_1_1_variable) node.
- indices: A [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor) . Must be one of the following types: int32, int64. A tensor of indices into ref.
- updates: A [Tensor](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/tensor#classtensorflow_1_1_tensor) . Must have the same type as ref. A tensor of updated values to subtract from ref.

<br />


Optional attributes (see
`
https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/scatter-nd-sub/attrs#structtensorflow_1_1ops_1_1_scatter_nd_sub_1_1_attrs
`
):

- use_locking: An optional bool. Defaults to True. If True, the assignment will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

<br />


Returns:

- `
  https://www.tensorflow.org/versions/r2.5/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.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1ae406028cdb445b008dc38cb063867d92 (const :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates) ` ||
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1a6095e143f12d98bdd6840e3c82b0849e (const :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope & scope, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input ref, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input indices, :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input updates, const https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/scatter-nd-sub/attrs#structtensorflow_1_1ops_1_1_scatter_nd_sub_1_1_attrs & attrs) ` ||

| ### Public attributes ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1a3ce12481ccf50ae215315bae8f9ebaa6 ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1a2b35fc093c9c33c9fb2117ce2d348f1e ` | ` :: https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output ` |

| ### Public functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1a395194967a9288f615ec9e74e220043a () const ` | ` ::tensorflow::Node * ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1ad87ae02563483cc2d919170789fbf278 () const ` | ` ` |
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1ae3ae0bc213eec019e7ab8a5fe78171df () const ` | ` ` |

| ### Public static functions ||
|---|---|
| ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub_1a0378357edf53a55d9d8bcd4f18730266 (bool x) ` | ` https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/scatter-nd-sub/attrs#structtensorflow_1_1ops_1_1_scatter_nd_sub_1_1_attrs ` |

| ### Structs ||
|---|---|
| [tensorflow:: ops:: ScatterNdSub:: Attrs](https://www.tensorflow.org/versions/r2.5/api_docs/cc/struct/tensorflow/ops/scatter-nd-sub/attrs) | Optional attribute setters for [ScatterNdSub](https://www.tensorflow.org/versions/r2.5/api_docs/cc/class/tensorflow/ops/scatter-nd-sub#classtensorflow_1_1ops_1_1_scatter_nd_sub) . |

## Public attributes

### operation

```
Operation operation
```

### output_ref

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

## Public functions

### ScatterNdSub

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

### ScatterNdSub

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