# CumulativeLogsumexp

public final class **CumulativeLogsumexp** Compute the cumulative product of the tensor \`x\` along \`axis\`.


By default, this op performs an inclusive cumulative log-sum-exp,
which means that the first
element of the input is identical to the first element of the output:

    tf.math.cumulative_logsumexp([a, b, c])  # =&gt; [a, log(exp(a) + exp(b)), log(exp(a) + exp(b) + exp(c))]
     
By setting the \`exclusive\` kwarg to \`True\`, an exclusive cumulative log-sum-exp is performed instead:

    tf.cumulative_logsumexp([a, b, c], exclusive=True)  # =&gt; [-inf, a, log(exp(a) * exp(b))]
     
Note that the neutral element of the log-sum-exp operation is \`-inf\`, however, for performance reasons, the minimal value representable by the floating point type is used instead.


By setting the \`reverse\` kwarg to \`True\`, the cumulative log-sum-exp is performed in the
opposite direction.

<br />

<br />

### Nested Classes

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

### 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/CumulativeLogsumexp#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T extends Number, U extends Number\> [CumulativeLogsumexp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20org.tensorflow.op.core.CumulativeLogsumexp.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\> x, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> axis, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp.Options) options) Factory method to create a class wrapping a new CumulativeLogsumexp operation. |
| static [CumulativeLogsumexp.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp.Options) | [exclusive](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp#exclusive(java.lang.Boolean))(Boolean exclusive) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [out](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp#out())() |
| static [CumulativeLogsumexp.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp.Options) | [reverse](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp#reverse(java.lang.Boolean))(Boolean reverse) |

### 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 [CumulativeLogsumexp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp)\<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\> x, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> axis, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CumulativeLogsumexp.Options) options)

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

##### Parameters

| scope | current scope |
| x | A \`Tensor\`. Must be one of the following types: \`float16\`, \`float32\`, \`float64\`. |
| 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 CumulativeLogsumexp

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

<br />

##### Parameters

| exclusive | If \`True\`, perform exclusive cumulative log-sum-exp. |
|---|---|

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

<br />

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

<br />

##### Parameters

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