# TridiagonalSolve

public final class **TridiagonalSolve** Solves tridiagonal systems of equations.


Solves tridiagonal systems of equations.
Supports batch dimensions and multiple right-hand sides per each left-hand
side.
On CPU, solution is computed via Gaussian elimination with or without partial
pivoting, depending on \`partial_pivoting\` attribute. On GPU, Nvidia's cuSPARSE
library is used: https://docs.nvidia.com/cuda/cusparse/index.html#gtsv
Partial pivoting is not yet supported by XLA backends.

<br />

### Nested Classes

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

### 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/TridiagonalSolve#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T\> [TridiagonalSolve](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.op.core.TridiagonalSolve.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\> diagonals, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> rhs, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve.Options) options) Factory method to create a class wrapping a new TridiagonalSolve operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve#output())() Tensor of shape \`\[..., M, K\]\` containing the solutions |
| static [TridiagonalSolve.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve.Options) | [partialPivoting](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve#partialPivoting(java.lang.Boolean))(Boolean partialPivoting) |
| static [TridiagonalSolve.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve.Options) | [perturbSingular](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve#perturbSingular(java.lang.Boolean))(Boolean perturbSingular) |

### 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 [TridiagonalSolve](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve)\<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\> diagonals, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> rhs, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/TridiagonalSolve.Options) options)

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

##### Parameters

| scope | current scope |
| diagonals | Tensor of shape \`\[..., 3, M\]\` whose innermost 2 dimensions represent the tridiagonal matrices with three rows being the superdiagonal, diagonals, and subdiagonals, in order. The last element of the superdiagonal and the first element of the subdiagonal is ignored. |
| rhs | Tensor of shape \`\[..., M, K\]\`, representing K right-hand sides per each left-hand side. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of TridiagonalSolve

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

Tensor of shape \`\[..., M, K\]\` containing the solutions

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

<br />

##### Parameters

| partialPivoting | Whether to apply partial pivoting. Partial pivoting makes the procedure more stable, but slower. |
|---|---|

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

<br />