FloatMatrix (DJUNITS 1.02.01 API)

java.lang.Object
- org.djunits.value.AbstractValue
- - org.djunits.value.vfloat.matrix.FloatMatrix

Type Parameters:

U - Unit; the unit of this FloatMatrix

All Implemented Interfaces:

Serializable, Value, ReadOnlyFloatMatrixFunctions

Direct Known Subclasses:

FloatMatrix.Abs, FloatMatrix.Rel, MutableFloatMatrix
```
public abstract class FloatMatrix>
extends AbstractValue
implements Serializable, ReadOnlyFloatMatrixFunctions
```
Immutable 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-07 01:17:57 +0200 (Wed, 07 Oct 2015) $, @version $Revision: 88 $, by $Author: averbraeck $, initial version 26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FloatMatrix.Abs>

static class FloatMatrix.Rel>

Nested Classes
Modifier and Type	Class and Description
`static class`	`FloatMatrix.Abs<U extends Unit<U>>`
`static class`	`FloatMatrix.Rel<U extends Unit<U>>`

Field Summary

Fields
Modifier and Type Field and Description

protected org.djunits.value.vfloat.matrix.FloatMatrixData data
The stored data as an object, can be sparse or dense.

Fields
Modifier and Type	Field and Description
`protected org.djunits.value.vfloat.matrix.FloatMatrixData`	`data` The stored data as an object, can be sparse or dense.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FloatMatrix(U unit)
Construct a new Immutable FloatMatrix.

