Package org.ejml.masks

Class DMaskSparse

java.lang.Object

org.ejml.masks.Mask

org.ejml.masks.DMaskSparse

public class DMaskSparse
extends Mask

Mask implementation backed by a matrix in CSC format

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DMaskSparse.Builder	Utility class to build DMaskSparse

Field Summary

Fields

Modifier and Type	Field	Description
protected final DMatrixSparseCSC	matrix
final double	zeroElement	Value representing that the entry is not set in the mask

Fields inherited from class org.ejml.masks.Mask

negated

Constructor Summary

Constructors

Constructor	Description
DMaskSparse(DMatrixSparseCSC matrix, boolean negated, double zeroElement, @Nullable IGrowArray gw, boolean indexFirstColumn)

Method Summary

Modifier and Type	Method	Description
int	getNumCols()
int	getNumRows()
boolean	isSet(int idx)
boolean	isSet(int row, int col)
int	maxMaskedEntries()	Pessimistic estimation of entries set in the mask
void	setIndexColumn(int col)	For faster access on a specific column (on at a time) ! Only useful for sparse masks

Methods inherited from class org.ejml.masks.Mask

compatible, print

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

matrix

protected final DMatrixSparseCSC matrix

zeroElement

public final double zeroElement

Value representing that the entry is not set in the mask

Constructor Details

DMaskSparse

public DMaskSparse(DMatrixSparseCSC matrix,
 boolean negated,
 double zeroElement,
 @Nullable
 @Nullable IGrowArray gw,
 boolean indexFirstColumn)

Method Details

isSet

public boolean isSet(int row,
 int col)

Specified by:

isSet in class Mask

Returns:

Whether the matrix entry is set in the mask

isSet

public boolean isSet(int idx)

Specified by:

isSet in class Mask

Returns:

Whether the vector entry is set in the mask

getNumCols

public int getNumCols()

Specified by:

getNumCols in class Mask

Returns:

The number of columns of the wrapped matrix

getNumRows

public int getNumRows()

Specified by:

getNumRows in class Mask

Returns:

The number of rows of the wrapped matrix

setIndexColumn

public void setIndexColumn(int col)

Description copied from class: Mask

For faster access on a specific column (on at a time) ! Only useful for sparse masks

Specified by:

setIndexColumn in class Mask

Parameters:

col - column to index

maxMaskedEntries

public int maxMaskedEntries()

Description copied from class: Mask

Pessimistic estimation of entries set in the mask

Specified by:

maxMaskedEntries in class Mask

Returns:

Maximum number of set entries in mask