org.djunits.value.vdouble.matrix

Class AbstractDoubleMatrixRel<U extends Unit<U>,R extends AbstractDoubleMatrixRel<U,R,MR,S>,MR extends AbstractMutableDoubleMatrixRel<U,R,MR,S>,S extends AbstractDoubleScalarRel<U,S>>

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.matrix.AbstractDoubleMatrixRel<U,R,MR,S>

Type Parameters:

U - the unit

R - the relative matrix type

MR - the mutable relative matrix type

S - the relative scalar type

All Implemented Interfaces:

Serializable, Relative, Value<U>, DoubleMatrixInterface<U>

Direct Known Subclasses:

AbstractMutableDoubleMatrixRel, AccelerationMatrix, AngleMatrix, AngleSolidMatrix, AreaMatrix, DensityMatrix, DimensionlessMatrix, DoubleMatrix.Rel, DurationMatrix, ElectricalChargeMatrix, ElectricalCurrentMatrix, ElectricalPotentialMatrix, ElectricalResistanceMatrix, EnergyMatrix, FlowMassMatrix, FlowVolumeMatrix, ForceMatrix, FrequencyMatrix, LengthMatrix, LinearDensityMatrix, MassMatrix, MoneyMatrix, MoneyPerAreaMatrix, MoneyPerDurationMatrix, MoneyPerEnergyMatrix, MoneyPerLengthMatrix, MoneyPerMassMatrix, MoneyPerVolumeMatrix, PowerMatrix, PressureMatrix, SpeedMatrix, TemperatureMatrix, TorqueMatrix, VolumeMatrix

abstract class AbstractDoubleMatrixRel<U extends Unit<U>,R extends AbstractDoubleMatrixRel<U,R,MR,S>,MR extends AbstractMutableDoubleMatrixRel<U,R,MR,S>,S extends AbstractDoubleScalarRel<U,S>>
extends AbstractDoubleMatrix<U,R>
implements Relative, Serializable

Relative Immutable typed 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

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
AbstractDoubleMatrixRel(double[][] values, U unit, StorageType storageType) Construct a new Relative Immutable DoubleMatrix.
AbstractDoubleMatrixRel(DoubleMatrixData data, U unit) Construct a new Relative Immutable DoubleMatrix.
AbstractDoubleMatrixRel(S[][] values, StorageType storageType) Construct a new Relative Immutable DoubleMatrix.

Method Summary

Modifier and Type	Method and Description
(package private) static <U extends Unit<U>,S extends AbstractDoubleScalarRel<U,S>> U	checkUnit(S[][] dsArray) Check that a provided array can be used to create some descendant of a DoubleMatrix, and return the Unit.
R	divide(R rel) Divide this Relative value by a Relative value for a matrix or matrix.
protected static <U extends Unit<U>,S extends AbstractDoubleScalarRel<U,S>> void	ensureRectangularAndNonEmpty(S[][] values) Check that a 2D array of DoubleScalar<?> is rectangular; i.e.
S	get(int row, int column) Retrieve a value from the matrix.
protected abstract MR	instantiateMutableType(DoubleMatrixData dmd, U unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected abstract S	instantiateScalar(double value, U unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected abstract R	instantiateType(DoubleMatrixData dmd, U unit) Construct a new Relative Immutable DoubleMatrix of the right type.
R	minus(R rel) Subtract a Relative value from this Relative value for a matrix or matrix.
MR	mutable() Create a mutable version of this DoubleMatrix.
R	plus(R rel) Add a Relative value to this Relative value for a matrix or matrix.
R	times(R rel) Multiply a Relative value with this Relative value for a matrix or matrix.

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

Methods inherited from interface org.djunits.value.vdouble.matrix.DoubleMatrixInterface

toDense, toSparse

Constructor Detail

AbstractDoubleMatrixRel

AbstractDoubleMatrixRel(double[][] values,
                        U unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable DoubleMatrix.

Parameters:

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

unit - U; the unit of the new Relative Immutable DoubleMatrix

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

Throws:

ValueException - when values is null

AbstractDoubleMatrixRel

AbstractDoubleMatrixRel(S[][] values,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable DoubleMatrix.

Parameters:

values - S[][]; the values of the entries in the new Relative Immutable DoubleMatrix

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

Throws:

ValueException - when values has zero entries

AbstractDoubleMatrixRel

AbstractDoubleMatrixRel(DoubleMatrixData data,
                        U unit)

Construct a new Relative Immutable DoubleMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

mutable

public MR 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:

MA; mutable version of this DoubleMatrix

instantiateType

protected abstract R instantiateType(DoubleMatrixData dmd,
                                     U unit)

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

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected abstract MR instantiateMutableType(DoubleMatrixData dmd,
                                             U unit)

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

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected abstract S instantiateScalar(double value,
                                       U unit)

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

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

get

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

Retrieve a value from the matrix.

Specified by:

get 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:

the value as a DoubleScalar

Throws:

ValueException - in case row or column is out of bounds

plus

public final R plus(R rel)
             throws ValueException

Add a Relative value to this Relative value for a matrix or matrix. The addition is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse matrix or matrix, otherwise the result is a dense matrix or matrix.

Parameters:

rel - the right operand

Returns:

the addition of this matrix and the operand

Throws:

ValueException - in case this matrix or matrix and the operand have a different size

minus

public final R minus(R rel)
              throws ValueException

Subtract a Relative value from this Relative value for a matrix or matrix. The subtraction is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse matrix or matrix, otherwise the result is a dense matrix or matrix.

Parameters:

rel - the right operand

Returns:

the subtraction of this matrix and the operand

Throws:

ValueException - in case this matrix or matrix and the operand have a different size

times

public final R times(R rel)
              throws ValueException

Multiply a Relative value with this Relative value for a matrix or matrix. The multiplication is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense matrix or matrix, otherwise the result is a sparse matrix or matrix.

Parameters:

rel - the right operand

Returns:

the multiplication of this matrix and the operand

Throws:

ValueException - in case this matrix or matrix and the operand have a different size

divide

public final R divide(R rel)
               throws ValueException

Divide this Relative value by a Relative value for a matrix or matrix. The division is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense matrix or matrix, otherwise the result is a sparse matrix or matrix.

Parameters:

rel - the right operand

Returns:

the division of this matrix and the operand

Throws:

ValueException - in case this matrix or matrix and the operand have a different size

checkUnit

static <U extends Unit<U>,S extends AbstractDoubleScalarRel<U,S>> U checkUnit(S[][] 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

S - the scalar type

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 <U extends Unit<U>,S extends AbstractDoubleScalarRel<U,S>> void ensureRectangularAndNonEmpty(S[][] values)
                                                                                                       throws ValueException

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

Type Parameters:

U - the unit

S - the scalar type

Parameters:

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

Throws:

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