cern.colt.matrix.tint.impl

Class DenseIntMatrix1D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix1D

cern.colt.matrix.tint.IntMatrix1D

cern.colt.matrix.tint.impl.DenseIntMatrix1D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DenseIntMatrix1D
extends IntMatrix1D

Dense 1-d matrix (aka vector) holding int elements. First see the package summary and javadoc tree view to get the broad picture.

Implementation:

Internally holds one single contigous one-dimensional array. Note that this implementation is not synchronized.

Memory requirements:

memory [bytes] = 8*size(). Thus, a 1000000 matrix uses 8 MB.

Time complexity:

O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseIntMatrix1D(int size) Constructs a matrix with a given number of cells.
DenseIntMatrix1D(int[] values) Constructs a matrix with a copy of the given values.
DenseIntMatrix1D(int size, int[] elements, int zero, int stride, boolean isView) Constructs a matrix with the given parameters.

Method Summary

Modifier and Type	Method and Description
int	aggregate(IntIntFunction aggr, IntFunction f) Applies a function to each cell and aggregates the results.
int	aggregate(IntIntFunction aggr, IntFunction f, IntArrayList indexList) Applies a function to all cells with a given indexes and aggregates the results.
int	aggregate(IntMatrix1D other, IntIntFunction aggr, IntIntFunction f) Applies a function to each corresponding cell of two matrices and aggregates the results.
IntMatrix1D	assign(int value) Sets all cells to the state specified by value.
IntMatrix1D	assign(int[] values) Sets all cells to the state specified by values.
IntMatrix1D	assign(IntFunction function) Assigns the result of a function to each cell; x[i] = function(x[i]).
IntMatrix1D	assign(IntMatrix1D source) Replaces all cell values of the receiver with the values of another matrix.
IntMatrix1D	assign(IntMatrix1D y, IntIntFunction function) Assigns the result of a function to each cell; x[i] = function(x[i],y[i]).
IntMatrix1D	assign(IntProcedure cond, int value) Assigns a value to all cells that satisfy a condition.
IntMatrix1D	assign(IntProcedure cond, IntFunction function) Assigns the result of a function to all cells that satisfy a condition.
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
int[]	elements() Returns the elements of this matrix.
int[]	getMaxLocation() Return the maximum value of this matrix together with its location
int[]	getMinLocation() Return the minimum value of this matrix together with its location
void	getNegativeValues(IntArrayList indexList, IntArrayList valueList) Fills the coordinates and values of cells having negative values into the specified lists.
void	getNonZeros(IntArrayList indexList, IntArrayList valueList) Fills the coordinates and values of cells having non-zero values into the specified lists.
void	getPositiveValues(IntArrayList indexList, IntArrayList valueList) Fills the coordinates and values of cells having positive values into the specified lists.
int	getQuick(int index) Returns the matrix cell value at coordinate index.
long	index(int rank) Returns the position of the element with the given relative rank within the (virtual or non-virtual) internal 1-dimensional array.
IntMatrix1D	like(int size) Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified size.
IntMatrix2D	like2D(int rows, int columns) Construct and returns a new 2-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
IntMatrix2D	reshape(int rows, int columns) Returns new IntMatrix2D of size rows x columns whose elements are taken column-wise from this matrix.
IntMatrix3D	reshape(int slices, int rows, int columns) Returns new IntMatrix3D of size slices x rows x columns, whose elements are taken column-wise from this matrix.
void	setQuick(int index, int value) Sets the matrix cell at coordinate index to the specified value.
void	swap(IntMatrix1D other) Swaps each element this[i] with other[i].
void	toArray(int[] values) Fills the cell values into the specified 1-dimensional array.
int	zDotProduct(IntMatrix1D y) Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
int	zDotProduct(IntMatrix1D y, int from, int length) Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
int	zSum() Returns the sum of all cells; Sum( x[i] ).

Methods inherited from class cern.colt.matrix.tint.IntMatrix1D

assign, copy, equals, equals, get, getNonZeros, like, set, setSize, toArray, toString, viewFlip, viewPart, viewSelection, viewSelection, viewSorted, viewStrides, zDotProduct

