org.dishevelled.matrix

Interface Matrix2D<E>

Type Parameters:

E - type of this 2D matrix

All Superinterfaces:

Iterable<E>

All Known Implementing Classes:

AbstractMatrix2D, SparseMatrix2D

public interface Matrix2D<E>
extends Iterable<E>

Typed fixed size matrix of objects in two dimensions, indexed by longs.

Author:

Michael Heuer

Method Summary

Methods

Modifier and Type	Method and Description
E	aggregate(BinaryFunction<E,E,E> aggr, UnaryFunction<E,E> function) Apply a function to each value in this 2D matrix and aggregate the result.
E	aggregate(Matrix2D<? extends E> other, BinaryFunction<E,E,E> aggr, BinaryFunction<E,E,E> function) Apply a function to each value in this 2D matrix and the specified matrix and aggregate the result.
Matrix2D<E>	assign(E e) Assign all values in this 2D matrix to e (optional operation).
Matrix2D<E>	assign(Matrix2D<? extends E> other) Assign all values in this 2D matrix to the values in the specified matrix (optional operation).
Matrix2D<E>	assign(Matrix2D<? extends E> other, BinaryFunction<E,E,E> function) Assign the result of the specified function of a value from this 2D matrix and the specified matrix to each value in this 2D matrix (optional operation).
Matrix2D<E>	assign(UnaryFunction<E,E> function) Assign the result of the specified function to each value in this 2D matrix (optional operation).
long	cardinality() Return the cardinality of this 2D matrix, the number of non-null values.
void	clear() Clear all the values in this 2D matrix (optional operation).
long	columns() Return the number of columns in this 2D matrix.
void	forEach(TernaryPredicate<Long,Long,? super E> predicate, TernaryProcedure<Long,Long,? super E> procedure) Apply the specified procedures to each row and column and to each value in this 2D matrix accepted by the specified predicate.
void	forEach(TernaryProcedure<Long,Long,? super E> procedure) Apply the specified procedures to each row and column and to each value in this 2D matrix.
void	forEach(UnaryPredicate<? super E> predicate, UnaryProcedure<? super E> procedure) Apply the specified procedure to each value in this 2D matrix accepted by the specified predicate.
void	forEach(UnaryProcedure<? super E> procedure) Apply the specified procedure to each value in this 2D matrix.
void	forEachNonNull(UnaryProcedure<? super E> procedure) Apply the specified procedure to each non-null value in this 2D matrix.
E	get(long row, long column) Return the value at the specified row and column.
E	getQuick(long row, long column) Return the value at the specified row and column without checking bounds.
boolean	isEmpty() Return true if the cardinality of this 2D matrix is zero.
Iterator<E>	iterator() Return an iterator over the values in this 2D matrix, including nulls.
long	rows() Return the number of rows in this 2D matrix.
void	set(long row, long column, E e) Set the value at the specified row and column to e (optional operation).
void	setQuick(long row, long column, E e) Set the value at the specified row and column to e without checking bounds (optional operation).
long	size() Return the size of this 2D matrix.
Matrix1D<E>	viewColumn(long column) Return a new 1D matrix slice view of the specified column.
Matrix2D<E>	viewColumnFlip() Return a new 2D matrix flip view along the column axis.
Matrix2D<E>	viewDice() Return a new 2D matrix dice (transposition) view.
Matrix2D<E>	viewPart(long row, long column, long height, long width) Return a new 2D matrix sub-range view that contains only those values from (row, column) to (row + height - 1, column + width - 1).
Matrix1D<E>	viewRow(long row) Return a new 1D matrix slice view of the specified row.
Matrix2D<E>	viewRowFlip() Return a new 2D matrix flip view along the row axis.
Matrix2D<E>	viewSelection(BitMatrix2D mask) Return a new 2D matrix selection view that contains only those values at the indices present in the specified bit mask.
Matrix2D<E>	viewSelection(long[] rowIndices, long[] columnIndices) Return a new 2D matrix selection view that contains only those values at the specified indices.
Matrix2D<E>	viewSelection(UnaryPredicate<Matrix1D<E>> predicate) Return a new 2D matrix selection view that contains only those rows selected by the specified predicate.
Matrix2D<E>	viewStrides(long rowStride, long columnStride) Return a new 2D matrix stride view which is a sub matrix consisting of every rowStride-th row and every columnStride-th column.

Method Detail

size

long size()

Return the size of this 2D matrix.

Returns:

the size of this 2D matrix

rows

long rows()

Return the number of rows in this 2D matrix.

Returns:

the number of rows in this 2D matrix

columns

long columns()

Return the number of columns in this 2D matrix.

Returns:

the number of columns in this 2D matrix

cardinality

long cardinality()

Return the cardinality of this 2D matrix, the number of non-null values.

Returns:

the cardinality of this 2D matrix

isEmpty

boolean isEmpty()

Return true if the cardinality of this 2D matrix is zero.

Returns:

