DoubleMatrix (DJUNITS 1.02.01 API)

java.lang.Object
- org.djunits.value.AbstractValue
- - org.djunits.value.vdouble.matrix.DoubleMatrix

Type Parameters:

U - Unit; the unit of this DoubleMatrix

All Implemented Interfaces:

Serializable, Value, ReadOnlyDoubleMatrixFunctions

Direct Known Subclasses:

DoubleMatrix.Abs, DoubleMatrix.Rel, MutableDoubleMatrix
```
public abstract class DoubleMatrix>
extends AbstractValue
implements Serializable, ReadOnlyDoubleMatrixFunctions
```
Immutable DoubleMatrix.
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 11:49:36 +0200 (Wed, 07 Oct 2015) $, @version $Revision: 92 $, 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 DoubleMatrix.Abs>

static class DoubleMatrix.Rel>

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

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Modifier Constructor and Description

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

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

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>> DoubleScalar<U>[][]`	`checkNonEmpty(DoubleScalar<U>[][] dsArray)` Check that a provided array can be used to create some descendant of a DoubleMatrix.
`protected void`	`checkSize(double[][] other)` Centralized size equality check.
`protected void`	`checkSize(DoubleMatrix<?> other)` Centralized size equality check.
`int`	`columns()` Retrieve the number of columns of the matrix.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Sparse<U>`	`denseToSparse(DoubleMatrix.Abs.Dense<U> in)` Create a Sparse version of a Dense DoubleMatrix.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Sparse<U>`	`denseToSparse(DoubleMatrix.Rel.Dense<U> in)` Create a Sparse version of a Dense DoubleMatrix.
`double`	`determinant()` Compute the determinant of the matrix.
`boolean`	`equals(Object obj)`
`protected abstract org.djunits.value.vdouble.matrix.DoubleMatrixData`	`getData()`
`double`	`getInUnit(int row, int column)` Retrieve the value stored at a specified row and column in the original unit.
`double`	`getInUnit(int row, int column, U targetUnit)` Retrieve the value stored at a specified row and column converted into a specified unit.
`double`	`getSI(int row, int column)` Retrieve the value stored at a specified row and column in the standard SI unit.
`double[][]`	`getValuesInUnit()` Create a double[][] array filled with the values in the original unit.
`double[][]`	`getValuesInUnit(U targetUnit)` Create a double[][] array filled with the values converted into a specified unit.
`double[][]`	`getValuesSI()` Create a double[][] array filled with the values in the standard SI unit.
`int`	`hashCode()`
`protected DoubleMatrixDataDense`	`initializeDense(double[][] values)` Import the values and convert them into the SI standard unit.
`protected DoubleMatrixDataDense`	`initializeDense(DoubleScalar<U>[][] values)` Construct the matrix and store the values in the standard SI unit.
`protected DoubleMatrixDataSparse`	`initializeSparse(double[][] values)` Import the values and convert them into the SI standard unit.
`protected DoubleMatrixDataSparse`	`initializeSparse(DoubleScalar<U>[][] values)` Construct the matrix and store the values in the standard SI unit.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`interpolate(DoubleMatrix.Abs.Dense<U> zero, DoubleMatrix.Abs.Dense<U> one, double ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Sparse<U>`	`interpolate(DoubleMatrix.Abs.Sparse<U> zero, DoubleMatrix.Abs.Sparse<U> one, double ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`interpolate(DoubleMatrix.Rel.Dense<U> zero, DoubleMatrix.Rel.Dense<U> one, double ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Sparse<U>`	`interpolate(DoubleMatrix.Rel.Sparse<U> zero, DoubleMatrix.Rel.Sparse<U> one, double ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`minus(DoubleMatrix.Abs.Dense<U> left, DoubleMatrix.Rel<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`minus(DoubleMatrix.Abs.Sparse<U> left, DoubleMatrix.Rel.Dense<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Sparse<U>`	`minus(DoubleMatrix.Abs.Sparse<U> left, DoubleMatrix.Rel.Sparse<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`minus(DoubleMatrix.Rel.Dense<U> left, DoubleMatrix.Rel<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`minus(DoubleMatrix.Rel.Sparse<U> left, DoubleMatrix.Rel.Dense<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Sparse<U>`	`minus(DoubleMatrix.Rel.Sparse<U> left, DoubleMatrix.Rel.Sparse<U> right)` Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<U>.
`abstract MutableDoubleMatrix<U>`	`mutable()` Create a mutable version of this DoubleMatrix.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`plus(DoubleMatrix.Abs.Dense<U> left, DoubleMatrix.Rel<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`plus(DoubleMatrix.Abs.Sparse<U> left, DoubleMatrix.Rel.Dense<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Sparse<U>`	`plus(DoubleMatrix.Abs.Sparse<U> left, DoubleMatrix.Rel.Sparse<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`plus(DoubleMatrix.Rel.Dense<U> left, DoubleMatrix.Rel<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`plus(DoubleMatrix.Rel.Sparse<U> left, DoubleMatrix.Rel.Dense<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<U>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Sparse<U>`	`plus(DoubleMatrix.Rel.Sparse<U> left, DoubleMatrix.Rel.Sparse<U> right)` Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<U>.
`int`	`rows()` Retrieve the number of rows of the matrix.
`protected double`	`safeGet(int row, int column)` Retrieve a value in matrixSI without checking validity of the indices.
`protected void`	`safeSet(int row, int column, double valueSI)` Modify a value in matrixSI without checking validity of the indices.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`sparseToDense(DoubleMatrix.Abs.Sparse<U> in)` Create a Dense version of a Sparse DoubleMatrix.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`sparseToDense(DoubleMatrix.Rel.Sparse<U> in)` Create a Dense version of a Sparse DoubleMatrix.
`static MutableDoubleMatrix.Abs.Dense<SIUnit>`	`times(DoubleMatrix.Abs.Dense<?> left, DoubleMatrix.Abs.Dense<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<SIUnit>.
`static MutableDoubleMatrix.Abs.Sparse<SIUnit>`	`times(DoubleMatrix.Abs.Dense<?> left, DoubleMatrix.Abs.Sparse<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Dense<U>`	`times(DoubleMatrix.Abs.Dense<U> left, double[][] right)` Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<U>.
`static MutableDoubleMatrix.Abs.Sparse<SIUnit>`	`times(DoubleMatrix.Abs.Sparse<?> left, DoubleMatrix.Abs<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableDoubleMatrix.Abs.Sparse<U>`	`times(DoubleMatrix.Abs.Sparse<U> left, double[][] right)` Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<U>.
`static MutableDoubleMatrix.Rel.Dense<SIUnit>`	`times(DoubleMatrix.Rel.Dense<?> left, DoubleMatrix.Rel.Dense<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<SIUnit>.
`static MutableDoubleMatrix.Rel.Sparse<SIUnit>`	`times(DoubleMatrix.Rel.Dense<?> left, DoubleMatrix.Rel.Sparse<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Dense<U>`	`times(DoubleMatrix.Rel.Dense<U> left, double[][] right)` Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<U>.
`static MutableDoubleMatrix.Rel.Sparse<SIUnit>`	`times(DoubleMatrix.Rel.Sparse<?> left, DoubleMatrix.Rel<?> right)` Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<SIUnit>.
`static <U extends Unit<U>> MutableDoubleMatrix.Rel.Sparse<U>`	`times(DoubleMatrix.Rel.Sparse<U> left, double[][] right)` Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<U>.
`String`	`toString()`
`String`	`toString(boolean verbose, boolean withUnit)` Print this DoubleMatrix with optional type and unit information.
`String`	`toString(U displayUnit)` Print this DoubleMatrix with the values expressed in the specified unit.
`String`	`toString(U displayUnit, boolean verbose, boolean withUnit)` Print this DoubleMatrix with the values expressed in the specified unit.
`double`	`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.vdouble.matrix.ReadOnlyDoubleMatrixFunctions
get

- Field Detail
 - data
```
protected org.djunits.value.vdouble.matrix.DoubleMatrixData data
```
 The stored data as an object, can be sparse or dense.
- Constructor Detail
 - DoubleMatrix
```
protected DoubleMatrix(U unit)
```
 Construct a new Immutable DoubleMatrix.
 
 Parameters:
 
 unit - U; the unit of the new DoubleMatrix
- Method Detail
 - getData
```
protected abstract org.djunits.value.vdouble.matrix.DoubleMatrixData getData()
```
 Returns:
 
 the data, as Dense or Sparse data.
 - checkNonEmpty
```
protected static > DoubleScalar[][] checkNonEmpty(DoubleScalar[][] dsArray)
 throws ValueException
```
 Check that a provided array can be used to create some descendant of a DoubleMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the DoubleScalar array
 
 Parameters:
 
 dsArray - DoubleScalar[][]; the provided array
 
 Returns:
 
 DoubleScalar[][]; the provided array
 
 Throws:
 
 ValueException - when the array has zero entries
 - initializeDense
```
protected final DoubleMatrixDataDense initializeDense(double[][] values)
 throws ValueException
```
 Import the values and convert them into the SI standard unit.
 
 Parameters:
 
 values - double[][]; an array of values
 
 Returns:
 
 DoubleMatrixDataDense internal data
 
 Throws:
 
 ValueException - when values is null, or not rectangular
 - initializeDense
```
protected final DoubleMatrixDataDense initializeDense(DoubleScalar[][] values)
 throws ValueException
```
 Construct the matrix and store the values in the standard SI unit.
 
 Parameters:
 
 values - DoubleScalar[][]; a 2D array of values
 
 Returns:
 
 DoubleMatrixDataDense internal data
 
 Throws:
 
 ValueException - when values is null, empty, or is not rectangular
 - initializeSparse
```
protected final DoubleMatrixDataSparse initializeSparse(double[][] values)
 throws ValueException
```
 Import the values and convert them into the SI standard unit.
 
 Parameters:
 
 values - double[][]; an array of values
 
 Returns:
 
 DoubleMatrixDataSparse internal data
 
 Throws:
 
 ValueException - when values is null, or not rectangular
 - initializeSparse
```
protected final DoubleMatrixDataSparse initializeSparse(DoubleScalar[][] values)
 throws ValueException
```
 Construct the matrix and store the values in the standard SI unit.
 
 Parameters:
 
 values - DoubleScalar[][]; a 2D array of values
 
 Returns:
 
 DoubleMatrixDataSparse internal data
 
 Throws:
 
 ValueException - when values is null, empty, or is not rectangular
 - mutable
```
public abstract MutableDoubleMatrix mutable()
```
 Create a mutable version of this DoubleMatrix.
 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:
 
 MutableDoubleMatrix; mutable version of this DoubleMatrix
 - getValuesSI
```
public final double[][] getValuesSI()
```
 Create a double[][] array filled with the values in the standard SI unit.
 
 Returns:
 
 double[][]; array of values in the standard SI unit
 - getValuesInUnit
```
public final double[][] getValuesInUnit()
```
 Create a double[][] array filled with the values in the original unit.
 
 Returns:
 
 double[][]; the values in the original unit
 - getValuesInUnit
```
public final double[][] getValuesInUnit(U targetUnit)
```
 Create a double[][] array filled with the values converted into a specified unit.
 
 Parameters:
 
 targetUnit - U; the unit into which the values are converted for use
 
 Returns:
 
 double[][]; 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 ReadOnlyDoubleMatrixFunctions>
 
 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 ReadOnlyDoubleMatrixFunctions>
 
 Returns:
 
 int; the number of columns of the matrix
 - getSI
```
public final double 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 ReadOnlyDoubleMatrixFunctions>
 
 Parameters:
 
 row - int; row of the value to retrieve
 
 column - int; column of the value to retrieve
 
 Returns:
 
 double; 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 double 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 ReadOnlyDoubleMatrixFunctions>
 
 Parameters:
 
 row - int; row of the value to retrieve
 
 column - int; column of the value to retrieve
 
 Returns:
 
 double; 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 double 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 ReadOnlyDoubleMatrixFunctions>
 
 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:
 
 double; 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 DoubleMatrix 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 DoubleMatrix 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 DoubleMatrix 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(DoubleMatrix<?> other)
 throws ValueException
```
 Centralized size equality check.
 
 Parameters:
 
 other - DoubleMatrix<?>; other DoubleMatrix
 
 Throws:
 
 ValueException - when other is null, or matrices have unequal size
 - checkSize
```
protected final void checkSize(double[][] other)
 throws ValueException
```
 Centralized size equality check.
 
 Parameters:
 
 other - double[][]; array of double
 
 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 double 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:
 
 double; the value stored at the indicated row and column
 - safeSet
```
protected final void safeSet(int row,
 int column,
 double 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 - double; the new value for the entry in matrixSI
 - zSum
```
public final double zSum()
```
 Compute the sum of all values of this matrix.
 
 Specified by:
 
 zSum in interface ReadOnlyDoubleMatrixFunctions>
 
 Returns:
 
 double; 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 ReadOnlyDoubleMatrixFunctions>
 
 Returns:
 
 int; the number of cells having non-zero value
 - determinant
```
public final double determinant()
 throws ValueException
```
 Compute the determinant of the matrix.
 
 Specified by:
 
 determinant in interface ReadOnlyDoubleMatrixFunctions>
 
 Returns:
 
 double; 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 > MutableDoubleMatrix.Abs.Dense plus(DoubleMatrix.Abs.Dense left,
 DoubleMatrix.Rel right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Dense; the left operand
 
 right - DoubleMatrix.Rel; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableDoubleMatrix.Abs.Dense plus(DoubleMatrix.Abs.Sparse left,
 DoubleMatrix.Rel.Dense right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableDoubleMatrix.Abs.Sparse plus(DoubleMatrix.Abs.Sparse left,
 DoubleMatrix.Rel.Sparse right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableDoubleMatrix.Rel.Dense plus(DoubleMatrix.Rel.Dense left,
 DoubleMatrix.Rel right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Dense; the left operand
 
 right - DoubleMatrix.Rel; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableDoubleMatrix.Rel.Dense plus(DoubleMatrix.Rel.Sparse left,
 DoubleMatrix.Rel.Dense right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - plus
```
public static > MutableDoubleMatrix.Rel.Sparse plus(DoubleMatrix.Rel.Sparse left,
 DoubleMatrix.Rel.Sparse right)
 throws ValueException
```
 Add two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Abs.Dense minus(DoubleMatrix.Abs.Dense left,
 DoubleMatrix.Rel right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Dense; the left operand
 
 right - DoubleMatrix.Rel; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Abs.Dense minus(DoubleMatrix.Abs.Sparse left,
 DoubleMatrix.Rel.Dense right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Abs.Sparse minus(DoubleMatrix.Abs.Sparse left,
 DoubleMatrix.Rel.Sparse right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Rel.Dense minus(DoubleMatrix.Rel.Dense left,
 DoubleMatrix.Rel right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Dense; the left operand
 
 right - DoubleMatrix.Rel; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Rel.Dense minus(DoubleMatrix.Rel.Sparse left,
 DoubleMatrix.Rel.Dense right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Dense; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - minus
```
public static > MutableDoubleMatrix.Rel.Sparse minus(DoubleMatrix.Rel.Sparse left,
 DoubleMatrix.Rel.Sparse right)
 throws ValueException
```
 Subtract two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse; the left operand
 
 right - DoubleMatrix.Rel.Sparse; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Abs.Dense<SIUnit> times(DoubleMatrix.Abs.Dense<?> left,
 DoubleMatrix.Abs.Dense<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Dense<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Abs.Dense<?>; the left operand
 
 right - DoubleMatrix.Abs.Dense<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Abs.Sparse<SIUnit> times(DoubleMatrix.Abs.Dense<?> left,
 DoubleMatrix.Abs.Sparse<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Abs.Dense<?>; the left operand
 
 right - DoubleMatrix.Abs.Sparse<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Abs.Sparse<SIUnit> times(DoubleMatrix.Abs.Sparse<?> left,
 DoubleMatrix.Abs<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse<?>; the left operand
 
 right - DoubleMatrix.Abs<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Rel.Dense<SIUnit> times(DoubleMatrix.Rel.Dense<?> left,
 DoubleMatrix.Rel.Dense<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Dense<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Rel.Dense<?>; the left operand
 
 right - DoubleMatrix.Rel.Dense<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Rel.Sparse<SIUnit> times(DoubleMatrix.Rel.Dense<?> left,
 DoubleMatrix.Rel.Sparse<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Rel.Dense<?>; the left operand
 
 right - DoubleMatrix.Rel.Sparse<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static MutableDoubleMatrix.Rel.Sparse<SIUnit> times(DoubleMatrix.Rel.Sparse<?> left,
 DoubleMatrix.Rel<?> right)
 throws ValueException
```
 Multiply two DoubleMatrices value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse<SIUnit>.
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse<?>; the left operand
 
 right - DoubleMatrix.Rel<?>; the right operand
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse<SIUnit>
 
 Throws:
 
 ValueException - when the matrices do not have the same size
 - times
```
public static > MutableDoubleMatrix.Abs.Dense times(DoubleMatrix.Abs.Dense left,
 double[][] right)
 throws ValueException
```
 Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Abs.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Dense; the DoubleMatrix
 
 right - double[][]; the double array
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when the DoubleMatrix and the array do not have the same size
 - times
```
public static > MutableDoubleMatrix.Abs.Sparse times(DoubleMatrix.Abs.Sparse left,
 double[][] right)
 throws ValueException
```
 Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Abs.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - DoubleMatrix.Abs.Sparse; the DoubleMatrix
 
 right - double[][]; the double array
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when the DoubleMatrix and the array do not have the same size
 - times
```
public static > MutableDoubleMatrix.Rel.Dense times(DoubleMatrix.Rel.Dense left,
 double[][] right)
 throws ValueException
```
 Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Rel.Dense.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Dense; the DoubleMatrix
 
 right - double[][]; the double array
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when the DoubleMatrix and the array do not have the same size
 - times
```
public static > MutableDoubleMatrix.Rel.Sparse times(DoubleMatrix.Rel.Sparse left,
 double[][] right)
 throws ValueException
```
 Multiply the values in a DoubleMatrix and a double array value by value and store the result in a new MutableDoubleMatrix.Rel.Sparse.
 
 Type Parameters:
 
 U - Unit; the unit of the left parameter and the result
 
 Parameters:
 
 left - DoubleMatrix.Rel.Sparse; the DoubleMatrix
 
 right - double[][]; the double array
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when the DoubleMatrix and the array do not have the same size
 - denseToSparse
```
public static > MutableDoubleMatrix.Abs.Sparse denseToSparse(DoubleMatrix.Abs.Dense in)
```
 Create a Sparse version of a Dense DoubleMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - DoubleMatrix.Abs.Dense; the Dense DoubleMatrix
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse
 - denseToSparse
```
public static > MutableDoubleMatrix.Rel.Sparse denseToSparse(DoubleMatrix.Rel.Dense in)
```
 Create a Sparse version of a Dense DoubleMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - DoubleMatrix.Rel.Dense; the Dense DoubleMatrix
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse
 - sparseToDense
```
public static > MutableDoubleMatrix.Abs.Dense sparseToDense(DoubleMatrix.Abs.Sparse in)
```
 Create a Dense version of a Sparse DoubleMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - DoubleMatrix.Abs.Sparse; the Sparse DoubleMatrix
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 - sparseToDense
```
public static > MutableDoubleMatrix.Rel.Dense sparseToDense(DoubleMatrix.Rel.Sparse in)
```
 Create a Dense version of a Sparse DoubleMatrix.
 
 Type Parameters:
 
 U - Unit; the unit of the parameter and the result
 
 Parameters:
 
 in - DoubleMatrix.Rel.Sparse; the Sparse DoubleMatrix
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 - interpolate
```
public static > MutableDoubleMatrix.Abs.Dense interpolate(DoubleMatrix.Abs.Dense zero,
 DoubleMatrix.Abs.Dense one,
 double ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - DoubleMatrix.Abs.Dense; zero reference (returned when ratio == 0)
 
 one - DoubleMatrix.Abs.Dense; one reference (returned when ratio == 1)
 
 ratio - double; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableDoubleMatrix.Abs.Dense
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableDoubleMatrix.Rel.Dense interpolate(DoubleMatrix.Rel.Dense zero,
 DoubleMatrix.Rel.Dense one,
 double ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - DoubleMatrix.Rel.Dense; zero reference (returned when ratio == 0)
 
 one - DoubleMatrix.Rel.Dense; one reference (returned when ratio == 1)
 
 ratio - double; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableDoubleMatrix.Rel.Dense
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableDoubleMatrix.Abs.Sparse interpolate(DoubleMatrix.Abs.Sparse zero,
 DoubleMatrix.Abs.Sparse one,
 double ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - DoubleMatrix.Abs.Sparse; zero reference (returned when ratio == 0)
 
 one - DoubleMatrix.Abs.Sparse; one reference (returned when ratio == 1)
 
 ratio - double; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableDoubleMatrix.Abs.Sparse
 
 Throws:
 
 ValueException - when zero and one do not have the same size
 - interpolate
```
public static > MutableDoubleMatrix.Rel.Sparse interpolate(DoubleMatrix.Rel.Sparse zero,
 DoubleMatrix.Rel.Sparse one,
 double ratio)
 throws ValueException
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - DoubleMatrix.Rel.Sparse; zero reference (returned when ratio == 0)
 
 one - DoubleMatrix.Rel.Sparse; one reference (returned when ratio == 1)
 
 ratio - double; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 MutableDoubleMatrix.Rel.Sparse
 
 Throws:
 
 ValueException - when zero and one do not have the same size

Class DoubleMatrix<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.vdouble.matrix.ReadOnlyDoubleMatrixFunctions

Field Detail

data

Constructor Detail

DoubleMatrix

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