org.tensorflow.op.core

Class MatrixSquareRoot<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.MatrixSquareRoot<T>

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

@Operator
public final class MatrixSquareRoot<T>
extends PrimitiveOp
implements Operand<T>

Computes the matrix square root of one or more square matrices:

matmul(sqrtm(A), sqrtm(A)) = A

The input matrix should be invertible. If the input matrix is real, it should have no eigenvalues which are real and negative (pairs of complex conjugate eigenvalues are allowed).

The matrix square root is computed by first reducing the matrix to quasi-triangular form with the real Schur decomposition. The square root of the quasi-triangular matrix is then computed directly. Details of the algorithm can be found in: Nicholas J. Higham, "Computing real square roots of a real matrix", Linear Algebra Appl., 1987.

The input is a tensor of shape `[..., M, M]` whose inner-most 2 dimensions form square matrices. The output is a tensor of the same shape as the input containing the matrix square root for all input submatrices `[..., :, :]`.

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T> MatrixSquareRoot<T>	create(Scope scope, Operand<T> input) Factory method to create a class to wrap a new MatrixSquareRoot operation to the graph.
Output<T>	output() Shape is `[..., M, M]`.

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T> MatrixSquareRoot<T> create(Scope scope,
                                             Operand<T> input)

Factory method to create a class to wrap a new MatrixSquareRoot operation to the graph.

Parameters:

scope - current graph scope

input - Shape is `[..., M, M]`.

Returns:

a new instance of MatrixSquareRoot

output

public Output<T> output()

Shape is `[..., M, M]`.

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

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.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)