# SparseMatrixOrderingAMD

public final class **SparseMatrixOrderingAMD** Computes the Approximate Minimum Degree (AMD) ordering of \`input\`.


Computes the Approximate Minimum Degree (AMD) ordering for a sparse matrix.


The returned permutation may be used to permute the rows and columns of the
given sparse matrix. This typically results in permuted sparse matrix's sparse
Cholesky (or other decompositions) in having fewer zero fill-in compared to
decomposition of the original matrix.


The input sparse matrix may have rank 2 or rank 3. The output Tensor,
representing would then have rank 1 or 2 respectively, with the same batch
shape as the input.


Each component of the input sparse matrix must represent a square symmetric
matrix; only the lower triangular part of the matrix is read. The values of the
sparse matrix does not affect the returned permutation, only the sparsity
pattern of the sparse matrix is used. Hence, a single AMD ordering may be
reused for the Cholesky decompositions of sparse matrices with the same sparsity
pattern but with possibly different values.


Each batch component of the output permutation represents a permutation of \`N\`
elements, where the input sparse matrix components each have \`N\` rows. That is,
the component contains each of the integers \`{0, .. N-1}\` exactly once. The
\`i\`th element represents the row index that the \`i\`th row maps to.


Usage example:

    from tensorflow.python.ops.linalg.sparse import sparse_csr_matrix_ops
     
         a_indices = np.array([[0, 0], [1, 1], [2, 1], [2, 2], [3, 3]])
         a_values = np.array([1.0, 2.0, 1.0, 3.0, 4.0], np.float32)
         a_dense_shape = [4, 4]
     
         with tf.Session() as sess:
           # Define (COO format) SparseTensor over Numpy array.
           a_st = tf.sparse.SparseTensor(a_indices, a_values, a_dense_shape)
     
           # Convert SparseTensors to CSR SparseMatrix.
           a_sm = sparse_csr_matrix_ops.sparse_tensor_to_csr_sparse_matrix(
               a_st.indices, a_st.values, a_st.dense_shape)
     
           # Obtain the AMD Ordering for the CSR SparseMatrix.
           ordering_amd = sparse_csr_matrix_ops.sparse_matrix_ordering_amd(sparse_matrix)
     
           ordering_amd_value = sess.run(ordering_amd)
     
\`ordering_amd_value\` stores the AMD ordering: \`\[1 2 3 0\]\`.


input: A \`CSRSparseMatrix\`.

<br />

<br />

<br />

<br />

<br />

<br />

<br />

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SparseMatrixOrderingAMD#asOutput())() Returns the symbolic handle of a tensor. |
| static [SparseMatrixOrderingAMD](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SparseMatrixOrderingAMD) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SparseMatrixOrderingAMD#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<?>))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> input) Factory method to create a class wrapping a new SparseMatrixOrderingAMD operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SparseMatrixOrderingAMD#output())() The Approximate Minimum Degree (AMD) ordering of \`input\`. |

### 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)\<Integer\> | [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)\<Integer\>
**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 [SparseMatrixOrderingAMD](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SparseMatrixOrderingAMD)
**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)\<?\> input)

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

##### Parameters

| scope | current scope |
| input | A \`CSRSparseMatrix\`. |
|---|---|

##### Returns

- a new instance of SparseMatrixOrderingAMD

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

The Approximate Minimum Degree (AMD) ordering of \`input\`.