org.dishevelled.matrix

Interface Matrix1D<E>

Type Parameters:

E - type of this 1D matrix

All Superinterfaces:

Iterable<E>

All Known Implementing Classes:

AbstractMatrix1D, SparseMatrix1D

public interface Matrix1D<E>
extends Iterable<E>

Typed fixed size matrix of objects in one dimension, 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 1D matrix and aggregate the result.
E	aggregate(Matrix1D<? extends E> other, BinaryFunction<E,E,E> aggr, BinaryFunction<E,E,E> function) Apply a function to each value in this 1D matrix and the specified matrix and aggregate the result.
Matrix1D<E>	assign(E e) Assign all values in this 1D matrix to e (optional operation).
Matrix1D<E>	assign(Matrix1D<? extends E> other) Assign all values in this 1D matrix to the values in the specified matrix (optional operation).
Matrix1D<E>	assign(Matrix1D<? extends E> other, BinaryFunction<E,E,E> function) Assign the result of the specified function of a value from this 1D matrix and the specified matrix to each value in this 1D matrix (optional operation).
Matrix1D<E>	assign(UnaryFunction<E,E> function) Assign the result of the specified function to each value in this 1D matrix (optional operation).
long	cardinality() Return the cardinality of this 1D matrix, the number of non-null values.
void	clear() Clear all the values in this 1D matrix (optional operation).
void	forEach(BinaryPredicate<Long,? super E> predicate, BinaryProcedure<Long,? super E> procedure) Apply the specified procedures to each index and value in this 1D matrix accepted by the specified predicate.
void	forEach(BinaryProcedure<Long,? super E> procedure) Apply the specified procedures to each index and value in this 1D matrix.
void	forEach(UnaryPredicate<? super E> predicate, UnaryProcedure<? super E> procedure) Apply the specified procedure to each value in this 1D matrix accepted by the specified predicate.
void	forEach(UnaryProcedure<? super E> procedure) Apply the specified procedure to each value in this 1D matrix.
void	forEachNonNull(UnaryProcedure<? super E> procedure) Apply the specified procedure to each non-null value in this 1D matrix.
E	get(long index) Return the value at the specified index.
E	getQuick(long index) Return the value at the specified index without checking bounds.
boolean	isEmpty() Return true if the cardinality of this 1D matrix is zero.
Iterator<E>	iterator() Return an iterator over the values in this 1D matrix, including nulls.
void	set(long index, E e) Set the value at the specified index to e (optional operation).
void	setQuick(long index, E e) Set the value at the specified index to e without checking bounds (optional operation).
long	size() Return the size of this 1D matrix.
Matrix1D<E>	viewFlip() Return a new 1D matrix flip view.
Matrix1D<E>	viewPart(long index, long width) Return a new 1D matrix sub-range view that contains only those values from index index to index + width - 1.
Matrix1D<E>	viewSelection(BitMatrix1D mask) Return a new 1D matrix selection view that contains only those values at the indices present in the specified bit mask.
Matrix1D<E>	viewSelection(long[] indices) Return a new 1D matrix selection view that contains only those values at the specified indices.
Matrix1D<E>	viewSelection(UnaryPredicate<E> predicate) Return a new 1D matrix selection view that contains only those values selected by the specified predicate.
Matrix1D<E>	viewStrides(long stride) Return a new 1D matrix stride view which is a sub matrix consisting of every i-th value in this matrix.

Method Detail

size

long size()

Return the size of this 1D matrix.

Returns:

the size of this 1D matrix

cardinality

long cardinality()

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

Returns:

the cardinality of this 1D matrix

isEmpty

boolean isEmpty()

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

Returns:

true if the cardinality of this 1D matrix is zero

clear

void clear()

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

Throws:

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

get

E get(long index)

Return the value at the specified index.

Parameters:

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

Returns:

the value at the specified index

Throws:

IndexOutOfBoundsException - if index is negative or if index is greater than or equal to size()

getQuick

E getQuick(long index)

Return the value at the specified index without checking bounds.