true if the cardinality of this 2D matrix is zero

clear

void clear()

Clear all the values in this 2D matrix (optional operation).

Throws:

UnsupportedOperationException - if the clear operation is not supported by this 2D matrix

get

E get(long row,
    long column)

Return the value at the specified row and column.

Parameters:

row - row index, must be >= 0 and < rows()

column - column index, must be >= 0 and < columns()

Returns:

the value at the specified row and column

Throws:

IndexOutOfBoundsException - if row or column is negative or if row or column is greater than or equal to rows() or columns(), respectively

getQuick

E getQuick(long row,
         long column)

Return the value at the specified row and column without checking bounds.

Parameters:

row - row index, should be >= 0 and < rows() (unchecked)

column - column index, should be >= 0 and < columns() (unchecked)

Returns:

the value at the specified row and column without checking bounds

set

void set(long row,
       long column,
       E e)

Set the value at the specified row and column to e (optional operation).

Parameters:

row - row index, must be >= 0 and < rows()

column - column index, must be >= 0 and < columns()

e - value

Throws:

IndexOutOfBoundsException - if row or column is negative or if row or column is greater than or equal to rows() or columns(), respectively

UnsupportedOperationException - if the set operation is not supported by this 2D matrix

setQuick

void setQuick(long row,
            long column,
            E e)

Set the value at the specified row and column to e without checking bounds (optional operation).

Parameters:

row - row index, should be >= 0 and < rows() (unchecked)

column - column index, should be >= 0 and < columns() (unchecked)

e - value

Throws:

UnsupportedOperationException - if the setQuick operation is not supported by this 2D matrix

iterator

Iterator<E> iterator()

Return an iterator over the values in this 2D matrix, including nulls.

Specified by:

iterator in interface Iterable<E>

Returns:

an iterator over the values in this 2D matrix, including nulls

assign

Matrix2D<E> assign(E e)

Assign all values in this 2D matrix to e (optional operation).

Parameters:

e - value

Returns:

this 2D matrix, for convenience

Throws:

UnsupportedOperationException - if this assign operation is not supported by this 2D matrix

assign

Matrix2D<E> assign(UnaryFunction<E,E> function)

Assign the result of the specified function to each value in this 2D matrix (optional operation).

Parameters:

function - function, must not be null

Returns:

this 2D matrix, for convenience

Throws:

UnsupportedOperationException - if this assign operation is not supported by this 2D matrix

assign

Matrix2D<E> assign(Matrix2D<? extends E> other)

Assign all values in this 2D matrix to the values in the specified matrix (optional operation).

Parameters:

other - other 2D matrix, must not be null and must have the same dimensions as this 2D matrix

Returns:

this 2D matrix, for convenience

Throws:

UnsupportedOperationException - if this assign operation is not supported by this 2D matrix

assign

Matrix2D<E> assign(Matrix2D<? extends E> other,
                 BinaryFunction<E,E,E> function)

Assign the result of the specified function of a value from this 2D matrix and the specified matrix to each value in this 2D matrix (optional operation).

Parameters:

other - other 2D matrix, must not be null and must have the same dimensions as this 2D matrix

function - function, must not be null

Returns:

this 2D matrix, for convenience

Throws:

UnsupportedOperationException - if this assign operation is not supported by this 2D matrix

aggregate

E aggregate(BinaryFunction<E,E,E> aggr,
          UnaryFunction<E,E> function)

Apply a function to each value in this 2D matrix and aggregate the result.

Parameters:

aggr - aggregate function, must not be null

function - function, must not be null

Returns:

the aggregate result

aggregate

E aggregate(Matrix2D<? extends E> other,
          BinaryFunction<E,E,E> aggr,
          BinaryFunction<E,E,E> function)

Apply a function to each value in this 2D matrix and the specified matrix and aggregate the result.

Parameters:

other - other 2D matrix, must not be null and must have the same dimensions as this 2D matrix

aggr - aggregate function, must not be null

function - function, must not be null

Returns:

the aggregate result

viewRow

Matrix1D<E> viewRow(long row)

Return a new 1D matrix slice view of the specified row. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

row - row index, must be >= 0 and < rows()

Returns:

a new 1D matrix slice view of the specified row

Throws:

IndexOutOfBoundsException - if row is negative or if row is greater than or equal to rows()

viewColumn

Matrix1D<E> viewColumn(long column)

Return a new 1D matrix slice view of the specified column. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

column - column index, must be >= 0 and < columns()

Returns:

a new 1D matrix slice view of the specified column

Throws:

IndexOutOfBoundsException - if column is negative or if column is greater than or equal to columns()

viewDice

Matrix2D<E> viewDice()

Return a new 2D matrix dice (transposition) view. The view has both dimensions exchanged; what used to be columns become rows, what used to be rows become columns. In other words: view.get(row, column) == this.get(column, row). The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Returns:

a new 2D matrix dice (transposition) view

viewRowFlip

Matrix2D<E> viewRowFlip()

