org.djunits.value.vdouble.matrix

Class DoubleMatrix<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.matrix.DoubleMatrix<U>

Type Parameters:

U - Unit; the unit of this DoubleMatrix

All Implemented Interfaces:

Serializable, Value<U>, DoubleMatrixInterface<U>

Direct Known Subclasses:

DoubleMatrix.Abs, DoubleMatrix.Rel, MutableDoubleMatrix

public abstract class DoubleMatrix<U extends Unit<U>>
extends AbstractValue<U>
implements Serializable, DoubleMatrixInterface<U>

Immutable DoubleMatrix.

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

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

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, 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<U extends Unit<U>> ABSOLUTE implementation of DoubleMatrix.
static class	DoubleMatrix.Rel<U extends Unit<U>> RELATIVE implementation of DoubleMatrix.

Field Summary

Fields

Modifier and Type	Field and Description
protected 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.

Method Summary

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(double[][] other) Centralized size equality check.
protected void	checkSize(DoubleMatrix<?> other) Centralized size equality check.
(package private) static <U extends Unit<U>> U	checkUnit(DoubleScalar<U>[][] dsArray) Check that a provided array can be used to create some descendant of a DoubleMatrix, and return the Unit.
int	columns() Retrieve the number of columns of the matrix.
double	determinant() Compute the determinant of the matrix.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	divide(DoubleMatrix.Rel<U> left, DoubleMatrix.Rel<U> right) Divide the content of two matrices with a static method on a cell-by-cell basis; Rel / Rel = Rel.
protected static void	ensureRectangularAndNonEmpty(double[][] values) Check that a 2D array of double is not null and rectangular; i.e.
protected static void	ensureRectangularAndNonEmpty(DoubleScalar<?>[][] values) Check that a 2D array of DoubleScalar<?> is 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 Vector.
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()
(package private) static <U extends Unit<U>> DoubleMatrix.Abs<U>	instantiateAbs(DoubleMatrixData dmData, U unit) Instantiate a vector based on the type of data.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	instantiateRel(DoubleMatrixData dmData, U unit) Instantiate a vector based on the type of data.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	minus(DoubleMatrix.Abs<U> left, DoubleMatrix.Abs<U> right) Subtract the content of two matrices with a static method on a cell-by-cell basis; Abs - Abs = Rel.
(package private) static <U extends Unit<U>> DoubleMatrix.Abs<U>	minus(DoubleMatrix.Abs<U> left, DoubleMatrix.Rel<U> right) Subtract the content of two matrices with a static method on a cell-by-cell basis; Abs - Rel = Abs.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	minus(DoubleMatrix.Rel<U> left, DoubleMatrix.Rel<U> right) Subtract the content of two matrices with a static method on a cell-by-cell basis; Rel - Rel = Rel.
(package private) static <U extends Unit<U>> DoubleMatrix.Abs<U>	plus(DoubleMatrix.Abs<U> left, DoubleMatrix.Rel<U> right) Add the content of two matrices with a static method on a cell-by-cell basis; Abs + Rel = Abs.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	plus(DoubleMatrix.Rel<U> left, DoubleMatrix.Rel<U> right) Add the content of two matrices with a static method on a cell-by-cell basis; Rel + Rel = Rel.
int	rows() Retrieve the number of rows of the matrix.
(package private) static <U extends Unit<U>> DoubleMatrix.Rel<U>	times(DoubleMatrix.Rel<U> left, DoubleMatrix.Rel<U> right) Multiply the content of two matrices with a static method on a cell-by-cell basis; Rel * Rel = Rel.
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.DoubleMatrixInterface

get, mutable, toDense, toSparse

Field Detail

data

protected 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 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 Vector.

Returns:

the StorageType (DENSE, SPARSE, etc.) for the stored Vector

checkUnit

static <U extends Unit<U>> U checkUnit(DoubleScalar<U>[][] dsArray)
                                throws ValueException

Check that a provided array can be used to create some descendant of a DoubleMatrix, and return the Unit.

Type Parameters:

U - the unit

Parameters:

dsArray - the array to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array is null, has length equal to 0, or has first entry with length equal to 0

ensureRectangularAndNonEmpty

protected static void 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

Throws:

ValueException - when not all rows have the same length

ensureRectangularAndNonEmpty

