org.djunits.value.vfloat.matrix

Interface ReadOnlyFloatMatrixFunctions<U extends Unit<U>>

Type Parameters:

U - Unit of the matrix

All Known Implementing Classes:

FloatMatrix, FloatMatrix.Abs, FloatMatrix.Abs.Dense, FloatMatrix.Abs.Sparse, FloatMatrix.Rel, FloatMatrix.Rel.Dense, FloatMatrix.Rel.Sparse, MutableFloatMatrix, MutableFloatMatrix.Abs, MutableFloatMatrix.Abs.Dense, MutableFloatMatrix.Abs.Sparse, MutableFloatMatrix.Rel, MutableFloatMatrix.Rel.Dense, MutableFloatMatrix.Rel.Sparse

public interface ReadOnlyFloatMatrixFunctions<U extends Unit<U>>

Methods that operate on FloatMatrix but do not modify the contents of the FloatMatrix.

This file was generated by the djunits value classes generator, 26 jun, 2015

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

$LastChangedDate: 2015-10-04 20:48:33 +0200 (Sun, 04 Oct 2015) $, @version $Revision: 87 $, by $Author: averbraeck $, initial version 26 jun, 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.
FloatScalar<U>	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
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.
int	rows() Retrieve the number of rows of the matrix.
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

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())

get

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

Retrieve the value stored at a specified row and column as a FloatScalar.

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

FloatScalar<U>; the strongly typed value of the selected cell

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