Package org.ejml.data

Class FMatrixRBlock

java.lang.Object

org.ejml.data.FMatrixD1

org.ejml.data.FMatrixRBlock

All Implemented Interfaces:

java.io.Serializable, FMatrix, Matrix, ReshapeMatrix

public class FMatrixRBlock
extends FMatrixD1

A row-major block matrix declared on to one continuous array.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
int	blockLength

Fields inherited from class org.ejml.data.FMatrixD1

data, numCols, numRows

Constructor Summary

Constructors

Constructor	Description
FMatrixRBlock()
FMatrixRBlock(int numRows, int numCols)
FMatrixRBlock(int numRows, int numCols, int blockLength)

Method Summary

Modifier and Type	Method	Description
FMatrixRBlock	copy()	Creates an exact copy of the matrix
<T extends Matrix> T	create(int numRows, int numCols)	Creates a new matrix of the same type with the specified shape
<T extends Matrix> T	createLike()	Creates a new matrix with the same shape as this matrix
float	get(int row, int col)	Returns the value of value of the specified matrix element.
float[]	getData()	Used to get a reference to the internal data.
int	getIndex(int row, int col)	Returns the internal array index for the specified row and column.
int	getNumCols()	Returns the number of columns in this matrix.
int	getNumElements()	Returns the number of elements in this matrix, which is the number of rows times the number of columns.
int	getNumRows()	Returns the number of rows in this matrix.
MatrixType	getType()	Returns the type of matrix
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	reshape(int numRows, int numCols, int blockLength, boolean saveValues)
void	set(int row, int col, float val)	Sets the value of the specified matrix element.
void	set(FMatrixRBlock A)
void	set(Matrix original)	Sets this matrix to be identical to the 'original' matrix passed in.
float	unsafe_get(int row, int col)	Same as FMatrix.get(int, int) but does not perform bounds check on input parameters.
void	unsafe_set(int row, int col, float val)	Same as FMatrix.set(int, int, float) but does not perform bounds check on input parameters.
static FMatrixRBlock	wrap(float[] data, int numRows, int numCols, int blockLength)
void	zero()	Sets all values inside the matrix to zero

Methods inherited from class org.ejml.data.FMatrixD1

div, get, iterator, minus, plus, print, print, reshape, set, set, setData, setNumCols, setNumRows, times

Methods inherited from class java.lang.Object

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

Field Detail

blockLength

public int blockLength

Constructor Detail

FMatrixRBlock

public FMatrixRBlock(int numRows,
                     int numCols,
                     int blockLength)

FMatrixRBlock

public FMatrixRBlock(int numRows,
                     int numCols)

FMatrixRBlock

public FMatrixRBlock()

Method Detail

set

public void set(FMatrixRBlock A)

wrap

public static FMatrixRBlock wrap(float[] data,
                                 int numRows,
                                 int numCols,
                                 int blockLength)

getData

public float[] getData()

Description copied from class: FMatrixD1

Used to get a reference to the internal data.

Overrides:

getData in class FMatrixD1

Returns:

Reference to the matrix's data.

reshape

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

Description copied from class: FMatrixD1

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 ]

Specified by:

reshape in class FMatrixD1

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,
                    int blockLength,
                    boolean saveValues)

getIndex

public int getIndex(int row,
                    int col)

Description copied from class: FMatrixD1

Returns the internal array index for the specified row and column.

Specified by:

getIndex in class FMatrixD1

Parameters:

row - Row index.

col - Column index.

Returns:

Internal array index.

get

public float get(int row,
                 int col)

Description copied from interface: FMatrix

Returns the value of value of the specified matrix element.

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

Returns:

The specified element's value.

unsafe_get

public float unsafe_get(int row,
                        int col)

Description copied from interface: FMatrix

Same as FMatrix.get(int, int) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

Returns:

The specified element's value.

set

public void set(int row,
                int col,
                float val)

Description copied from interface: FMatrix

Sets the value of the specified matrix element.

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

val - The element's new value.

unsafe_set

public void unsafe_set(int row,
                       int col,
                       float val)

Description copied from interface: FMatrix

Same as FMatrix.set(int, int, float) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

val - The element's new value.

getNumRows

public int getNumRows()

Description copied from class: FMatrixD1

Returns the number of rows in this matrix.

Specified by:

getNumRows in interface Matrix

Overrides:

getNumRows in class FMatrixD1

Returns:

Number of rows.

getNumCols

public int getNumCols()

Description copied from class: FMatrixD1

Returns the number of columns in this matrix.

Specified by:

getNumCols in interface Matrix

Overrides:

getNumCols in class FMatrixD1

Returns:

Number of columns.

zero

public void zero()

Description copied from interface: Matrix

Sets all values inside the matrix to zero

createLike

public <T extends Matrix> T createLike()

Description copied from interface: Matrix

Creates a new matrix with the same shape as this matrix

create

public <T extends Matrix> T create(int numRows,
                                   int numCols)

Description copied from interface: Matrix

Creates a new matrix of the same type with the specified shape

set

public void set(Matrix original)

Description copied from interface: Matrix

Sets this matrix to be identical to the 'original' matrix passed in.

getNumElements

public int getNumElements()

Description copied from interface: FMatrix

Returns the number of elements in this matrix, which is the number of rows times the number of columns.

Returns:

Number of elements in this matrix.

copy

public FMatrixRBlock copy()

Description copied from interface: Matrix

Creates an exact copy of the matrix

getType

public MatrixType getType()

Description copied from interface: Matrix

Returns the type of matrix