org.djunits.value.vfloat.matrix

Class FloatMatrixDataDense

java.lang.Object

org.djunits.value.vfloat.matrix.FloatMatrixData

org.djunits.value.vfloat.matrix.FloatMatrixDataDense

public class FloatMatrixDataDense
extends FloatMatrixData

Stores dense data for a FloatMatrix and carries out basic operations.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 3, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields inherited from class org.djunits.value.vfloat.matrix.FloatMatrixData

cols, matrixSI, rows

Constructor Summary

Constructors

Constructor and Description
FloatMatrixDataDense(float[][] matrixSI) Create a matrix with dense data.
FloatMatrixDataDense(float[] matrixSI, int rows, int cols) Create a matrix with dense data.

Method Summary

Modifier and Type	Method and Description
void	assign(FloatFunction floatFunction)
FloatMatrixDataDense	copy()
void	decrementBy(FloatMatrixData right) Subtract a matrix from this matrix on a cell-by-cell basis.
void	divideBy(FloatMatrixData right) Divide the values of a matrix by the values of another matrix on a cell-by-cell basis.
float[][]	getDenseMatrixSI()
double[][]	getDoubleDenseMatrixSI()
float	getSI(int row, int col)
void	incrementBy(FloatMatrixData right) Add a matrix to this matrix on a cell-by-cell basis.
void	multiplyBy(FloatMatrixData right) Multiply a matrix with the values of another matrix on a cell-by-cell basis.
void	setSI(int row, int col, float valueSI) Sets a value at the [row, col] point in the matrix.
FloatMatrixDataSparse	toSparse()

Methods inherited from class org.djunits.value.vfloat.matrix.FloatMatrixData

cardinality, cols, decrementBy, divide, divideBy, equals, getStorageType, hashCode, incrementBy, instantiate, instantiate, isDense, isSparse, minus, multiplyBy, plus, rows, times, toDense, toString, zSum

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatMatrixDataDense

public FloatMatrixDataDense(float[] matrixSI,
                            int rows,
                            int cols)
                     throws ValueException

Create a matrix with dense data.

Parameters:

matrixSI - the data to store

rows - the number of rows

cols - the number of columns

Throws:

ValueException - in case rows * cols != matrixSI.length

FloatMatrixDataDense

public FloatMatrixDataDense(float[][] matrixSI)
                     throws ValueException

Create a matrix with dense data.

Parameters:

matrixSI - the data to store

Throws:

ValueException - in case matrix is ragged

Method Detail

assign

public final void assign(FloatFunction floatFunction)

Parameters:

floatFunction - the function to apply on the (mutable) data elements

toSparse

public final FloatMatrixDataSparse toSparse()

Overrides:

toSparse in class FloatMatrixData

Returns:

the sparse transformation of this data

getSI

public final float getSI(int row,
                         int col)

Specified by:

getSI in class FloatMatrixData

Parameters:

row - the row number to get the value for

col - the column number to get the value for

Returns:

the value at the [row, col] point

setSI

public final void setSI(int row,
                        int col,
                        float valueSI)

Sets a value at the [row, col] point in the matrix.

Specified by:

setSI in class FloatMatrixData

Parameters:

row - the row number to set the value for

col - the column number to set the value for

valueSI - the value at the index

getDenseMatrixSI

public final float[][] getDenseMatrixSI()

Specified by:

getDenseMatrixSI in class FloatMatrixData

Returns:

a safe dense copy of matrixSI as a matrix

getDoubleDenseMatrixSI

public final double[][] getDoubleDenseMatrixSI()

Specified by:

getDoubleDenseMatrixSI in class FloatMatrixData

Returns:

a safe dense copy of matrixSI as a double matrix

copy

public final FloatMatrixDataDense copy()

Specified by:

copy in class FloatMatrixData

Returns:

a deep copy of the data.

incrementBy

public final void incrementBy(FloatMatrixData right)
                       throws ValueException

Add a matrix to this matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

incrementBy in class FloatMatrixData

Parameters:

right - the other data object to add

Throws:

ValueException - if matrices have different lengths

decrementBy

public final void decrementBy(FloatMatrixData right)
                       throws ValueException

Subtract a matrix from this matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

decrementBy in class FloatMatrixData

Parameters:

right - the other data object to subtract

Throws:

ValueException - if matrices have different lengths

multiplyBy

public final void multiplyBy(FloatMatrixData right)
                      throws ValueException

Multiply a matrix with the values of another matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

multiplyBy in class FloatMatrixData

Parameters:

right - the other data object to multiply with

Throws:

ValueException - if matrices have different lengths

divideBy

public final void divideBy(FloatMatrixData right)
                    throws ValueException

Divide the values of a matrix by the values of another matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

divideBy in class FloatMatrixData

Parameters:

right - the other data object to divide by

Throws:

ValueException - if matrices have different lengths