org.djunits.value.vdouble.matrix

Class DoubleMatrix.Rel<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

Type Parameters:

U - Unit the unit for which this Matrix will be created

All Implemented Interfaces:

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

Direct Known Subclasses:

TypedDoubleMatrixRel

Enclosing class:

DoubleMatrix<U extends Unit<U>>

public static class DoubleMatrix.Rel<U extends Unit<U>>
extends DoubleMatrix<U>
implements Relative, FunctionsRel<U,DoubleMatrix.Abs<U>,DoubleMatrix.Rel<U>>

RELATIVE implementation of DoubleMatrix.

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
Rel(double[][] values, U unit, StorageType storageType) Construct a new Relative Immutable DoubleMatrix.
Rel(DoubleMatrixData data, U unit) Construct a new Relative Immutable DoubleMatrix.
Rel(DoubleScalar.Rel<U>[][] values, StorageType storageType) Construct a new Relative Immutable DoubleMatrix.

Method Summary

Modifier and Type	Method and Description
DoubleMatrix.Rel<U>	divide(DoubleMatrix.Rel<U> rel) Divide this Relative value by a Relative value for a vector or matrix.
DoubleScalar.Rel<U>	get(int row, int column) Retrieve the value stored at a specified row and column as a DoubleScalar.
DoubleMatrix.Rel<U>	minus(DoubleMatrix.Rel<U> rel) Subtract a Relative value from this Relative value for a vector or matrix.
MutableDoubleMatrix.Rel<U>	mutable() Create a mutable version of this DoubleMatrix.
DoubleMatrix.Abs<U>	plus(DoubleMatrix.Abs<U> abs) Add an Absolute value to this Relative value for a vector or matrix.
DoubleMatrix.Rel<U>	plus(DoubleMatrix.Rel<U> rel) Add a Relative value to this Relative value for a vector or matrix.
DoubleMatrix.Rel<U>	times(DoubleMatrix.Rel<U> rel) Multiply a Relative value by this Relative value for a vector or matrix.
DoubleMatrix.Rel<U>	toDense() Create a dense version of this DoubleMatrix.
DoubleMatrix.Rel<U>	toSparse() Create a sparse version of this DoubleMatrix.

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

Rel

public Rel(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

Rel

public Rel(DoubleScalar.Rel<U>[][] values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Immutable DoubleMatrix.

Parameters:

values - DoubleScalar.Rel<U>[]; 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

Rel

Rel(DoubleMatrixData data,
    U unit)

Construct a new Relative Immutable DoubleMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

mutable

public MutableDoubleMatrix.Rel<U> 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.

Specified by:

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

Returns:

MutableDoubleMatrix<U>; mutable version of this DoubleMatrix

toDense

public DoubleMatrix.Rel<U> toDense()

Create a dense version of this DoubleMatrix.

Specified by:

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

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public DoubleMatrix.Rel<U> toSparse()

Create a sparse version of this DoubleMatrix.

Specified by:

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

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

get

public DoubleScalar.Rel<U> 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<U extends Unit<U>>

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())

plus

public DoubleMatrix.Rel<U> plus(DoubleMatrix.Rel<U> rel)
                         throws ValueException

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

Specified by:

plus in interface FunctionsRel<U extends Unit<U>,DoubleMatrix.Abs<U extends Unit<U>>,DoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

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

plus

public DoubleMatrix.Abs<U> plus(DoubleMatrix.Abs<U> abs)
                         throws ValueException

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

Specified by:

plus in interface FunctionsRel<U extends Unit<U>,DoubleMatrix.Abs<U extends Unit<U>>,DoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

abs - A the right operand

Returns:

A the sum of this vector and the operand

Throws:

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

minus

public final DoubleMatrix.Rel<U> minus(DoubleMatrix.Rel<U> rel)
                                throws ValueException

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

Specified by:

minus in interface FunctionsRel<U extends Unit<U>,DoubleMatrix.Abs<U extends Unit<U>>,DoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

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

times

public final DoubleMatrix.Rel<U> times(DoubleMatrix.Rel<U> rel)
                                throws ValueException

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

Specified by:

times in interface FunctionsRel<U extends Unit<U>,DoubleMatrix.Abs<U extends Unit<U>>,DoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

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

divide

public final DoubleMatrix.Rel<U> divide(DoubleMatrix.Rel<U> rel)
                                 throws ValueException

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

Specified by:

divide in interface FunctionsRel<U extends Unit<U>,DoubleMatrix.Abs<U extends Unit<U>>,DoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

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