SparseBooleanMatrix

A sparse matrix for storing booleans. It works just like SparseMatrix but optimizes boolean storage. This particular interface only provides read access. The matrix needs to be initialized appropriately or used on a class that is actually mutable.

Inheritors

Types

Link copied to clipboard
object Companion : ImmutableSparseMatrixCompanion<Boolean>

The companion object contains factory functions to create new instances with initialization.

Properties

Link copied to clipboard

Get an iterable with all valid indices in the matrix

Link copied to clipboard
abstract val maxHeight: Int

The maximum x coordinate that is valid

Link copied to clipboard
abstract val maxWidth: Int

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

Link copied to clipboard
abstract val validator: (Int, Int) -> Boolean

For copying allow retrieving the/a validator function

Functions

Link copied to clipboard

Get all elements in the matrix as sequence.

Link copied to clipboard
open fun contentEquals(other: SparseMatrix<*>): Boolean

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.

Link copied to clipboard
abstract override fun copyOf(): SparseBooleanMatrix

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

Link copied to clipboard
open fun forEach(p0: Consumer<in Boolean>)
Link copied to clipboard
inline fun <T> SparseMatrix<T>.forEach(action: (T) -> Unit)

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

Link copied to clipboard
inline fun SparseMatrix<*>.forEachIndex(action: (Int, Int) -> Unit)

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

Link copied to clipboard
open operator fun get(pos: Coordinate): Boolean
abstract operator fun get(x: Int, y: Int): Boolean

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

Link copied to clipboard
open fun isValid(pos: Coordinate): Boolean
open fun isValid(x: Int, y: Int): Boolean

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]).

Link copied to clipboard
open operator override fun iterator(): Iterator<Boolean>

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

Link copied to clipboard
inline fun <T, R> SparseMatrix<T>.map(transform: (T) -> R): SparseMatrix<R>

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

Link copied to clipboard
inline fun <T> SparseMatrix<T>.mapBoolean(transform: (T) -> Boolean): SparseBooleanMatrix

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

Link copied to clipboard
inline fun <T> SparseMatrix<T>.mapInt(transform: (T) -> Int): SparseIntMatrix

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.

Link copied to clipboard