# LSTMBlockCell

public final class **LSTMBlockCell** Computes the LSTM cell forward propagation for 1 time step.


This implementation uses 1 weight matrix and 1 bias vector, and there's an
optional peephole connection.


This kernel op implements the following mathematical equations:

    xh = [x, h_prev]
     [i, f, ci, o] = xh * w + b
     f = f + forget_bias
     
     if not use_peephole:
       wci = wcf = wco = 0
     
     i = sigmoid(cs_prev * wci + i)
     f = sigmoid(cs_prev * wcf + f)
     ci = tanh(ci)
     
     cs = ci .* i + cs_prev .* f
     cs = clip(cs, cell_clip)
     
     o = sigmoid(cs * wco + o)
     co = tanh(cs)
     h = co .* o
     
<br />

<br />

<br />

### Nested Classes

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

### Public Methods

|---|---|
| static [LSTMBlockCell.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options) | [cellClip](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#cellClip(java.lang.Float))(Float cellClip) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [ci](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#ci())() The cell input. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [co](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#co())() The cell after the tanh. |
| static \<T extends Number\> [LSTMBlockCell](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.LSTMBlockCell.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)\<T\> csPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> w, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wcf, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wco, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> b, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options) options) Factory method to create a class wrapping a new LSTMBlockCell operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [cs](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#cs())() The cell state before the tanh. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [f](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#f())() The forget gate. |
| static [LSTMBlockCell.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options) | [forgetBias](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#forgetBias(java.lang.Float))(Float forgetBias) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [h](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#h())() The output h vector. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [i](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#i())() The input gate. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [o](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#o())() The output gate. |
| static [LSTMBlockCell.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options) | [usePeephole](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell#usePeephole(java.lang.Boolean))(Boolean usePeephole) |

### 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() |

## Public Methods

#### public static [LSTMBlockCell.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options)
**cellClip**
(Float cellClip)

<br />

##### Parameters

| cellClip | Value to clip the 'cs' value to. |
|---|---|

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

The cell input.

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

The cell after the tanh.

#### public static [LSTMBlockCell](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell)\<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)\<T\> csPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> w, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wcf, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wco, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> b, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options) options)

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

##### Parameters

| scope | current scope |
| x | The input to the LSTM cell, shape (batch_size, num_inputs). |
| csPrev | Value of the cell state at previous time step. |
| hPrev | Output of the previous cell at previous time step. |
| w | The weight matrix. |
| wci | The weight matrix for input gate peephole connection. |
| wcf | The weight matrix for forget gate peephole connection. |
| wco | The weight matrix for output gate peephole connection. |
| b | The bias vector. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of LSTMBlockCell

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

The cell state before the tanh.

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

The forget gate.

#### public static [LSTMBlockCell.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/LSTMBlockCell.Options)
**forgetBias**
(Float forgetBias)

<br />

##### Parameters

| forgetBias | The forget gate bias. |
|---|---|

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

The output h vector.

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

The input gate.

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

The output gate.

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

<br />

##### Parameters

| usePeephole | Whether to use peephole weights. |
|---|---|