Methods inherited from class cern.colt.matrix.AbstractMatrix1D

checkSize, size, stride, toStringShort

Methods inherited from class cern.colt.matrix.AbstractMatrix

ensureCapacity, isView, trimToSize

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DenseIntMatrix1D

public DenseIntMatrix1D(int[] values)

Constructs a matrix with a copy of the given values. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

DenseIntMatrix1D

public DenseIntMatrix1D(int size)

Constructs a matrix with a given number of cells. All entries are initially 0.

Parameters:

size - the number of cells the matrix shall have.

Throws:

java.lang.IllegalArgumentException - if size<0.

DenseIntMatrix1D

public DenseIntMatrix1D(int size,
                        int[] elements,
                        int zero,
                        int stride,
                        boolean isView)

Constructs a matrix with the given parameters.

Parameters:

size - the number of cells the matrix shall have.

elements - the cells.

zero - the index of the first element.

stride - the number of indexes between any two elements, i.e. index(i+1)-index(i).

isView - if true then a matrix view is constructed

Throws:

java.lang.IllegalArgumentException - if size<0.

Method Detail

aggregate

public int aggregate(IntIntFunction aggr,
                     IntFunction f)

Description copied from class: IntMatrix1D

Applies a function to each cell and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(i)) ) and terminators are a(1) == f(get(0)), a(0)==Int.NaN.

Example:

   cern.jet.math.Functions F = cern.jet.math.Functions.functions;
   matrix = 0 1 2 3 
 
   // Sum( x[i]*x[i] ) 
   matrix.aggregate(F.plus,F.square);
   --> 14
 
 

For further examples, see the package doc.

Overrides:

aggregate in class IntMatrix1D

Parameters:

aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.

f - a function transforming the current cell value.

Returns:

the aggregated measure.

See Also:

IntFunctions

aggregate

public int aggregate(IntIntFunction aggr,
                     IntFunction f,
                     IntArrayList indexList)

Description copied from class: IntMatrix1D

Applies a function to all cells with a given indexes and aggregates the results.

Overrides:

aggregate in class IntMatrix1D

Parameters:

aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.

f - a function transforming the current cell value.

indexList - indexes.

Returns:

the aggregated measure.

See Also:

IntFunctions

aggregate

public int aggregate(IntMatrix1D other,
                     IntIntFunction aggr,
                     IntIntFunction f)

Description copied from class: IntMatrix1D

Applies a function to each corresponding cell of two matrices and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(i),other.get(i)) ) and terminators are a(1) == f(get(0),other.get(0)), a(0)==Int.NaN.

Example:

   cern.jet.math.Functions F = cern.jet.math.Functions.functions;
   x = 0 1 2 3 
   y = 0 1 2 3 
 
   // Sum( x[i]*y[i] )
   x.aggregate(y, F.plus, F.mult);
   --> 14
 
   // Sum( (x[i]+y[i])ˆ2 )
   x.aggregate(y, F.plus, F.chain(F.square,F.plus));
   --> 56
 
 

For further examples, see the package doc.

Overrides:

aggregate in class IntMatrix1D

aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell values.

f - a function transforming the current cell values.

Returns:

the aggregated measure.

See Also:

IntFunctions

assign

public IntMatrix1D assign(IntFunction function)

Description copied from class: IntMatrix1D

Assigns the result of a function to each cell; x[i] = function(x[i]). (Iterates downwards from [size()-1] to [0]).

Example:

   // change each cell to its sine
   matrix =   0.5      1.5      2.5       3.5 
   matrix.assign(cern.jet.math.Functions.sin);
   -->
   matrix ==  0.479426 0.997495 0.598472 -0.350783
 
 

For further examples, see the package doc.

Overrides:

assign in class IntMatrix1D

Parameters:

function - a function object taking as argument the current cell's value.

Returns:

this (for convenience only).

See Also:

IntFunctions

assign

public IntMatrix1D assign(IntProcedure cond,
                          IntFunction function)

Description copied from class: IntMatrix1D

Assigns the result of a function to all cells that satisfy a condition.

Overrides:

assign in class IntMatrix1D

Parameters:

cond - a condition.

