SparseMatrix

The companion object contains factory functions to create new instances. There is no guarantee as to the specific type returned for the interface (but always an instance of SparseMatrix).

This class provides access to a single function initialising a sparse matrix by returing either a value, or marking it sparse. It is used as receiver of the lambda, that is expected to return the result of either invoking value or sparse.

Get an iterable with all valid indices in the matrix

The maximum x coordinate that is valid

The maximum x coordinate that is valid which can be stored.

For copying allow retrieving the/a validator function

Get all elements in the matrix as sequence.

Determine whether the content of this matrix is the same as the other by checking equality on the cell values. Sparse matrices with different dimensions, but the same valid indices can be equal.

Creates a copy of the matrix of an appropriate type with the same content.

Perform the action for each value in the (sparse) matrix.

Perform the action for each index in the (sparse) matrix. This skips sparse indices.

Whatever the actual type, allow them to be read to read any value. Implementations are expected to use more precise return types.

This function can be used to determine whether the given coordinates are valid. Returns true if valid. This function works on any value for the coordinates and should return false for all values out of range (x<0 || x>=[maxWidth]), (y<0 || y>=[maxHeight]).

Get an iterator over all elements in the (sparse) matrix.

A map function that creates a new (sparse) matrix with each cell mapped by transform.

A map implementation that creates a boolean sparse matrix based upon the receiver and the transformation function.

Create a new SparseIntMatrix with the dimensions of the original where the value of each cell is the result of applying the transform to the value of the cell in the original.