protected static void ensureRectangularAndNonEmpty(DoubleScalar<?>[][] values)
                                            throws ValueException

Check that a 2D array of DoubleScalar<?> is rectangular; i.e. all rows have the same length and is non empty.

Parameters:

values - DoubleScalar<?>[][]; the 2D array to check

Throws:

ValueException - when values is not rectangular, or contains no data

instantiateRel

static <U extends Unit<U>> DoubleMatrix.Rel<U> instantiateRel(DoubleMatrixData dmData,
                                                              U unit)

Instantiate a vector based on the type of data.

Type Parameters:

U - the unit

Parameters:

dmData - the DoubleMatrixData

unit - the unit to use

Returns:

an instantiated vector

instantiateAbs

static <U extends Unit<U>> DoubleMatrix.Abs<U> instantiateAbs(DoubleMatrixData dmData,
                                                              U unit)

Instantiate a vector based on the type of data.

Type Parameters:

U - the unit

Parameters:

dmData - the DoubleMatrixData

unit - the unit to use

Returns:

an instantiated vector

plus

static <U extends Unit<U>> DoubleMatrix.Abs<U> plus(DoubleMatrix.Abs<U> left,
                                                    DoubleMatrix.Rel<U> right)
                                             throws ValueException

Add the content of two matrices with a static method on a cell-by-cell basis; Abs + Rel = Abs.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the sum of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

plus

static <U extends Unit<U>> DoubleMatrix.Rel<U> plus(DoubleMatrix.Rel<U> left,
                                                    DoubleMatrix.Rel<U> right)
                                             throws ValueException

Add the content of two matrices with a static method on a cell-by-cell basis; Rel + Rel = Rel.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the sum of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

minus

static <U extends Unit<U>> DoubleMatrix.Abs<U> minus(DoubleMatrix.Abs<U> left,
                                                     DoubleMatrix.Rel<U> right)
                                              throws ValueException

Subtract the content of two matrices with a static method on a cell-by-cell basis; Abs - Rel = Abs.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the difference of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

minus

static <U extends Unit<U>> DoubleMatrix.Rel<U> minus(DoubleMatrix.Abs<U> left,
                                                     DoubleMatrix.Abs<U> right)
                                              throws ValueException

Subtract the content of two matrices with a static method on a cell-by-cell basis; Abs - Abs = Rel.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the difference of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

minus

static <U extends Unit<U>> DoubleMatrix.Rel<U> minus(DoubleMatrix.Rel<U> left,
                                                     DoubleMatrix.Rel<U> right)
                                              throws ValueException

Subtract the content of two matrices with a static method on a cell-by-cell basis; Rel - Rel = Rel.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the difference of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

times

static <U extends Unit<U>> DoubleMatrix.Rel<U> times(DoubleMatrix.Rel<U> left,
                                                     DoubleMatrix.Rel<U> right)
                                              throws ValueException

Multiply the content of two matrices with a static method on a cell-by-cell basis; Rel * Rel = Rel. The unit is not changed by this method.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the cell-by-cell multiplication of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

divide

static <U extends Unit<U>> DoubleMatrix.Rel<U> divide(DoubleMatrix.Rel<U> left,
                                                      DoubleMatrix.Rel<U> right)
                                               throws ValueException

Divide the content of two matrices with a static method on a cell-by-cell basis; Rel / Rel = Rel. The unit is not changed by this method.

Type Parameters:

U - the unit

Parameters:

left - the first matrix

right - the second matrix

Returns:

the cell-by-cell division of the two matrices

Throws:

ValueException - when the two matrices have unequal size, or when one of the matrices is null or not well-formed

getValuesSI

public final double[][] getValuesSI()

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

Specified by:

getValuesSI in interface DoubleMatrixInterface<U extends Unit<U>>

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.

Specified by:

getValuesInUnit in interface DoubleMatrixInterface<U extends Unit<U>>

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.

Specified by:

getValuesInUnit in interface DoubleMatrixInterface<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

Returns:

int; the number of cells having non-zero value

toString

public final String toString()

Specified by:

toString in interface DoubleMatrixInterface<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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<U extends Unit<U>>

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

determinant

public final double determinant()
                         throws ValueException

Compute the determinant of the matrix.

Specified by:

determinant in interface DoubleMatrixInterface<U extends Unit<U>>

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