function - a function object.

Returns:

this (for convenience only).

See Also:

IntFunctions

assign

public IntMatrix1D assign(IntProcedure cond,
                          int value)

Description copied from class: IntMatrix1D

Assigns a value to all cells that satisfy a condition.

Overrides:

assign in class IntMatrix1D

Parameters:

cond - a condition.

value - a value.

Returns:

this (for convenience only).

assign

public IntMatrix1D assign(int value)

Description copied from class: IntMatrix1D

Sets all cells to the state specified by value.

Overrides:

assign in class IntMatrix1D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public IntMatrix1D assign(int[] values)

Description copied from class: IntMatrix1D

Sets all cells to the state specified by values. values is required to have the same number of cells as the receiver.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class IntMatrix1D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public IntMatrix1D assign(IntMatrix1D source)

Description copied from class: IntMatrix1D

Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same size. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.

Overrides:

assign in class IntMatrix1D

Parameters:

source - the source matrix to copy from (may be identical to the receiver).

Returns:

this (for convenience only).

assign

public IntMatrix1D assign(IntMatrix1D y,
                          IntIntFunction function)

Description copied from class: IntMatrix1D

Assigns the result of a function to each cell; x[i] = function(x[i],y[i]).

Example:

   // assign x[i] = x[i]<sup>y[i]</sup>
   m1 = 0 1 2 3;
   m2 = 0 2 4 6;
   m1.assign(m2, cern.jet.math.Functions.pow);
   -->
   m1 == 1 1 16 729
 
 

For further examples, see the package doc.

Overrides:

assign in class IntMatrix1D

Parameters:

y - the secondary matrix to operate on.

function - a function object taking as first argument the current cell's value of this, and as second argument the current cell's value of y,

Returns:

this (for convenience only).

See Also:

IntFunctions

cardinality

public int cardinality()

Description copied from class: IntMatrix1D

Returns the number of cells having non-zero values; ignores tolerance.

Overrides:

cardinality in class IntMatrix1D

Returns:

the number of cells having non-zero values.

elements

public int[] elements()

Description copied from class: IntMatrix1D

Returns the elements of this matrix.

Specified by:

elements in class IntMatrix1D

Returns:

the elements

getNonZeros

public void getNonZeros(IntArrayList indexList,
                        IntArrayList valueList)

Description copied from class: IntMatrix1D

Fills the coordinates and values of cells having non-zero values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

In general, fill order is unspecified. This implementation fills like: for (index = 0..size()-1) do ... . However, subclasses are free to us any other order, even an order that may change over time as cell values are changed. (Of course, result lists indexes are guaranteed to correspond to the same cell).

Example:

   0, 0, 8, 0, 7
   -->
   indexList  = (2,4)
   valueList  = (8,7)
 
 

In other words, get(2)==8, get(4)==7.

Overrides:

getNonZeros in class IntMatrix1D

Parameters:

indexList - the list to be filled with indexes, can have any size.

valueList - the list to be filled with values, can have any size.

getPositiveValues

public void getPositiveValues(IntArrayList indexList,
                              IntArrayList valueList)

Description copied from class: IntMatrix1D

Fills the coordinates and values of cells having positive values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

Overrides:

getPositiveValues in class IntMatrix1D

Parameters:

indexList - the list to be filled with indexes, can have any size.

valueList - the list to be filled with values, can have any size.

getNegativeValues

public void getNegativeValues(IntArrayList indexList,
                              IntArrayList valueList)

Description copied from class: IntMatrix1D

Fills the coordinates and values of cells having negative values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

Overrides:

getNegativeValues in class IntMatrix1D

Parameters:

indexList - the list to be filled with indexes, can have any size.

valueList - the list to be filled with values, can have any size.

getMaxLocation

public int[] getMaxLocation()

Description copied from class: IntMatrix1D

Return the maximum value of this matrix together with its location

Overrides:

getMaxLocation in class IntMatrix1D

Returns:

{ maximum_value, location };

getMinLocation

public int[] getMinLocation()

Description copied from class: IntMatrix1D

Return the minimum value of this matrix together with its location

Overrides:

getMinLocation in class IntMatrix1D

