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 = []`.

Nested Classes

class ScatterSub.Options Optional attributes for ScatterSub

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<T>	asOutput() Returns the symbolic handle of the tensor.
static <T extends TType> ScatterSub<T>	create(Scope scope, Operand<T> ref, Operand<? extends TNumber> indices, Operand<T> updates, Options... options) Factory method to create a class wrapping a new ScatterSub operation.
Output<T>	outputRef() = Same as `ref`.
static ScatterSub.Options	useLocking(Boolean useLocking)

Inherited Methods

From class org.tensorflow.op.RawOp

final boolean	equals(Object obj)
final int	hashCode()
Operation	op() Return this unit of computation as a single `Operation`.
final String	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.op.Op

abstract ExecutionEnvironment	env() Return the execution environment this op was created in.
abstract Operation	op() Return this unit of computation as a single `Operation`.

From interface org.tensorflow.Operand

abstract Output<T>	asOutput() Returns the symbolic handle of the tensor.
abstract T	asTensor() Returns the tensor at this operand.
abstract Shape	shape() Returns the (possibly partially known) shape of the tensor referred to by the `Output` of this operand.
abstract Class<T>	type() Returns the tensor type of this operand

From interface org.tensorflow.ndarray.Shaped

abstract int	rank()
abstract Shape	shape()
abstract long	size() Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "ScatterSub"

Public Methods

public Output<T> asOutput ()

Returns the symbolic handle of the 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.

public static ScatterSub<T> create (Scope scope, Operand<T> ref, Operand<? extends TNumber> indices, Operand<T> updates, 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<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 useLocking (Boolean useLocking)

Parameters

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