org.djunits.value.vfloat.matrix

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

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.FloatMatrix<U>

org.djunits.value.vfloat.matrix.MutableFloatMatrix<U>

org.djunits.value.vfloat.matrix.MutableFloatMatrix.Rel<U>

Type Parameters:

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

All Implemented Interfaces:

Serializable, FunctionsRel<U,FloatMatrix.Abs<U>,FloatMatrix.Rel<U>>, MathFunctionsAbs<MutableFloatMatrix.Rel<U>>, MathFunctionsRel<MutableFloatMatrix.Rel<U>>, Relative, Value<U>, FloatMathFunctions<MutableFloatMatrix.Rel<U>>, FloatMatrixInterface<U>, MutableFloatMatrixInterface<U>

Direct Known Subclasses:

MutableTypedFloatMatrixRel

Enclosing class:

MutableFloatMatrix<U extends Unit<U>>

public static class MutableFloatMatrix.Rel<U extends Unit<U>>
extends MutableFloatMatrix<U>
implements Relative, MathFunctionsRel<MutableFloatMatrix.Rel<U>>, FloatMathFunctions<MutableFloatMatrix.Rel<U>>, FunctionsRel<U,FloatMatrix.Abs<U>,FloatMatrix.Rel<U>>

RELATIVE implementation of MutableFloatMatrix.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.matrix.MutableFloatMatrix

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

Field Summary

Fields inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

data

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
Rel(float[][] values, U unit, StorageType storageType) Construct a new Relative Mutable FloatMatrix.
Rel(FloatMatrixData data, U unit) Construct a new Relative Mutable FloatMatrix.
Rel(FloatScalar.Rel<U>[][] values, StorageType storageType) Construct a new Relative Mutable FloatMatrix.

Method Summary

Modifier and Type	Method and Description
MutableFloatMatrix.Rel<U>	abs() Set the value(s) to their absolute value.
MutableFloatMatrix.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.
MutableFloatMatrix.Rel<U>	copy() Create a deep copy of this MutableFloatMatrix.
MutableFloatMatrix.Rel<U>	decrementBy(float decrement) Decrement the value by the supplied constant and return the changed vector.
MutableFloatMatrix.Rel<U>	decrementBy(FloatMatrix.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableFloatMatrix.Rel<U>	decrementBy(FloatScalar.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
FloatMatrix.Rel<U>	divide(FloatMatrix.Rel<U> rel) Divide this Relative value by a Relative value for a vector or matrix.
MutableFloatMatrix.Rel<U>	divideBy(float factor) Scale the value(s) by the inverse of a factor; i.e.
MutableFloatMatrix.Rel<U>	divideBy(FloatMatrix.Rel<U> factors) Divide the values in the vector by the supplied values and return the changed vector.
MutableFloatMatrix.Rel<U>	divideBy(FloatScalar.Rel<U> factor) Divide the values in the vector by the supplied value and return the changed vector.
MutableFloatMatrix.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.
FloatScalar.Rel<U>	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
FloatMatrix.Rel<U>	immutable() Create a immutable version of this MutableFloatMatrix.
MutableFloatMatrix.Rel<U>	incrementBy(float increment) Increment the value by the supplied constant and return the changed vector.
MutableFloatMatrix.Rel<U>	incrementBy(FloatMatrix.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
MutableFloatMatrix.Rel<U>	incrementBy(FloatScalar.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
FloatMatrix.Rel<U>	minus(FloatMatrix.Rel<U> rel) Subtract a Relative value from this Relative value for a vector or matrix.
MutableFloatMatrix.Rel<U>	multiplyBy(float factor) Scale the value(s) by a factor.
MutableFloatMatrix.Rel<U>	multiplyBy(FloatMatrix.Rel<U> factors) Multiply the values in the vector by the supplied values and return the changed vector.
MutableFloatMatrix.Rel<U>	multiplyBy(FloatScalar.Rel<U> factor) Multiply the values in the vector by the supplied value and return the changed vector.
MutableFloatMatrix.Rel<U>	mutable() Create a mutable version of this FloatMatrix.
FloatMatrix.Abs<U>	plus(FloatMatrix.Abs<U> abs) Add an Absolute value to this Relative value for a vector or matrix.
FloatMatrix.Rel<U>	plus(FloatMatrix.Rel<U> rel) Add a Relative value to this Relative value for a vector or matrix.
MutableFloatMatrix.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.
MutableFloatMatrix.Rel<U>	round() Set the value(s) to the closest long to the argument with ties rounding up.
FloatMatrix.Rel<U>	times(FloatMatrix.Rel<U> rel) Multiply a Relative value by this Relative value for a vector or matrix.
MutableFloatMatrix.Rel<U>	toDense() Create a dense version of this FloatMatrix.
MutableFloatMatrix.Rel<U>	toSparse() Create a sparse version of this FloatMatrix.

Methods inherited from class org.djunits.value.vfloat.matrix.MutableFloatMatrix

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

Methods inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vfloat.matrix.FloatMatrixInterface

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

Constructor Detail

Rel

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

Construct a new Relative Mutable FloatMatrix.

Parameters:

values - float[][]; the values of the entries in the new Relative Mutable FloatMatrix

unit - U; the unit of the new Relative Mutable FloatMatrix

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

Throws:

ValueException - when values is null

Rel

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

Construct a new Relative Mutable FloatMatrix.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Mutable FloatMatrix

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

Throws:

ValueException - when values has zero entries

Rel

Rel(FloatMatrixData data,
    U unit)

Construct a new Relative Mutable FloatMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

immutable

public FloatMatrix.Rel<U> immutable()

Create a immutable version of this MutableFloatMatrix.

Specified by:

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

Returns:

FloatMatrix<U>; mutable version of this MutableFloatMatrix

mutable

public MutableFloatMatrix.Rel<U> mutable()

Create a mutable version of this FloatMatrix.
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 FloatMatrixInterface<U extends Unit<U>>

Returns:

MutableFloatMatrix<U>; mutable version of this FloatMatrix

copy

public MutableFloatMatrix.Rel<U> copy()

Create a deep copy of this MutableFloatMatrix.

Specified by:

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

Returns:

FloatMatrix<U>; deep copy of this MutableFloatMatrix

toDense

public MutableFloatMatrix.Rel<U> toDense()

Create a dense version of this FloatMatrix.

Specified by:

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

Specified by:

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

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

public MutableFloatMatrix.Rel<U> toSparse()

Create a sparse version of this FloatMatrix.

Specified by:

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

Specified by:

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

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix

get

public FloatScalar.Rel<U> get(int row,
                              int column)
                       throws ValueException

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

Specified by:

get in interface FloatMatrixInterface<U extends Unit<U>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

FloatScalar<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 MutableFloatMatrix.Rel<U> incrementBy(FloatMatrix.Rel<U> increment)
                                            throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

Throws:

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

incrementBy

public final MutableFloatMatrix.Rel<U> incrementBy(FloatScalar.Rel<U> increment)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

incrementBy

public final MutableFloatMatrix.Rel<U> incrementBy(float 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 MutableFloatMatrix.Rel<U>

decrementBy

public final MutableFloatMatrix.Rel<U> decrementBy(FloatMatrix.Rel<U> decrement)
                                            throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

Throws:

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

decrementBy

public final MutableFloatMatrix.Rel<U> decrementBy(FloatScalar.Rel<U> decrement)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

decrementBy

public final MutableFloatMatrix.Rel<U> decrementBy(float 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 MutableFloatMatrix.Rel<U>

multiplyBy

public final MutableFloatMatrix.Rel<U> multiplyBy(FloatMatrix.Rel<U> factors)
                                           throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

Throws:

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

multiplyBy

public final MutableFloatMatrix.Rel<U> multiplyBy(FloatScalar.Rel<U> factor)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

multiplyBy

public MutableFloatMatrix.Rel<U> multiplyBy(float factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface FloatMathFunctions<MutableFloatMatrix.Rel<U extends Unit<U>>>

Parameters:

factor - float; the multiplier

Returns:

T; the modified T

divideBy

public final MutableFloatMatrix.Rel<U> divideBy(FloatMatrix.Rel<U> factors)
                                         throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

Throws:

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

divideBy

public MutableFloatMatrix.Rel<U> divideBy(float factor)

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

Specified by:

divideBy in interface FloatMathFunctions<MutableFloatMatrix.Rel<U extends Unit<U>>>

Parameters:

factor - float; the divisor

Returns:

T; the modified T

divideBy

public final MutableFloatMatrix.Rel<U> divideBy(FloatScalar.Rel<U> factor)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

plus

public FloatMatrix.Rel<U> plus(FloatMatrix.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>,FloatMatrix.Abs<U extends Unit<U>>,FloatMatrix.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 FloatMatrix.Abs<U> plus(FloatMatrix.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>,FloatMatrix.Abs<U extends Unit<U>>,FloatMatrix.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 FloatMatrix.Rel<U> minus(FloatMatrix.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>,FloatMatrix.Abs<U extends Unit<U>>,FloatMatrix.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 FloatMatrix.Rel<U> times(FloatMatrix.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>,FloatMatrix.Abs<U extends Unit<U>>,FloatMatrix.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 FloatMatrix.Rel<U> divide(FloatMatrix.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>,FloatMatrix.Abs<U extends Unit<U>>,FloatMatrix.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 MutableFloatMatrix.Rel<U> abs()

Set the value(s) to their absolute value.

Specified by:

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

Returns:

T; the modified T

ceil

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

Returns:

T; the modified T

floor

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

Returns:

T; the modified T

rint

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

Returns:

T; the modified T

round

public MutableFloatMatrix.Rel<U> round()

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

Specified by:

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

Returns:

T; the modified T