# ScatterSub

public final class **ScatterSub** Subtracts sparse updates to a variable reference.


    # 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, ...]
     
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/images/ScatterSub.png)

<br />

<br />

<br />

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [ScatterSub.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub` |

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T, U extends Number\> [ScatterSub](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.ScatterSub.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> ref, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> indices, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> updates, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub.Options) options) Factory method to create a class wrapping a new ScatterSub operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [outputRef](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub#outputRef())() = Same as \`ref\`. |
| static [ScatterSub.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub.Options) | [useLocking](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub#useLocking(java.lang.Boolean))(Boolean useLocking) |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

From interface [org.tensorflow.Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)

|---|---|
| abstract [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |

## Public Methods

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**asOutput**
()

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.

<br />

#### public static [ScatterSub](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub)\<T\>
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> ref, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> indices, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> updates, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub.Options) options)

Factory method to create a class wrapping a new ScatterSub operation.

##### Parameters

| scope | current scope |
| ref | Should be from a \`Variable\` node. |
| indices | A tensor of indices into the first dimension of \`ref\`. |
| updates | A tensor of updated values to subtract from \`ref\`. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of ScatterSub

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**outputRef**
()

= Same as \`ref\`. Returned as a convenience for operations that want
to use the updated values after the update is done.

#### public static [ScatterSub.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterSub.Options)
**useLocking**
(Boolean useLocking)

<br />

##### Parameters

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