Parameters:

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

Returns:

the value at the specified index without checking bounds

set

void set(long index,
       E e)

Set the value at the specified index to e (optional operation).

Parameters:

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

e - value

Throws:

IndexOutOfBoundsException - if index is negative or if index is greater than or equal to size()

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

setQuick

void setQuick(long index,
            E e)

Set the value at the specified index to e without checking bounds (optional operation).

Parameters:

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

e - value

Throws:

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

iterator

Iterator<E> iterator()

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

Specified by:

iterator in interface Iterable<E>

Returns:

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

assign

Matrix1D<E> assign(E e)

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

Parameters:

e - value

Returns:

this 1D matrix, for convenience

Throws:

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

assign

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

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

Parameters:

function - function, must not be null

Returns:

this 1D matrix, for convenience

Throws:

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

assign

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

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

Parameters:

other - other 1D matrix, must not be null and must be the same size as this 1D matrix

Returns:

this 1D matrix, for convenience

Throws:

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

assign

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

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

Parameters:

other - other 1D matrix, must not be null and must be the same size as this 1D matrix

function - function, must not be null

Returns:

this 1D matrix, for convenience

Throws:

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

aggregate

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

Apply a function to each value in this 1D 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(Matrix1D<? extends E> other,
          BinaryFunction<E,E,E> aggr,
          BinaryFunction<E,E,E> function)

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

Parameters:

other - other 1D matrix, must not be null and must be the same size as this 1D matrix

aggr - aggregate function, must not be null

function - function, must not be null

Returns:

the aggregate result

viewFlip

Matrix1D<E> viewFlip()

Return a new 1D matrix flip view. What used to be index 0 is now index size() - 1, ..., what used to be index size() - 1 is now index 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 1D matrix flip view

viewPart

Matrix1D<E> viewPart(long index,
                   long width)

Return a new 1D matrix sub-range view that contains only those values from index index to index + 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:

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

width - width

Returns:

a new 1D matrix sub-range view that contains only those values from index index to index + width - 1

viewSelection

Matrix1D<E> viewSelection(long[] indices)

Return a new 1D 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:

indices - indices

Returns:

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

viewSelection

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

Return a new 1D matrix selection view that contains only those values 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 1D matrix selection view that contains only those values selected by the specified predicate

viewSelection

Matrix1D<E> viewSelection(BitMatrix1D mask)

Return a new 1D 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 - 1D bit mask, must not be null

Returns:

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

viewStrides

Matrix1D<E> viewStrides(long stride)

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

Parameters:

stride - stride, must be > 0

Returns:

a new 1D matrix stride view which is a sub matrix consisting of every i-th value in this matrix

Throws:

IndexOutOfBoundsException - if stride is negative or zero

forEach

void forEach(UnaryProcedure<? super E> procedure)

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

For example:

 Matrix1D<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 1D matrix accepted by the specified predicate.

For example:

 Matrix1D<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 1D matrix.

For example:

 Matrix1D<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(BinaryProcedure<Long,? super E> procedure)

Apply the specified procedures to each index and value in this 1D matrix.

For example:

 Matrix1D<String> m;
 m.forEach(new BinaryProcedure<Long, String>()
     {
         public void run(final Long index, final String value)
         {
             System.out.print("m[" + index + "]=" + value);
         }
     });
 

Parameters:

procedure - procedure, must not be null

forEach

void forEach(BinaryPredicate<Long,? super E> predicate,
           BinaryProcedure<Long,? super E> procedure)

Apply the specified procedures to each index and value in this 1D matrix accepted by the specified predicate.

For example:

 Matrix1D<String> m;
 m.forEach(new BinaryPredicate<Long, String>()
     {
         public boolean test(final Long index, final String value)
         {
             return (value != null);
         }
     }, new BinaryProcedure<Long, String>()
     {
         public void run(final Long index, final String value)
         {
             System.out.print("m[" + index + "]=" + value);
         }
     });
 

Parameters:

predicate - predicate, must not be null

procedure - procedure, must not be null