org.djunits.value.vdouble.matrix

Class LengthMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.matrix.AbstractDoubleMatrix<U,R>

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

org.djunits.value.vdouble.matrix.LengthMatrix

All Implemented Interfaces:

Serializable, Relative, Value<LengthUnit>, DoubleMatrixInterface<LengthUnit>

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

Immutable Length Matrix.

Copyright (c) 2013-2018 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

Field Summary

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

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
protected MutableLengthMatrix	instantiateMutableType(DoubleMatrixData dmd, LengthUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected Length	instantiateScalar(double value, LengthUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected LengthMatrix	instantiateType(DoubleMatrixData dmd, LengthUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
LengthMatrix	toDense() Create a dense version of this DoubleMatrix.
LengthMatrix	toSparse() Create a sparse version of this DoubleMatrix.

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

checkUnit, divide, ensureRectangularAndNonEmpty, get, minus, mutable, plus, times

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

cardinality, checkIndex, checkSize, checkSize, columns, determinant, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, rows, toString, toString, toString, toString, zSum

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

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

toDense

public final LengthMatrix toDense()

Create a dense version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public final LengthMatrix toSparse()

Create a sparse version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

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 AbstractDoubleMatrixRel<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 AbstractDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected final Length instantiateScalar(double value,
                                         LengthUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleMatrixRel<LengthUnit,LengthMatrix,MutableLengthMatrix,Length>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type