# ScatterNdSub

public final class **ScatterNdSub** Applies sparse subtraction to individual values or slices in a Variable.


within a given variable according to \`indices\`.


\`ref\` is a \`Tensor\` with rank \`P\` and \`indices\` is a \`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 \`Tensor\` of rank \`Q-1+P-K\` with shape:

    [d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]]
     
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)
     
The resulting update to ref would look like this:


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


See [`tf.scatter_nd`](https://www.tensorflow.org/api_docs/python/tf/scatter_nd) for more details about how to make updates to
slices.

<br />

<br />

<br />

<br />

<br />

<br />

<br />

### Nested Classes

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

### 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/ScatterNdSub#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T, U extends Number\> [ScatterNdSub](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.ScatterNdSub.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/ScatterNdSub.Options) options) Factory method to create a class wrapping a new ScatterNdSub 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/ScatterNdSub#outputRef())() Same as ref. |
| static [ScatterNdSub.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub.Options) | [useLocking](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub#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 [ScatterNdSub](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub)\<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/ScatterNdSub.Options) options)

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

##### Parameters

| scope | current scope |
| ref | A mutable Tensor. Should be from a Variable node. |
| indices | A Tensor. Must be one of the following types: int32, int64. A tensor of indices into ref. |
| updates | A Tensor. Must have the same type as ref. A tensor of updated values to subtract from ref. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of ScatterNdSub

#### 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 [ScatterNdSub.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/ScatterNdSub.Options)
**useLocking**
(Boolean useLocking)

<br />

##### Parameters

| useLocking | 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. |
|---|---|