Package org.ejml.masks

Class DMaskPrimitive

java.lang.Object

org.ejml.masks.Mask

org.ejml.masks.DMaskPrimitive

public class DMaskPrimitive
extends Mask

Mask implementation backed by a primitive array

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
final int	numCols	Number of columns of the wrapped 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
DMaskPrimitive(double[] values, int numCols, boolean negated, double zeroElement)

Method Summary

Modifier and Type	Method	Description
int	getNumCols()
int	getNumRows()
boolean	isSet(int index)
boolean	isSet(int row, int col)
int	maxMaskedEntries()	Pessimistic estimation of entries set in the mask
void	setIndexColumn(int column)	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

numCols

public final int numCols

Number of columns of the wrapped matrix

zeroElement

public final double zeroElement

Value representing that the entry is not set in the mask

Constructor Details

DMaskPrimitive

public DMaskPrimitive(double[] values,
 int numCols,
 boolean negated,
 double zeroElement)

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

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 column)

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:

column - 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

isSet

public boolean isSet(int index)

Specified by:

isSet in class Mask

Returns:

Whether the vector entry is set in the mask