sparse_matrix_trace_float(_:_:)

Declaration

func sparse_matrix_trace_float(_ A: sparse_matrix_float!, _ offset: sparse_index) -> Float

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(_:_:_:_:_:_:_:)
• sparse_matrix_vector_product_dense_float(_:_:_:_:_:_:_:)
• sparse_vector_triangular_solve_dense_double(_:_:_:_:_:)
• sparse_vector_triangular_solve_dense_float(_:_:_:_:_:)
• sparse_outer_product_dense_double(_:_:_:_:_:_:_:_:_:)
• sparse_outer_product_dense_float(_:_:_:_:_:_:_:_:_:)
• sparse_permute_rows_double(_:_:)
• sparse_permute_rows_float(_:_:)
• sparse_permute_cols_double(_:_:)
• sparse_permute_cols_float(_:_:)
• sparse_elementwise_norm_double(_:_:)
• sparse_elementwise_norm_float(_:_:)
• sparse_operator_norm_double(_:_:)
• sparse_operator_norm_float(_:_:)
• sparse_matrix_trace_double(_:_:)