org.tensorflow.op.math

Class Cumsum<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.math.Cumsum<T>

Type Parameters:

T - data type for out() output

All Implemented Interfaces:

Op, Operand<T>

@Operator(group="math")
public final class Cumsum<T>
extends PrimitiveOp
implements Operand<T>

Compute the cumulative sum of the tensor `x` along `axis`.

By default, this op performs an inclusive cumsum, which means that the first element of the input is identical to the first element of the output:

 tf.cumsum([a, b, c])  # => [a, a + b, a + b + c]
 

By setting the `exclusive` kwarg to `True`, an exclusive cumsum is performed instead:

 tf.cumsum([a, b, c], exclusive=True)  # => [0, a, a + b]
 

By setting the `reverse` kwarg to `True`, the cumsum is performed in the opposite direction:

 tf.cumsum([a, b, c], reverse=True)  # => [a + b + c, b + c, c]
 

This is more efficient than using separate `tf.reverse` ops.

The `reverse` and `exclusive` kwargs can also be combined:

 tf.cumsum([a, b, c], exclusive=True, reverse=True)  # => [b + c, c, 0]
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cumsum.Options Optional attributes for Cumsum

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T,U extends Number> Cumsum<T>	create(Scope scope, Operand<T> x, Operand<U> axis, Cumsum.Options... options) Factory method to create a class wrapping a new Cumsum operation.
static Cumsum.Options	exclusive(Boolean exclusive)
Output<T>	out()
static Cumsum.Options	reverse(Boolean reverse)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T,U extends Number> Cumsum<T> create(Scope scope,
                                                    Operand<T> x,
                                                    Operand<U> axis,
                                                    Cumsum.Options... options)

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

Parameters:

scope - current scope

x - A `Tensor`. Must be one of the following types: `float32`, `float64`, `int64`, `int32`, `uint8`, `uint16`, `int16`, `int8`, `complex64`, `complex128`, `qint8`, `quint8`, `qint32`, `half`.

axis - A `Tensor` of type `int32` (default: 0). Must be in the range `[-rank(x), rank(x))`.

options - carries optional attributes values

Returns:

a new instance of Cumsum

exclusive

public static Cumsum.Options exclusive(Boolean exclusive)

Parameters:

exclusive - If `True`, perform exclusive cumsum.

reverse

public static Cumsum.Options reverse(Boolean reverse)

Parameters:

reverse - A `bool` (default: False).

out

public Output<T> out()

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

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.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)