Return a new 2D matrix flip view along the row axis. What used to be row 0 is now row rows() - 1, ..., what used to be row rows() - 1 is now row 0. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Returns:

a new 2D matrix flip view along the row axis

viewColumnFlip

Matrix2D<E> viewColumnFlip()

Return a new 2D matrix flip view along the column axis. What used to be column 0 is now column columns() - 1, ..., what used to be column columns() - 1 is now column 0. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Returns:

a new 2D matrix flip view along the column axis

viewPart

Matrix2D<E> viewPart(long row,
                   long column,
                   long height,
                   long width)

Return a new 2D matrix sub-range view that contains only those values from (row, column) to (row + height - 1, column + width - 1). The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

row - row index, must be >= 0 and < rows()

column - column index, must be >= 0 and < columns()

height - height

width - width

Returns:

a new 2D matrix that contains only those values from (row, column) to (row + height - 1, column + width - 1).

viewSelection

Matrix2D<E> viewSelection(long[] rowIndices,
                        long[] columnIndices)

Return a new 2D matrix selection view that contains only those values at the specified indices. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

rowIndices - row indices

columnIndices - column indices

Returns:

a new 2D matrix selection view that contains only those values at the specified indices

viewSelection

Matrix2D<E> viewSelection(UnaryPredicate<Matrix1D<E>> predicate)

Return a new 2D matrix selection view that contains only those rows selected by the specified predicate. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

predicate - predicate, must not be null

Returns:

a new 2D matrix view that contains only those rows selected by the specified predicate

viewSelection

Matrix2D<E> viewSelection(BitMatrix2D mask)

Return a new 2D matrix selection view that contains only those values at the indices present in the specified bit mask. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

mask - 2D bit mask, must not be null

Returns:

a new 2D matrix selection view that contains only those values at the indices present in the specified mask

viewStrides

Matrix2D<E> viewStrides(long rowStride,
                      long columnStride)

Return a new 2D matrix stride view which is a sub matrix consisting of every rowStride-th row and every columnStride-th column. The view is backed by this matrix, so changes made to the returned view are reflected in this matrix, and vice-versa.

Parameters:

rowStride - row stride, must be > 0

columnStride - column stride, must be > 0

Returns:

a new 2D matrix stride view which is a sub matrix consisting of every rowStride-th row and every columnStride-th column

Throws:

IndexOutOfBoundsException - if either rowStride or columnStride are negative or zero

forEach

void forEach(UnaryProcedure<? super E> procedure)

Apply the specified procedure to each value in this 2D matrix.

For example:

 Matrix2D<String> m;
 m.forEach(new UnaryProcedure<String>()
     {
         public void run(final String value)
         {
             System.out.println(value);
         }
     });
 

Parameters:

procedure - procedure, must not be null

forEach

void forEach(UnaryPredicate<? super E> predicate,
           UnaryProcedure<? super E> procedure)

Apply the specified procedure to each value in this 2D matrix accepted by the specified predicate.

For example:

 Matrix2D<String> m;
 m.forEach(new UnaryPredicate<String>()
     {
         public boolean test(final String value)
         {
             return (value != null);
         }
     }, new UnaryProcedure<String>()
     {
         public void run(final String value)
         {
             System.out.println(value);
         }
     });
 

Parameters:

predicate - predicate, must not be null

procedure - procedure, must not be null

forEachNonNull

void forEachNonNull(UnaryProcedure<? super E> procedure)

Apply the specified procedure to each non-null value in this 2D matrix.

For example:

 Matrix2D<String> m;
 m.forEachNonNull(new UnaryProcedure<String>()
     {
         public void run(final String value)
         {
             System.out.println(value);
         }
     });
 

Parameters:

procedure - procedure, must not be null

forEach

void forEach(TernaryProcedure<Long,Long,? super E> procedure)

Apply the specified procedures to each row and column and to each value in this 2D matrix.

For example:

 Matrix2D<String> m;
 m.forEach(new TernaryProcedure<Long, Long, String>()
     {
         public void run(final Long row, final Long column, final String value)
         {
             System.out.print("m[" + row + ", " + column + "]=" + value);
         }
     });
 

Parameters:

procedure - procedure, must not be null

forEach

void forEach(TernaryPredicate<Long,Long,? super E> predicate,
           TernaryProcedure<Long,Long,? super E> procedure)

Apply the specified procedures to each row and column and to each value in this 2D matrix accepted by the specified predicate.

For example:

 Matrix2D<String> m;
 m.forEach(new TernaryPredicate<Long, Long, String>()
     {
         public boolean test(final Long row, final Long column, final String value)
         {
             return (value != null);
         }
     }, new TernaryProcedure<Long, Long, String>()
     {
         public void run(final Long row, final Long column, final String value)
         {
             System.out.print("m[" + row + ", " + column + "]=" + value);
         }
     });
 

Parameters:

predicate - predicate, must not be null

procedure - procedure, must not be null