Constructors
Modifier	Constructor and Description
`protected`	`FloatMatrix(U unit)` Construct a new Immutable FloatMatrix.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`cardinality()` Count the number of cells that have a non-zero value (ignores tolerance).
`protected void`	`checkIndex(int row, int column)` Check that provided row and column indices are valid.
`protected static <U extends Unit<U>> FloatScalar<U>[][]`	`checkNonEmpty(FloatScalar<U>[][] dsArray)` Check that a provided array can be used to create some descendant of a FloatMatrix.
`protected void`	`checkSize(float[][] other)` Centralized size equality check.
`protected void`	`checkSize(FloatMatrix<?> other)` Centralized size equality check.
`int`	`columns()` Retrieve the number of columns of the matrix.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Sparse<U>`	`denseToSparse(FloatMatrix.Abs.Dense<U> in)` Create a Sparse version of a Dense FloatMatrix.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Sparse<U>`	`denseToSparse(FloatMatrix.Rel.Dense<U> in)` Create a Sparse version of a Dense FloatMatrix.
`float`	`determinant()` Compute the determinant of the matrix.
`boolean`	`equals(Object obj)`
`protected abstract org.djunits.value.vfloat.matrix.FloatMatrixData`	`getData()`
`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 float[][] array filled with the values in the original unit.
`float[][]`	`getValuesInUnit(U targetUnit)` Create a float[][] array filled with the values converted into a specified unit.
`float[][]`	`getValuesSI()` Create a float[][] array filled with the values in the standard SI unit.
`int`	`hashCode()`
`protected FloatMatrixDataDense`	`initializeDense(float[][] values)` Import the values and convert them into the SI standard unit.
`protected FloatMatrixDataDense`	`initializeDense(FloatScalar<U>[][] values)` Construct the matrix and store the values in the standard SI unit.
`protected FloatMatrixDataSparse`	`initializeSparse(float[][] values)` Import the values and convert them into the SI standard unit.
`protected FloatMatrixDataSparse`	`initializeSparse(FloatScalar<U>[][] values)` Construct the matrix and store the values in the standard SI unit.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`interpolate(FloatMatrix.Abs.Dense<U> zero, FloatMatrix.Abs.Dense<U> one, float ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Sparse<U>`	`interpolate(FloatMatrix.Abs.Sparse<U> zero, FloatMatrix.Abs.Sparse<U> one, float ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`interpolate(FloatMatrix.Rel.Dense<U> zero, FloatMatrix.Rel.Dense<U> one, float ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Sparse<U>`	`interpolate(FloatMatrix.Rel.Sparse<U> zero, FloatMatrix.Rel.Sparse<U> one, float ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`minus(FloatMatrix.Abs.Dense<U> left, FloatMatrix.Rel<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`minus(FloatMatrix.Abs.Sparse<U> left, FloatMatrix.Rel.Dense<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Sparse<U>`	`minus(FloatMatrix.Abs.Sparse<U> left, FloatMatrix.Rel.Sparse<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`minus(FloatMatrix.Rel.Dense<U> left, FloatMatrix.Rel<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`minus(FloatMatrix.Rel.Sparse<U> left, FloatMatrix.Rel.Dense<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Sparse<U>`	`minus(FloatMatrix.Rel.Sparse<U> left, FloatMatrix.Rel.Sparse<U> right)` Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<U>.
`abstract MutableFloatMatrix<U>`	`mutable()` Create a mutable version of this FloatMatrix.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`plus(FloatMatrix.Abs.Dense<U> left, FloatMatrix.Rel<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`plus(FloatMatrix.Abs.Sparse<U> left, FloatMatrix.Rel.Dense<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Sparse<U>`	`plus(FloatMatrix.Abs.Sparse<U> left, FloatMatrix.Rel.Sparse<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`plus(FloatMatrix.Rel.Dense<U> left, FloatMatrix.Rel<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`plus(FloatMatrix.Rel.Sparse<U> left, FloatMatrix.Rel.Dense<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Sparse<U>`	`plus(FloatMatrix.Rel.Sparse<U> left, FloatMatrix.Rel.Sparse<U> right)` Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<U>.
`int`	`rows()` Retrieve the number of rows of the matrix.
`protected float`	`safeGet(int row, int column)` Retrieve a value in matrixSI without checking validity of the indices.
`protected void`	`safeSet(int row, int column, float valueSI)` Modify a value in matrixSI without checking validity of the indices.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`sparseToDense(FloatMatrix.Abs.Sparse<U> in)` Create a Dense version of a Sparse FloatMatrix.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`sparseToDense(FloatMatrix.Rel.Sparse<U> in)` Create a Dense version of a Sparse FloatMatrix.
`static MutableFloatMatrix.Abs.Dense<SIUnit>`	`times(FloatMatrix.Abs.Dense<?> left, FloatMatrix.Abs.Dense<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<SIUnit>.
`static MutableFloatMatrix.Abs.Sparse<SIUnit>`	`times(FloatMatrix.Abs.Dense<?> left, FloatMatrix.Abs.Sparse<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Dense<U>`	`times(FloatMatrix.Abs.Dense<U> left, float[][] right)` Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Abs.Dense<U>.
`static MutableFloatMatrix.Abs.Sparse<SIUnit>`	`times(FloatMatrix.Abs.Sparse<?> left, FloatMatrix.Abs<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableFloatMatrix.Abs.Sparse<U>`	`times(FloatMatrix.Abs.Sparse<U> left, float[][] right)` Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<U>.
`static MutableFloatMatrix.Rel.Dense<SIUnit>`	`times(FloatMatrix.Rel.Dense<?> left, FloatMatrix.Rel.Dense<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<SIUnit>.
`static MutableFloatMatrix.Rel.Sparse<SIUnit>`	`times(FloatMatrix.Rel.Dense<?> left, FloatMatrix.Rel.Sparse<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Dense<U>`	`times(FloatMatrix.Rel.Dense<U> left, float[][] right)` Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Rel.Dense<U>.
`static MutableFloatMatrix.Rel.Sparse<SIUnit>`	`times(FloatMatrix.Rel.Sparse<?> left, FloatMatrix.Rel<?> right)` Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableFloatMatrix.Rel.Sparse<U>`	`times(FloatMatrix.Rel.Sparse<U> left, float[][] right)` Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<U>.
`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.

Methods inherited from class org.djunits.value.AbstractValue
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.vfloat.matrix.ReadOnlyFloatMatrixFunctions
get

- Field Detail
 - data
```
protected org.djunits.value.vfloat.matrix.FloatMatrixData data
```
 The stored data as an object, can be sparse or dense.
- Constructor Detail
 - FloatMatrix
```
protected FloatMatrix(U unit)
```
 Construct a new Immutable FloatMatrix.
 
 Parameters:
 
 unit - U; the unit of the new FloatMatrix
- Method Detail
 - getData
```
protected abstract org.djunits.value.vfloat.matrix.FloatMatrixData getData()
```
 Returns:
 
 the data, as Dense or Sparse data.
 - checkNonEmpty
```
protected static > FloatScalar[][] checkNonEmpty(FloatScalar[][] dsArray)
 throws ValueException
```
 Check that a provided array can be used to create some descendant of a FloatMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the FloatScalar array
 
 Parameters:
 
 dsArray - FloatScalar[][]; the provided array
 
 Returns:
 
 FloatScalar[][]; the provided array
 
 Throws:
 
 ValueException - when the array has zero entries
 - initializeDense
```
protected final FloatMatrixDataDense initializeDense(float[][] values)
 throws ValueException
```
 Import the values and convert them into the SI standard unit.
 
 Parameters:
 
 values - float[][]; an array of values
 
 Returns:
 
 FloatMatrixDataDense internal data
 
 Throws:
 
 ValueException - when values is null, or not rectangular
 - initializeDense
```
protected final FloatMatrixDataDense initializeDense(FloatScalar[][] values)
 throws ValueException
```
 Construct the matrix and store the values in the standard SI unit.
 
 Parameters:
 
 values - FloatScalar[][]; a 2D array of values
 
 Returns:
 
 FloatMatrixDataDense internal data
 
 Throws:
 
 ValueException - when values is null, empty, or is not rectangular
 - initializeSparse
```
protected final FloatMatrixDataSparse initializeSparse(float[][] values)
 throws ValueException
```
 Import the values and convert them into the SI standard unit.
 
 Parameters:
 
 values - float[][]; an array of values
 
 Returns:
 
 FloatMatrixDataSparse internal data
 
 Throws:
 
 ValueException - when values is null, or not rectangular
 - initializeSparse
```
protected final FloatMatrixDataSparse initializeSparse(FloatScalar[][] values)
 throws ValueException
```
 Construct the matrix and store the values in the standard SI unit.
 
 Parameters:
 
 values - FloatScalar[][]; a 2D array of values
 
 Returns:
 
 FloatMatrixDataSparse internal data
 
 Throws:
 
 ValueException - when values is null, empty, or is not rectangular
 - mutable
```
public abstract MutableFloatMatrix mutable()
```
 Create a mutable version of this FloatMatrix.
 The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.
 
 Returns:
 
 MutableFloatMatrix; mutable version of this FloatMatrix
 - getValuesSI
```
public final float[][] getValuesSI()
```
 Create a float[][] array filled with the values in the standard SI unit.
 
 Returns:
 
 float[][]; array of values in the standard SI unit
 - getValuesInUnit
```
public final float[][] getValuesInUnit()
```
 Create a float[][] array filled with the values in the original unit.
 
 Returns:
 
 float[][]; the values in the original unit
 - getValuesInUnit
```
public final float[][] getValuesInUnit(U targetUnit)
```
 Create a 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
 - rows
```
public final int rows()
```
 Retrieve the number of rows of the matrix.
 
 Specified by:
 
 rows in interface ReadOnlyFloatMatrixFunctions>
 
 Returns:
 
 int; the number of rows of the matrix
 - columns
```
public final int columns()
```
 Retrieve the number of columns of the matrix.
 
 Specified by:
 
 columns in interface ReadOnlyFloatMatrixFunctions>
 
 Returns:
 
 int; the number of columns of the matrix
 - getSI
```
public final float getSI(int row,
 int column)
 throws ValueException
```
 Retrieve the value stored at a specified row and column in the standard SI unit.
 
 Specified by:
 
 getSI in interface ReadOnlyFloatMatrixFunctions>
 
 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
```
public final float getInUnit(int row,
 int column)
 throws ValueException
```
 Retrieve the value stored at a specified row and column in the original unit.
 
 Specified by:
 
 getInUnit in interface ReadOnlyFloatMatrixFunctions>
 
 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
```
public final 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.
 
 Specified by:
 
 getInUnit in interface ReadOnlyFloatMatrixFunctions>
 
 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())
 - toString
```
public final String toString()
```
 Overrides:
 
 toString in class Object
 - toString
```
public final 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
```
public final 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
```
public final 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
 - checkSize
```
protected final void checkSize(FloatMatrix<?> other)
 throws ValueException
```
 Centralized size equality check.
 
 Parameters:
 
 other - FloatMatrix<?>; other FloatMatrix
 
 Throws:
 
 ValueException - when other is null, or matrices have unequal size
 - checkSize
```
protected final void checkSize(float[][] other)
 throws ValueException
```
 Centralized size equality check.
 
 Parameters:
 
 other - float[][]; array of float
 
 Throws:
 
 ValueException - when matrices have unequal size
 - checkIndex
```
protected final void checkIndex(int row,
 int column)
 throws ValueException
```
 Check that provided row and column indices are valid.
 
 Parameters:
 
 row - int; the row value to check
 
 column - int; the column value to check
 
 Throws:
 
 ValueException - when row or column is invalid
 - safeGet
```
protected final float safeGet(int row,
 int column)
```
 Retrieve a value in matrixSI without checking validity of the indices.
 
 Parameters:
 
 row - int; the row where the value must be retrieved
 
 column - int; the column where the value must be retrieved
 
 Returns:
 
 float; the value stored at the indicated row and column
 - safeSet
```
protected final void safeSet(int row,
 int column,
 float valueSI)
```
 Modify a value in matrixSI without checking validity of the indices.
 
 Parameters:
 
 row - int; the row where the value must be stored
 
 column - int; the column where the value must be stored
 
 valueSI - float; the new value for the entry in matrixSI
 - zSum
```
public final float zSum()
```
 Compute the sum of all values of this matrix.
 
 Specified by:
 
 zSum in interface ReadOnlyFloatMatrixFunctions>
 
 Returns:
 
 float; the sum of all values of this matrix
 - cardinality
```
public final int cardinality()
```
 Count the number of cells that have a non-zero value (ignores tolerance).
 
 Specified by:
 
 cardinality in interface ReadOnlyFloatMatrixFunctions>
 
 Returns:
 
 int; the number of cells having non-zero value
 - determinant
```
public final float determinant()
 throws ValueException
```
 Compute the determinant of the matrix.
 
 Specified by:
 
 determinant in interface ReadOnlyFloatMatrixFunctions>
 
 Returns:
 
 float; the determinant of the matrix
 
 Throws:
 
 ValueException - when matrix is neither sparse, nor dense, or not square
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - equals
```
public boolean equals(Object obj)
```
 Overrides:
 
 equals in class Object
 - plus
```
public static > MutableFloatMatrix.Abs.Dense plus(FloatMatrix.Abs.Dense left,
 FloatMatrix.Rel right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Dense; the left operand
 
 right - FloatMatrix.Rel; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableFloatMatrix.Abs.Dense plus(FloatMatrix.Abs.Sparse left,
 FloatMatrix.Rel.Dense right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse; the left operand
 
 right - FloatMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableFloatMatrix.Abs.Sparse plus(FloatMatrix.Abs.Sparse left,
 FloatMatrix.Rel.Sparse right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse; the left operand
 
 right - FloatMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableFloatMatrix.Rel.Dense plus(FloatMatrix.Rel.Dense left,
 FloatMatrix.Rel right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Dense; the left operand
 
 right - FloatMatrix.Rel; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableFloatMatrix.Rel.Dense plus(FloatMatrix.Rel.Sparse left,
 FloatMatrix.Rel.Dense right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse; the left operand
 
 right - FloatMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableFloatMatrix.Rel.Sparse plus(FloatMatrix.Rel.Sparse left,
 FloatMatrix.Rel.Sparse right)
 throws ValueException
```
 Add two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse; the left operand
 
 right - FloatMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Abs.Dense minus(FloatMatrix.Abs.Dense left,
 FloatMatrix.Rel right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Dense; the left operand
 
 right - FloatMatrix.Rel; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Abs.Dense minus(FloatMatrix.Abs.Sparse left,
 FloatMatrix.Rel.Dense right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse; the left operand
 
 right - FloatMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Abs.Sparse minus(FloatMatrix.Abs.Sparse left,
 FloatMatrix.Rel.Sparse right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse; the left operand
 
 right - FloatMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Rel.Dense minus(FloatMatrix.Rel.Dense left,
 FloatMatrix.Rel right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Dense; the left operand
 
 right - FloatMatrix.Rel; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Rel.Dense minus(FloatMatrix.Rel.Sparse left,
 FloatMatrix.Rel.Dense right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse; the left operand
 
 right - FloatMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableFloatMatrix.Rel.Sparse minus(FloatMatrix.Rel.Sparse left,
 FloatMatrix.Rel.Sparse right)
 throws ValueException
```
 Subtract two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse; the left operand
 
 right - FloatMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Abs.Dense<SIUnit> times(FloatMatrix.Abs.Dense<?> left,
 FloatMatrix.Abs.Dense<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Dense<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Abs.Dense<?>; the left operand
 
 right - FloatMatrix.Abs.Dense<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Abs.Sparse<SIUnit> times(FloatMatrix.Abs.Dense<?> left,
 FloatMatrix.Abs.Sparse<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Abs.Dense<?>; the left operand
 
 right - FloatMatrix.Abs.Sparse<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Abs.Sparse<SIUnit> times(FloatMatrix.Abs.Sparse<?> left,
 FloatMatrix.Abs<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Abs.Sparse<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse<?>; the left operand
 
 right - FloatMatrix.Abs<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Rel.Dense<SIUnit> times(FloatMatrix.Rel.Dense<?> left,
 FloatMatrix.Rel.Dense<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Dense<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Rel.Dense<?>; the left operand
 
 right - FloatMatrix.Rel.Dense<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Rel.Sparse<SIUnit> times(FloatMatrix.Rel.Dense<?> left,
 FloatMatrix.Rel.Sparse<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Rel.Dense<?>; the left operand
 
 right - FloatMatrix.Rel.Sparse<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableFloatMatrix.Rel.Sparse<SIUnit> times(FloatMatrix.Rel.Sparse<?> left,
 FloatMatrix.Rel<?> right)
 throws ValueException
```
 Multiply two FloatMatrices value by value and store the result in a new MutableFloatMatrix.Rel.Sparse<SIUnit>.
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse<?>; the left operand
 
 right - FloatMatrix.Rel<?>; the right operand
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static > MutableFloatMatrix.Abs.Dense times(FloatMatrix.Abs.Dense left,
 float[][] right)
 throws ValueException
```
 Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Dense; the FloatMatrix
 
 right - float[][]; the float array
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the FloatMatrix and the array do not have the same size
 - times
```
public static > MutableFloatMatrix.Abs.Sparse times(FloatMatrix.Abs.Sparse left,
 float[][] right)
 throws ValueException
```
 Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - FloatMatrix.Abs.Sparse; the FloatMatrix
 
 right - float[][]; the float array
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the FloatMatrix and the array do not have the same size
 - times
```
public static > MutableFloatMatrix.Rel.Dense times(FloatMatrix.Rel.Dense left,
 float[][] right)
 throws ValueException
```
 Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Dense; the FloatMatrix
 
 right - float[][]; the float array
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the FloatMatrix and the array do not have the same size
 - times
```
public static > MutableFloatMatrix.Rel.Sparse times(FloatMatrix.Rel.Sparse left,
 float[][] right)
 throws ValueException
```
 Multiply the values in a FloatMatrix and a float array value by value and store the result in a new MutableFloatMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - FloatMatrix.Rel.Sparse; the FloatMatrix
 
 right - float[][]; the float array
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the FloatMatrix and the array do not have the same size
 - denseToSparse
```
public static > MutableFloatMatrix.Abs.Sparse denseToSparse(FloatMatrix.Abs.Dense in)
```
 Create a Sparse version of a Dense FloatMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - FloatMatrix.Abs.Dense; the Dense FloatMatrix
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse
 - denseToSparse
```
public static > MutableFloatMatrix.Rel.Sparse denseToSparse(FloatMatrix.Rel.Dense in)
```
 Create a Sparse version of a Dense FloatMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - FloatMatrix.Rel.Dense; the Dense FloatMatrix
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse
 - sparseToDense
```
public static > MutableFloatMatrix.Abs.Dense sparseToDense(FloatMatrix.Abs.Sparse in)
```
 Create a Dense version of a Sparse FloatMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - FloatMatrix.Abs.Sparse; the Sparse FloatMatrix
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 - sparseToDense
```
public static > MutableFloatMatrix.Rel.Dense sparseToDense(FloatMatrix.Rel.Sparse in)
```
 Create a Dense version of a Sparse FloatMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - FloatMatrix.Rel.Sparse; the Sparse FloatMatrix
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 - interpolate
```
public static > MutableFloatMatrix.Abs.Dense interpolate(FloatMatrix.Abs.Dense zero,
 FloatMatrix.Abs.Dense one,
 float ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatMatrix.Abs.Dense; zero reference (returned when ratio == 0)
 
 one - FloatMatrix.Abs.Dense; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableFloatMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableFloatMatrix.Rel.Dense interpolate(FloatMatrix.Rel.Dense zero,
 FloatMatrix.Rel.Dense one,
 float ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatMatrix.Rel.Dense; zero reference (returned when ratio == 0)
 
 one - FloatMatrix.Rel.Dense; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableFloatMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableFloatMatrix.Abs.Sparse interpolate(FloatMatrix.Abs.Sparse zero,
 FloatMatrix.Abs.Sparse one,
 float ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatMatrix.Abs.Sparse; zero reference (returned when ratio == 0)
 
 one - FloatMatrix.Abs.Sparse; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableFloatMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableFloatMatrix.Rel.Sparse interpolate(FloatMatrix.Rel.Sparse zero,
 FloatMatrix.Rel.Sparse one,
 float ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatMatrix.Rel.Sparse; zero reference (returned when ratio == 0)
 
 one - FloatMatrix.Rel.Sparse; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableFloatMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when zero and one do not have the same size

Class FloatMatrix<U extends Unit<U>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.AbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vfloat.matrix.ReadOnlyFloatMatrixFunctions

Field Detail

data

Constructor Detail

FloatMatrix

Method Detail

getData

checkNonEmpty

initializeDense

initializeDense

initializeSparse

initializeSparse

mutable

getValuesSI

getValuesInUnit

getValuesInUnit

rows

columns

getSI

getInUnit

getInUnit

toString

toString

toString

toString

checkSize

checkSize

checkIndex

safeGet

safeSet

zSum

cardinality

determinant

hashCode

equals

plus

plus

plus

plus

plus

plus

minus

minus

minus

minus

minus

minus

times

times

times

times

times

times

times

times

times

times

denseToSparse

denseToSparse

sparseToDense

sparseToDense

interpolate

interpolate

interpolate

interpolate