org.djunits.value.vfloat.matrix

Interface FloatMatrixInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Known Implementing Classes:

AbstractFloatMatrix, AbstractFloatMatrixAbs, AbstractFloatMatrixRel, AbstractMutableFloatMatrixAbs, AbstractMutableFloatMatrixRel, FloatAbsoluteTemperatureMatrix, FloatAccelerationMatrix, FloatAngleMatrix, FloatAngleSolidMatrix, FloatAreaMatrix, FloatDensityMatrix, FloatDimensionlessMatrix, FloatDirectionMatrix, FloatDurationMatrix, FloatElectricalChargeMatrix, FloatElectricalCurrentMatrix, FloatElectricalPotentialMatrix, FloatElectricalResistanceMatrix, FloatEnergyMatrix, FloatFlowMassMatrix, FloatFlowVolumeMatrix, FloatForceMatrix, FloatFrequencyMatrix, FloatLengthMatrix, FloatLinearDensityMatrix, FloatMassMatrix, FloatMatrix.Abs, FloatMatrix.Rel, FloatMoneyMatrix, FloatMoneyPerAreaMatrix, FloatMoneyPerDurationMatrix, FloatMoneyPerEnergyMatrix, FloatMoneyPerLengthMatrix, FloatMoneyPerMassMatrix, FloatMoneyPerVolumeMatrix, FloatPositionMatrix, FloatPowerMatrix, FloatPressureMatrix, FloatSpeedMatrix, FloatTemperatureMatrix, FloatTimeMatrix, FloatTorqueMatrix, FloatVolumeMatrix, MutableFloatAbsoluteTemperatureMatrix, MutableFloatAccelerationMatrix, MutableFloatAngleMatrix, MutableFloatAngleSolidMatrix, MutableFloatAreaMatrix, MutableFloatDensityMatrix, MutableFloatDimensionlessMatrix, MutableFloatDirectionMatrix, MutableFloatDurationMatrix, MutableFloatElectricalChargeMatrix, MutableFloatElectricalCurrentMatrix, MutableFloatElectricalPotentialMatrix, MutableFloatElectricalResistanceMatrix, MutableFloatEnergyMatrix, MutableFloatFlowMassMatrix, MutableFloatFlowVolumeMatrix, MutableFloatForceMatrix, MutableFloatFrequencyMatrix, MutableFloatLengthMatrix, MutableFloatLinearDensityMatrix, MutableFloatMassMatrix, MutableFloatMatrix.Abs, MutableFloatMatrix.Rel, MutableFloatMoneyMatrix, MutableFloatMoneyPerAreaMatrix, MutableFloatMoneyPerDurationMatrix, MutableFloatMoneyPerEnergyMatrix, MutableFloatMoneyPerLengthMatrix, MutableFloatMoneyPerMassMatrix, MutableFloatMoneyPerVolumeMatrix, MutableFloatPositionMatrix, MutableFloatPowerMatrix, MutableFloatPressureMatrix, MutableFloatSpeedMatrix, MutableFloatTemperatureMatrix, MutableFloatTimeMatrix, MutableFloatTorqueMatrix, MutableFloatVolumeMatrix

public interface FloatMatrixInterface<U extends Unit<U>>

