Function

sparse_insert_row_double(_:_:_:_:_:)

Inserts a list of scalar entries into a single row of a double-precision sparse matrix.

Declaration

func sparse_insert_row_double(_ A: sparse_matrix_double!, _ i: sparse_index, _ nz: sparse_dimension, _ val: UnsafePointer<Double>!, _ jndx: UnsafePointer<sparse_index>!) -> sparse_status

Parameters

A

The sparse matrix, A, which must have been created with sparse_matrix_create_double(_:_:). SPARSE_ILLEGAL_PARAMETER is returned if not met.

i

The row for value insertion. Indices expected to be in the bounds of matrix dimensions, undefined behavior if not met.

nz

The number of values to insert into A. Each of indx and val are of size nz.

val

Pointer to list of scalar values to insert into the sparse matrix. The value is inserted into the location specified by the corresponding indices of indx and j. Must hold nz values.

indx

An array of column indices that correspond to the values in val. Must hold nz values.

Return Value

On successful insertion, A has been updated with the value and SPARSE_SUCCESS is returned. If A creation requirements are not met, SPARSE_ILLEGAL_PARAMETER is returned and A is unchanged.

Discussion

Use to build a sparse matrix by providing a list of point entries for a single column. For each entry provided, update A[i,jndx[i]] = val[i]. This will not replace the existing contents of the column, it appends new values and overwrites overlapping values.

Note that matrix properties cannot be modified after value insertion begins. This includes properties such as specifying a triangular matrix.

Insertion can be expensive, generally speaking it is best to do a batch update. Inserted values may be temporarily held internally within the object and only inserted into the sparse format when a later computation triggers a need to insert.

Indices in indx are always assumed to be stored in ascending order. Additionally, indices are assumed to be unique. Finally, indices are assumed to be in the bounds of the matrix. Undefined behavior if any of these assumptions are not met.All indices are 0 based (the first element of a pointer is ptr[0]).

See Also

Matrix Creation and Population