Function

sparse_matrix_trace_float

Computes the sum along the specified diagonal of the single-precision sparse matrix A.

Declaration

float sparse_matrix_trace_float(sparse_matrix_float A, sparse_index offset);

Parameters

A

The sparse matrix, A.

offset

Specifies the diagonal to sum.

Return Value

The computed trace.

Discussion

The diagonal is specified by the offset parameter where zero is the main diagonal, values greater than one refer to diagonals above the main diagonal (A[i,i+offset]), and values less than one refer to diagonals below the main diagonal (A[i-offset, i]).

If offset is out of the bounds of the matrix A, 0 is returned.

See Also

Matrix-Vector Operations

sparse_matrix_vector_product_dense_double

Multiplies the dense vector x by the sparse matrix A and adds the result to the dense vector y, with all operands containing double-precision values.

sparse_matrix_vector_product_dense_float

Multiplies the dense vector x by the sparse matrix A and adds the result to the dense vector y, with all operands containing single-precision values.

sparse_vector_triangular_solve_dense_double

Solves the system of equations x = alpha * T⁻¹ * x for x where x is a dense vector and T is a triangular sparse matrix, with all operands containing double-precision values.

sparse_vector_triangular_solve_dense_float

Solves the system of equations x = alpha * T⁻¹ * x for x where x is a dense vector and T is a triangular sparse matrix, with all operands containing single-precision values.

sparse_outer_product_dense_double

Computes the outer product of the dense vector x and the sparse vector y, with both operands containing double-precision values.

sparse_outer_product_dense_float

Computes the outer product of the dense vector x and the sparse vector y, with both operands containing single-precision values.

sparse_permute_rows_double

Permutes the rows of the double-precision sparse matrix A based on the provided permutation array.

sparse_permute_rows_float

Permutes the rows of the single-precision sparse matrix A based on the provided permutation array.

sparse_permute_cols_double

Permutes the columns of the double-precision sparse matrix A based on the provided permutation array.

sparse_permute_cols_float

Permutes the columns of the single-precision sparse matrix A based on the provided permutation array.

sparse_elementwise_norm_double

Computes the specified element-wise norm of the double-precision sparse matrix A.

sparse_elementwise_norm_float

Computes the specified element-wise norm of the single-precision sparse matrix A.

sparse_operator_norm_double

Computes the specified operator norm of the double-precision sparse matrix A.

sparse_operator_norm_float

Computes the specified operator norm of the single-precision sparse matrix A.

sparse_matrix_trace_double

Computes the sum along the specified diagonal of the double-precision sparse matrix A.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software