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.

Nested Classes

class

TridiagonalSolve.Options

Optional attributes for TridiagonalSolve

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> TridiagonalSolve<T>	create(Scope scope, Operand<T> diagonals, Operand<T> rhs, Options... options) Factory method to create a class wrapping a new TridiagonalSolve operation.
Output<T>	output() Tensor of shape `[..., M, K]` containing the solutions
static TridiagonalSolve.Options	partialPivoting(Boolean partialPivoting)

Inherited Methods

From class org.tensorflow.op.RawOp

final boolean	equals(Object obj)
final int	hashCode()
Operation	op() Return this unit of computation as a single Operation.
final String	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.op.Op

abstract ExecutionEnvironment	env() Return the execution environment this op was created in.
abstract Operation	op() Return this unit of computation as a single Operation.

From interface org.tensorflow.Operand

abstract Output<T>	asOutput() Returns the symbolic handle of the tensor.
abstract T	asTensor() Returns the tensor at this operand.
abstract Shape	shape() Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
abstract Class<T>	type() Returns the tensor type of this operand

From interface org.tensorflow.ndarray.Shaped

abstract int	rank()
abstract Shape	shape()
abstract long	size() Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

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

Constant Value: "TridiagonalSolve"

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 TridiagonalSolve<T> create (Scope scope, Operand<T> diagonals, Operand<T> rhs, 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<T> output ()

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

public static TridiagonalSolve.Options partialPivoting (Boolean partialPivoting)

Parameters

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