Interface for the Immutable and Mutable FloatMatrix classes.

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 6, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
int	cardinality() Count the number of cells that have a non-zero value (ignores tolerance).
int	columns() Retrieve the number of columns of the matrix.
float	determinant() Compute the determinant of the matrix.
AbstractFloatScalar<U,?>	get(int row, int column) Retrieve a value from the matrix.
float	getInUnit(int row, int column) Retrieve the value stored at a specified row and column in the original unit.
float	getInUnit(int row, int column, U targetUnit) Retrieve the value stored at a specified row and column converted into a specified unit.
float	getSI(int row, int column) Retrieve the value stored at a specified row and column in the standard SI unit.
float[][]	getValuesInUnit() Create a dense float[][] array filled with the values in the original unit.
float[][]	getValuesInUnit(U targetUnit) Create a dense float[][] array filled with the values converted into a specified unit.
float[][]	getValuesSI() Create a dense float[][] array filled with the values in the standard SI unit.
int	rows() Retrieve the number of rows of the matrix.
FloatMatrixInterface<U>	toDense() Create a dense version of this FloatMatrix.
FloatMatrixInterface<U>	toSparse() Create a sparse version of this FloatMatrix.
String	toString()
String	toString(boolean verbose, boolean withUnit) Print this FloatMatrix with optional type and unit information.
String	toString(U displayUnit) Print this FloatMatrix with the values expressed in the specified unit.
String	toString(U displayUnit, boolean verbose, boolean withUnit) Print this FloatMatrix with the values expressed in the specified unit.
float	zSum() Compute the sum of all values of this matrix.

Method Detail

rows

int rows()

Retrieve the number of rows of the matrix.

Returns:

int; the number of rows of the matrix

columns

int columns()

Retrieve the number of columns of the matrix.

Returns:

int; the number of columns of the matrix

cardinality

int cardinality()

Count the number of cells that have a non-zero value (ignores tolerance).

Returns:

int; the number of cells having non-zero value

get

AbstractFloatScalar<U,?> get(int row,
                             int column)
                      throws ValueException

Retrieve a value from the matrix.

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

the value as a DoubleScalar

Throws:

ValueException - in case row or column is out of bounds

getSI

float getSI(int row,
            int column)
     throws ValueException

Retrieve the value stored at a specified row and column in the standard SI unit.

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

float; value at position row, column in the standard SI unit

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

getInUnit

float getInUnit(int row,
                int column)
         throws ValueException

Retrieve the value stored at a specified row and column in the original unit.

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

float; value at position row, column in the original unit

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

getInUnit

float getInUnit(int row,
                int column,
                U targetUnit)
         throws ValueException

Retrieve the value stored at a specified row and column converted into a specified unit.

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

targetUnit - U; the unit for the result

Returns:

float; value at position row, column converted into the specified unit

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

zSum

float zSum()

Compute the sum of all values of this matrix.

Returns:

float; the sum of all values of this matrix

determinant

float determinant()
           throws ValueException

Compute the determinant of the matrix.

Returns:

float; the determinant of the matrix

Throws:

ValueException - when matrix is neither sparse, nor dense, or not square

getValuesSI

float[][] getValuesSI()

Create a dense float[][] array filled with the values in the standard SI unit.

Returns:

float[][]; array of values in the standard SI unit

getValuesInUnit

float[][] getValuesInUnit()

Create a dense float[][] array filled with the values in the original unit.

Returns:

float[][]; the values in the original unit

getValuesInUnit

float[][] getValuesInUnit(U targetUnit)

Create a dense float[][] array filled with the values converted into a specified unit.

Parameters:

targetUnit - U; the unit into which the values are converted for use

Returns:

float[][]; the values converted into the specified unit

toString

String toString()

Overrides:

toString in class Object

Returns:

a String with the Matrix, non-verbose, with the unit attached.

toString

String toString(U displayUnit)

Print this FloatMatrix with the values expressed in the specified unit.

Parameters:

displayUnit - U; the unit into which the values are converted for display

Returns:

String; printable string with the matrix contents expressed in the specified unit

toString

String toString(boolean verbose,
                boolean withUnit)

Print this FloatMatrix with optional type and unit information.

Parameters:

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the matrix contents

toString

String toString(U displayUnit,
                boolean verbose,
                boolean withUnit)

Print this FloatMatrix with the values expressed in the specified unit.

Parameters:

displayUnit - U; the unit into which the values are converted for display

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the matrix contents

toDense

FloatMatrixInterface<U> toDense()

Create a dense version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

FloatMatrixInterface<U> toSparse()

Create a sparse version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix