org.djunits.value.vdouble.matrix

Class MutableDoubleMatrix.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.MutableDoubleMatrix<U>

org.djunits.value.vdouble.matrix.MutableDoubleMatrix.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>>, MathFunctionsAbs<MutableDoubleMatrix.Rel<U>>, MathFunctionsRel<MutableDoubleMatrix.Rel<U>>, Relative, Value<U>, DoubleMathFunctions<MutableDoubleMatrix.Rel<U>>, DoubleMatrixInterface<U>, MutableDoubleMatrixInterface<U>

Direct Known Subclasses:

MutableTypedDoubleMatrixRel

Enclosing class:

MutableDoubleMatrix<U extends Unit<U>>

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

RELATIVE implementation of MutableDoubleMatrix.

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

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

data

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Rel(double[][] values, U unit, StorageType storageType) Construct a new Relative Mutable DoubleMatrix.
Rel(DoubleMatrixData data, U unit) Construct a new Relative Mutable DoubleMatrix.
Rel(DoubleScalar.Rel<U>[][] values, StorageType storageType) Construct a new Relative Mutable DoubleMatrix.

Method Summary

Modifier and Type	Method and Description
MutableDoubleMatrix.Rel<U>	abs() Set the value(s) to their absolute value.
MutableDoubleMatrix.Rel<U>	ceil() Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
MutableDoubleMatrix.Rel<U>	copy() Create a deep copy of this MutableDoubleMatrix.
MutableDoubleMatrix.Rel<U>	decrementBy(double decrement) Decrement the value by the supplied constant and return the changed vector.
MutableDoubleMatrix.Rel<U>	decrementBy(DoubleMatrix.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableDoubleMatrix.Rel<U>	decrementBy(DoubleScalar.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
DoubleMatrix.Rel<U>	divide(DoubleMatrix.Rel<U> rel) Divide this Relative value by a Relative value for a vector or matrix.
MutableDoubleMatrix.Rel<U>	divideBy(double factor) Scale the value(s) by the inverse of a factor; i.e.
MutableDoubleMatrix.Rel<U>	divideBy(DoubleMatrix.Rel<U> factors) Divide the values in the vector by the supplied values and return the changed vector.
MutableDoubleMatrix.Rel<U>	divideBy(DoubleScalar.Rel<U> factor) Divide the values in the vector by the supplied value and return the changed vector.
MutableDoubleMatrix.Rel<U>	floor() Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
DoubleScalar.Rel<U>	get(int row, int column) Retrieve the value stored at a specified row and column as a DoubleScalar.
DoubleMatrix.Rel<U>	immutable() Create a immutable version of this MutableDoubleMatrix.
MutableDoubleMatrix.Rel<U>	incrementBy(double increment) Increment the value by the supplied constant and return the changed vector.
MutableDoubleMatrix.Rel<U>	incrementBy(DoubleMatrix.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
MutableDoubleMatrix.Rel<U>	incrementBy(DoubleScalar.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
DoubleMatrix.Rel<U>	minus(DoubleMatrix.Rel<U> rel) Subtract a Relative value from this Relative value for a vector or matrix.
MutableDoubleMatrix.Rel<U>	multiplyBy(double factor) Scale the value(s) by a factor.
MutableDoubleMatrix.Rel<U>	multiplyBy(DoubleMatrix.Rel<U> factors) Multiply the values in the vector by the supplied values and return the changed vector.
MutableDoubleMatrix.Rel<U>	multiplyBy(DoubleScalar.Rel<U> factor) Multiply the values in the vector by the supplied value and return the changed vector.
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.
MutableDoubleMatrix.Rel<U>	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
MutableDoubleMatrix.Rel<U>	round() Set the value(s) to the closest long to the argument with ties rounding up.
DoubleMatrix.Rel<U>	times(DoubleMatrix.Rel<U> rel) Multiply a Relative value by this Relative value for a vector or matrix.
MutableDoubleMatrix.Rel<U>	toDense() Create a dense version of this DoubleMatrix.
MutableDoubleMatrix.Rel<U>	toSparse() Create a sparse version of this DoubleMatrix.

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

assign, checkCopyOnWrite, instantiateMutableAbs, normalize, set, setCopyOnWrite, setInUnit, setSI

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

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

cardinality, columns, determinant, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, rows, toString, toString, toString, toString, zSum

Constructor Detail

Rel

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

Construct a new Relative Mutable DoubleMatrix.

Parameters:

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

unit - U; the unit of the new Relative Mutable 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 Mutable DoubleMatrix.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Mutable 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 Mutable DoubleMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

immutable

public DoubleMatrix.Rel<U> immutable()

Create a immutable version of this MutableDoubleMatrix.

Specified by:

immutable in interface MutableDoubleMatrixInterface<U extends Unit<U>>

Returns:

DoubleMatrix<U>; mutable version of this MutableDoubleMatrix

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

copy

public MutableDoubleMatrix.Rel<U> copy()

Create a deep copy of this MutableDoubleMatrix.

Specified by:

copy in interface MutableDoubleMatrixInterface<U extends Unit<U>>

Returns:

DoubleMatrix<U>; deep copy of this MutableDoubleMatrix

toDense

public MutableDoubleMatrix.Rel<U> toDense()

Create a dense version of this DoubleMatrix.

Specified by:

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

Specified by:

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

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public MutableDoubleMatrix.Rel<U> toSparse()

Create a sparse version of this DoubleMatrix.

Specified by:

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

Specified by:

toSparse in interface MutableDoubleMatrixInterface<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())

incrementBy

public final MutableDoubleMatrix.Rel<U> incrementBy(DoubleMatrix.Rel<U> increment)
                                             throws ValueException

Increment the value by the supplied value and return the changed vector.

Parameters:

increment - DoubleMatrix.Rel<U>; amount by which the value is incremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

Throws:

ValueException - when the size of increment is not identical to the size of this

incrementBy

public final MutableDoubleMatrix.Rel<U> incrementBy(DoubleScalar.Rel<U> increment)

Increment the value by the supplied value and return the changed vector.

Parameters:

increment - DoubleScalar.Rel<U>; amount by which the value is incremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

incrementBy

public final MutableDoubleMatrix.Rel<U> incrementBy(double increment)

Increment the value by the supplied constant and return the changed vector.

Parameters:

increment - amount by which the value is incremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

decrementBy

public final MutableDoubleMatrix.Rel<U> decrementBy(DoubleMatrix.Rel<U> decrement)
                                             throws ValueException

Decrement the value by the supplied value and return the changed vector.

Parameters:

decrement - DoubleMatrix.Rel<U>; amount by which the value is decremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

Throws:

ValueException - when the size of increment is not identical to the size of this

decrementBy

public final MutableDoubleMatrix.Rel<U> decrementBy(DoubleScalar.Rel<U> decrement)

Decrement the value by the supplied value and return the changed vector.

Parameters:

decrement - DoubleScalar.Rel<U>; amount by which the value is decremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

decrementBy

public final MutableDoubleMatrix.Rel<U> decrementBy(double decrement)

Decrement the value by the supplied constant and return the changed vector.

Parameters:

decrement - amount by which the value is decremented

Returns:

the changed MutableDoubleMatrix.Rel<U>

multiplyBy

public final MutableDoubleMatrix.Rel<U> multiplyBy(DoubleMatrix.Rel<U> factors)
                                            throws ValueException

Multiply the values in the vector by the supplied values and return the changed vector.

Parameters:

factors - DoubleMatrix.Rel<U>; amounts by which the value is multiplied

Returns:

the changed MutableDoubleMatrix.Rel<U>

Throws:

ValueException - when the size of the factors is not identical to the size of this

multiplyBy

public final MutableDoubleMatrix.Rel<U> multiplyBy(DoubleScalar.Rel<U> factor)

Multiply the values in the vector by the supplied value and return the changed vector.

Parameters:

factor - DoubleScalar.Rel<U>; amount by which the values in the vector are multiplied

Returns:

the changed MutableDoubleMatrix.Rel<U>

multiplyBy

public MutableDoubleMatrix.Rel<U> multiplyBy(double factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface DoubleMathFunctions<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

factor - double; the multiplier

Returns:

T; the modified T

divideBy

public final MutableDoubleMatrix.Rel<U> divideBy(DoubleMatrix.Rel<U> factors)
                                          throws ValueException

Divide the values in the vector by the supplied values and return the changed vector.

Parameters:

factors - DoubleMatrix.Rel<U>; amounts by which the value is divided

Returns:

the changed MutableDoubleMatrix.Rel<U>

Throws:

ValueException - when the size of the factors is not identical to the size of this

divideBy

public MutableDoubleMatrix.Rel<U> divideBy(double factor)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divideBy in interface DoubleMathFunctions<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Parameters:

factor - double; the divisor

Returns:

T; the modified T

divideBy

public final MutableDoubleMatrix.Rel<U> divideBy(DoubleScalar.Rel<U> factor)

Divide the values in the vector by the supplied value and return the changed vector.

Parameters:

factor - DoubleScalar.Rel<U>; amount by which the values in the vector are divided

Returns:

the changed MutableDoubleMatrix.Rel<U>

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

abs

public MutableDoubleMatrix.Rel<U> abs()

Set the value(s) to their absolute value.

Specified by:

abs in interface MathFunctionsRel<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Returns:

T; the modified T

ceil

public MutableDoubleMatrix.Rel<U> ceil()

Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.

Specified by:

ceil in interface MathFunctionsAbs<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Returns:

T; the modified T

floor

public MutableDoubleMatrix.Rel<U> floor()

Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.

Specified by:

floor in interface MathFunctionsAbs<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Returns:

T; the modified T

rint

public MutableDoubleMatrix.Rel<U> rint()

Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.

Specified by:

rint in interface MathFunctionsAbs<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Returns:

T; the modified T

round

public MutableDoubleMatrix.Rel<U> round()

Set the value(s) to the closest long to the argument with ties rounding up.

Specified by:

round in interface MathFunctionsAbs<MutableDoubleMatrix.Rel<U extends Unit<U>>>

Returns:

T; the modified T