org.ejml.data

Class ReshapeMatrix64F

java.lang.Object

org.ejml.data.ReshapeMatrix64F

All Implemented Interfaces:

Serializable, Matrix64F

Direct Known Subclasses:

D1Matrix64F

public abstract class ReshapeMatrix64F
extends Object
implements Matrix64F

An abstract class for all 64 bit floating point rectangular matrices which can be reshaped.

Author:

Peter Abeles

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	numCols Number of columns in the matrix.
int	numRows Number of rows in the matrix.

Constructor Summary

Constructors

Constructor and Description
ReshapeMatrix64F()

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumCols() Returns the number of columns in this matrix.
int	getNumRows() Returns the number of rows in this matrix.
MatrixIterator	iterator(boolean rowMajor, int minRow, int minCol, int maxRow, int maxCol) Creates a new iterator for traversing through a submatrix inside this matrix.
void	reshape(int numRows, int numCols) Equivalent to invoking reshape(numRows,numCols,false);
abstract void	reshape(int numRows, int numCols, boolean saveValues) Changes the number of rows and columns in the matrix, allowing its size to grow or shrink.
void	set(ReshapeMatrix64F A) Assigns the value of 'this' matrix to be the same as 'A'.
void	setNumCols(int numCols) Sets the number of columns.
void	setNumRows(int numRows) Sets the number of rows.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ejml.data.Matrix64F

copy, get, getNumElements, print, set, unsafe_get, unsafe_set

Field Detail

numRows

public int numRows

Number of rows in the matrix.

numCols

public int numCols

Number of columns in the matrix.

Constructor Detail

ReshapeMatrix64F

public ReshapeMatrix64F()

Method Detail

reshape

public abstract void reshape(int numRows,
           int numCols,
           boolean saveValues)

Changes the number of rows and columns in the matrix, allowing its size to grow or shrink. If the saveValues flag is set to true, then the previous values will be maintained, but reassigned to new elements in a row-major ordering. If saveValues is false values will only be maintained when the requested size is less than or equal to the internal array size. The primary use for this function is to encourage data reuse and avoid unnecessarily declaring and initialization of new memory.

Examples:
[ 1 2 ; 3 4 ] -> reshape( 2 , 3 , true ) = [ 1 2 3 ; 4 0 0 ]
[ 1 2 ; 3 4 ] -> reshape( 1 , 2 , true ) = [ 1 2 ]
[ 1 2 ; 3 4 ] -> reshape( 1 , 2 , false ) = [ 1 2 ]
[ 1 2 ; 3 4 ] -> reshape( 2 , 3 , false ) = [ 0 0 0 ; 0 0 0 ]

Parameters:

numRows - The new number of rows in the matrix.

numCols - The new number of columns in the matrix.

saveValues - If true then the value of each element will be save using a row-major reordering. Typically this should be false.

reshape

public void reshape(int numRows,
           int numCols)

Equivalent to invoking reshape(numRows,numCols,false);

Parameters:

numRows - The new number of rows in the matrix.

numCols - The new number of columns in the matrix.

iterator

public MatrixIterator iterator(boolean rowMajor,
                      int minRow,
                      int minCol,
                      int maxRow,
                      int maxCol)

Creates a new iterator for traversing through a submatrix inside this matrix. It can be traversed by row or by column. Range of elements is inclusive, e.g. minRow = 0 and maxRow = 1 will include rows 0 and 1. The iteration starts at (minRow,minCol) and ends at (maxRow,maxCol)

Parameters:

rowMajor - true means it will traverse through the submatrix by row first, false by columns.

minRow - first row it will start at.

minCol - first column it will start at.

maxRow - last row it will stop at.

maxCol - last column it will stop at.

Returns:

A new MatrixIterator

getNumRows

public int getNumRows()

Returns the number of rows in this matrix.

Specified by:

getNumRows in interface Matrix64F

Returns:

Number of rows.

getNumCols

public int getNumCols()

Returns the number of columns in this matrix.

Specified by:

getNumCols in interface Matrix64F

Returns:

Number of columns.

setNumRows

public void setNumRows(int numRows)

Sets the number of rows.

Parameters:

numRows - Number of rows

setNumCols

public void setNumCols(int numCols)

Sets the number of columns.

Parameters:

numCols - Number of columns

set

public void set(ReshapeMatrix64F A)

Assigns the value of 'this' matrix to be the same as 'A'. The shape of both matrices must be the same.

Parameters:

A - The matrix whose value is to be copied into 'this'.