Returns:

{ minimum_value, location };

getQuick

public int getQuick(int index)

Description copied from class: IntMatrix1D

Returns the matrix cell value at coordinate index.

Provided with invalid parameters this method may return invalid objects without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): index<0 || index>=size().

Specified by:

getQuick in class IntMatrix1D

Parameters:

index - the index of the cell.

Returns:

the value of the specified cell.

like

public IntMatrix1D like(int size)

Description copied from class: IntMatrix1D

Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified size. For example, if the receiver is an instance of type DenseIntMatrix1D the new matrix must also be of type DenseIntMatrix1D, if the receiver is an instance of type SparseIntMatrix1D the new matrix must also be of type SparseIntMatrix1D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Specified by:

like in class IntMatrix1D

Parameters:

size - the number of cell the matrix shall have.

Returns:

a new empty matrix of the same dynamic type.

like2D

public IntMatrix2D like2D(int rows,
                          int columns)

Description copied from class: IntMatrix1D

Construct and returns a new 2-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseIntMatrix1D the new matrix must be of type DenseIntMatrix2D, if the receiver is an instance of type SparseIntMatrix1D the new matrix must be of type SparseIntMatrix2D, etc.

Specified by:

like2D in class IntMatrix1D

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

reshape

public IntMatrix2D reshape(int rows,
                           int columns)

Description copied from class: IntMatrix1D

Returns new IntMatrix2D of size rows x columns whose elements are taken column-wise from this matrix.

Specified by:

reshape in class IntMatrix1D

Parameters:

rows - number of rows

columns - number of columns

Returns:

new 2D matrix with columns being the elements of this matrix.

reshape

public IntMatrix3D reshape(int slices,
                           int rows,
                           int columns)

Description copied from class: IntMatrix1D

Returns new IntMatrix3D of size slices x rows x columns, whose elements are taken column-wise from this matrix.

Specified by:

reshape in class IntMatrix1D

rows - number of rows

columns - number of columns

Returns:

new 2D matrix with columns being the elements of this matrix.

setQuick

public void setQuick(int index,
                     int value)

Description copied from class: IntMatrix1D

Sets the matrix cell at coordinate index to the specified value.

Provided with invalid parameters this method may access illegal indexes without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): index<0 || index>=size().

Specified by:

setQuick in class IntMatrix1D

Parameters:

index - the index of the cell.

value - the value to be filled into the specified cell.

swap

public void swap(IntMatrix1D other)

Description copied from class: IntMatrix1D

Swaps each element this[i] with other[i].

Overrides:

swap in class IntMatrix1D

toArray

public void toArray(int[] values)

Description copied from class: IntMatrix1D

Fills the cell values into the specified 1-dimensional array. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa. After this call returns the array values has the form
for (int i=0; i < size(); i++) values[i] = get(i);

Overrides:

toArray in class IntMatrix1D

zDotProduct

public int zDotProduct(IntMatrix1D y)

Description copied from class: IntMatrix1D

Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]). Where x == this. Operates on cells at indexes 0 .. Math.min(size(),y.size()).

Overrides:

zDotProduct in class IntMatrix1D

Parameters:

y - the second vector.

Returns:

the sum of products.

zDotProduct

public int zDotProduct(IntMatrix1D y,
                       int from,
                       int length)

Description copied from class: IntMatrix1D

Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]). Where x == this. Operates on cells at indexes from .. Min(size(),y.size(),from+length)-1.

Overrides:

zDotProduct in class IntMatrix1D

Parameters:

y - the second vector.

from - the first index to be considered.

length - the number of cells to be considered.

Returns:

the sum of products; zero if from<0 || length<0.

zSum

public int zSum()

Description copied from class: IntMatrix1D

Returns the sum of all cells; Sum( x[i] ).

Overrides:

zSum in class IntMatrix1D

Returns:

the sum.

index

public long index(int rank)

Description copied from class: AbstractMatrix1D

Returns the position of the element with the given relative rank within the (virtual or non-virtual) internal 1-dimensional array. You may want to override this method for performance.

Overrides:

index in class AbstractMatrix1D

Parameters:

rank - the rank of the element.