Cumprod

public final class Cumprod

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

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

tf.cumprod([a, b, c])  # => [a, a * b, a * b * c]
 
By setting the `exclusive` kwarg to `True`, an exclusive cumprod is performed instead:
tf.cumprod([a, b, c], exclusive=True)  # => [1, a, a * b]
 
By setting the `reverse` kwarg to `True`, the cumprod is performed in the opposite direction:
tf.cumprod([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.cumprod([a, b, c], exclusive=True, reverse=True)  # => [b * c, c, 1]
 

Nested Classes

class Cumprod.Options Optional attributes for Cumprod

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 > Cumprod <T>
create ( Scope scope, Operand <T> x, Operand <? extends TNumber > axis, Options... options)
Factory method to create a class wrapping a new Cumprod operation.
static Cumprod.Options
exclusive (Boolean exclusive)
Output <T>
static Cumprod.Options
reverse (Boolean reverse)

Inherited Methods

Constants

public static final String OP_NAME

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

Constant Value: "Cumprod"

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 Cumprod <T> create ( Scope scope, Operand <T> x, Operand <? extends TNumber > axis, Options... options)

Factory method to create a class wrapping a new Cumprod 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 Cumprod

public static Cumprod.Options exclusive (Boolean exclusive)

Parameters
exclusive If `True`, perform exclusive cumprod.

public Output <T> out ()

public static Cumprod.Options reverse (Boolean reverse)

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