org.djunits.value.vdouble.matrix

Class LengthMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.matrix.TypedDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

org.djunits.value.vdouble.matrix.LengthMatrix

All Implemented Interfaces:

Serializable, FunctionsRel<LengthUnit,DoubleMatrix.Abs<LengthUnit>,DoubleMatrix.Rel<LengthUnit>>, Relative, Value<LengthUnit>, DoubleMatrixInterface<LengthUnit>

public class LengthMatrix
extends TypedDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Immutable Length Matrix.

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

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.matrix.DoubleMatrix

DoubleMatrix.Abs<U extends Unit<U>>, DoubleMatrix.Rel<U extends Unit<U>>

Field Summary

Fields inherited from class org.djunits.value.vdouble.matrix.DoubleMatrix

data

Constructor Summary

Constructors

Constructor and Description
LengthMatrix(double[][] values, LengthUnit unit, StorageType storageType) Construct a new Relative Immutable Double LengthMatrix.
LengthMatrix(DoubleMatrixData data, LengthUnit unit) Construct a new Relative Immutable Double LengthMatrix.
LengthMatrix(Length[][] values, StorageType storageType) Construct a new Relative Immutable Double LengthMatrix.

Method Summary

Modifier and Type	Method and Description
Length	get(int row, int column) Retrieve the value stored at a specified row and column as a DoubleScalar.
protected MutableLengthMatrix	instantiateMutableType(DoubleMatrixData dmd, LengthUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected LengthMatrix	instantiateType(DoubleMatrixData dmd, LengthUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
PositionMatrix	toAbs() Translate the relative matrix into an absolute matrix (e.g., before or after a multiplication or division).

Methods inherited from class org.djunits.value.vdouble.matrix.TypedDoubleMatrixRel

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vdouble.matrix.DoubleMatrix.Rel

divide, minus, plus, plus, times

Methods inherited from class org.djunits.value.vdouble.matrix.DoubleMatrix

cardinality, checkIndex, checkSize, checkSize, checkUnit, columns, determinant, divide, ensureRectangularAndNonEmpty, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, minus, minus, minus, plus, plus, rows, times, toString, toString, toString, toString, zSum

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

Constructor Detail

LengthMatrix

public LengthMatrix(double[][] values,
                    LengthUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthMatrix.

Parameters:

values - double[][]; the values of the entries in the new Relative Immutable Double LengthMatrix

unit - U; the unit of the new Relative Immutable Double LengthMatrix

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

LengthMatrix

public LengthMatrix(Length[][] values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthMatrix.

Parameters:

values - DoubleScalar.Rel<U>[][]; the values of the entries in the new Relative Immutable Double LengthMatrix

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

LengthMatrix

LengthMatrix(DoubleMatrixData data,
             LengthUnit unit)

Construct a new Relative Immutable Double LengthMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final LengthMatrix instantiateType(DoubleMatrixData dmd,
                                             LengthUnit unit)

Construct a new Relative Immutable DoubleMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class TypedDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected final MutableLengthMatrix instantiateMutableType(DoubleMatrixData dmd,
                                                           LengthUnit unit)

Construct a new Relative Mutable DoubleMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class TypedDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

get

public final Length get(int row,
                        int column)
                 throws ValueException

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

Specified by:

get in interface DoubleMatrixInterface<LengthUnit>

Specified by:

get in class TypedDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

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

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

toAbs

public final PositionMatrix toAbs()

Translate the relative matrix into an absolute matrix (e.g., before or after a multiplication or division).

Returns:

an absolute version of this relative Length matrix.