Function

sparse_matrix_block_create_float(_:_:_:_:)

Returns a single-precision sparse matrix object that is stored in block-entry format with a fixed block size.

Declaration

func sparse_matrix_block_create_float(_ Mb: sparse_dimension, _ Nb: sparse_dimension, _ k: sparse_dimension, _ l: sparse_dimension) -> sparse_matrix_float!

Parameters

Mb

The number of rows in terms of blocks of the matrix. There are a total of Mb * k rows in the matrix. Must be greater than 0.

Nb

The number of columns in terms of blocks of the matrix. There are a total of Nb * l columns in the matrix. Must be greater than 0.

k

The row dimension of a block in the sparse matrix. Must be greater than 0.

l

The column dimension of a block in the sparse matrix. Must be greater than 0.

Return Value

A matrix object that is ready for receiving entries. If an error occurs, nil is returned.

Discussion

Create a sparse matrix object that is stored in block-entry format and is ready to receive values from the various block insert routines. Blocks are are of fixed dimensions k * l. Block-entry format means blocks of dense regions will be stored at block indices i,j. For point wise format use non block version of create. See the various insert routines for details on inserting values into this matrix object.