AbstractDoubleMatrix (DJUNITS 3.01.02 API)

java.lang.Object
- org.djunits.value.AbstractValue
- - org.djunits.value.vdouble.matrix.AbstractDoubleMatrix<U,T>

Type Parameters:

U - the unit

T - the type

All Implemented Interfaces:

Serializable, Value, DoubleMatrixInterface

Direct Known Subclasses:

AbstractDoubleMatrixAbs, AbstractDoubleMatrixRel
```
public abstract class AbstractDoubleMatrix,T extends AbstractDoubleMatrix<U,T>>
extends AbstractValue
implements DoubleMatrixInterface
```
The most basic abstract class for the DoubleMatrix.
Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 16, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected DoubleMatrixData data
The stored data as an object, can be sparse or dense.

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

Constructor Summary

Constructors
Constructor and Description

AbstractDoubleMatrix(U unit, DoubleMatrixData data)
Construct a new DoubleMatrix.

Constructors
Constructor and Description
`AbstractDoubleMatrix(U unit, DoubleMatrixData data)` Construct a new DoubleMatrix.

Method Summary

All Methods Static Methods Instance 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 void`	`checkSize(AbstractDoubleMatrixRel<?,?,?,?> other)` Centralized size equality check.
`protected void`	`checkSize(double[][] other)` Centralized size equality check.
`int`	`columns()` Retrieve the number of columns of the matrix.
`double`	`determinant()` Compute the determinant of the matrix.
`protected static double[][]`	`ensureRectangularAndNonEmpty(double[][] values)` Check that a 2D array of double is not null and rectangular; i.e.
`boolean`	`equals(Object obj)`
`protected 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.
`StorageType`	`getStorageType()` Return the StorageType (DENSE, SPARSE, etc.) for the stored Matrix.
`double[][]`	`getValuesInUnit()` Create a dense double[][] array filled with the values in the original unit.
`double[][]`	`getValuesInUnit(U targetUnit)` Create a dense double[][] array filled with the values converted into a specified unit.
`double[][]`	`getValuesSI()` Create a dense double[][] array filled with the values in the standard SI unit.
`int`	`hashCode()`
`int`	`rows()` Retrieve the number of rows of the matrix.
`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, setDisplayUnit

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

Methods inherited from interface org.djunits.value.vdouble.matrix.DoubleMatrixInterface
get, toDense, toSparse

- Field Detail
 - data
```
protected DoubleMatrixData data
```
 The stored data as an object, can be sparse or dense.
- Constructor Detail
 - AbstractDoubleMatrix
```
AbstractDoubleMatrix(U unit,
 DoubleMatrixData data)
```
 Construct a new DoubleMatrix.
 
 Parameters:
 
 unit - U; the unit
 
 data - DoubleMatrixData; an internal data object
- Method Detail
 - getData
```
protected final DoubleMatrixData getData()
```
 Returns:
 
 the internal data -- can only be used within package and by subclasses.
 - getStorageType
```
public final StorageType getStorageType()
```
 Return the StorageType (DENSE, SPARSE, etc.) for the stored Matrix.
 
 Returns:
 
 the StorageType (DENSE, SPARSE, etc.) for the stored Matrix
 - getValuesSI
```
public final double[][] getValuesSI()
```
 Create a dense double[][] array filled with the values in the standard SI unit.
 
 Specified by:
 
 getValuesSI in interface DoubleMatrixInterface>
 
 Returns:
 
 double[][]; array of values in the standard SI unit
 - getValuesInUnit
```
public final double[][] getValuesInUnit()
```
 Create a dense double[][] array filled with the values in the original unit.
 
 Specified by:
 
 getValuesInUnit in interface DoubleMatrixInterface>
 
 Returns:
 
 double[][]; the values in the original unit
 - getValuesInUnit
```
public final double[][] getValuesInUnit(U targetUnit)
```
 Create a dense double[][] array filled with the values converted into a specified unit.
 
 Specified by:
 
 getValuesInUnit in interface DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 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())
 - zSum
```
public final double zSum()
```
 Compute the sum of all values of this matrix.
 
 Specified by:
 
 zSum in interface DoubleMatrixInterface>
 
 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 DoubleMatrixInterface>
 
 Returns:
 
 int; the number of cells having non-zero value
 - toString
```
public final String toString()
```
 Specified by:
 
 toString in interface DoubleMatrixInterface>
 
 Overrides:
 
 toString in class Object
 
 Returns:
 
 a String with the Matrix, non-verbose, with the unit attached.
 - toString
```
public final String toString(U displayUnit)
```
 Print this DoubleMatrix with the values expressed in the specified unit.
 
 Specified by:
 
 toString in interface DoubleMatrixInterface>
 
 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.
 
 Specified by:
 
 toString in interface DoubleMatrixInterface>
 
 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.
 
 Specified by:
 
 toString in interface DoubleMatrixInterface>
 
 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(AbstractDoubleMatrixRel<?,?,?,?> other)
 throws ValueException
```
 Centralized size equality check.
 
 Parameters:
 
 other - AbstractDoubleMatrixRel<?, ?, ?, ?>; other DoubleMatrix
 
 Throws:
 
 ValueException - when other is null, or matrices have unequal size
 - ensureRectangularAndNonEmpty
```
protected static double[][] ensureRectangularAndNonEmpty(double[][] values)
 throws ValueException
```
 Check that a 2D array of double is not null and rectangular; i.e. all rows have the same length.
 
 Parameters:
 
 values - double[][]; the 2D array to check
 
 Returns:
 
 the values in case the method is used in a constructor
 
 Throws:
 
 ValueException - when not all rows have the same length
 - 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
 - determinant
```
public final double determinant()
 throws ValueException
```
 Compute the determinant of the matrix.
 
 Specified by:
 
 determinant in interface DoubleMatrixInterface>
 
 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

Class AbstractDoubleMatrix<U extends Unit<U>,T extends AbstractDoubleMatrix<U,T>>

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.DoubleMatrixInterface

Field Detail

data

Constructor Detail

AbstractDoubleMatrix

Method Detail

getData

getStorageType

getValuesSI

getValuesInUnit

getValuesInUnit

rows

columns

getSI

getInUnit

getInUnit

zSum

cardinality

toString

toString

toString

toString

checkSize

ensureRectangularAndNonEmpty

checkSize

checkIndex

determinant

hashCode

equals