org.djunits.value.vfloat.matrix

Class AbstractMutableFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>,MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.AbstractFloatMatrix<AU,A>

org.djunits.value.vfloat.matrix.AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>

org.djunits.value.vfloat.matrix.AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>

Type Parameters:

AU - the absolute unit

RU - the relative unit

A - the absolute matrix type

R - the relative matrix type

MA - the mutable absolute matrix type

S - the absolute scalar type

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<AU,RU,A,R>, MathFunctionsAbs<MA>, Mutable, Value<AU>, FloatMathFunctions<MA>, FloatMatrixInterface<AU>

Direct Known Subclasses:

MutableFloatAbsoluteTemperatureMatrix, MutableFloatDirectionMatrix, MutableFloatMatrix.Abs, MutableFloatPositionMatrix, MutableFloatTimeMatrix

abstract class AbstractMutableFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>,MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>
extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>
implements Mutable, MathFunctionsAbs<MA>, FloatMathFunctions<MA>

Absolute Mutable 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.vfloat.matrix.AbstractFloatMatrix

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, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
AbstractMutableFloatMatrixAbs(float[][] values, AU unit, StorageType storageType) Construct a new Absolute Mutable FloatMatrix.
AbstractMutableFloatMatrixAbs(FloatMatrixData data, AU unit) Construct a new Absolute Mutable FloatMatrix.
AbstractMutableFloatMatrixAbs(S[][] values, StorageType storageType) Construct a new Absolute Mutable FloatMatrix.

Method Summary

Modifier and Type	Method and Description
void	assign(FloatFunction floatFunction) Execute a function on a cell by cell basis.
MA	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.
protected void	checkCopyOnWrite() Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.
MA	copy() Create a deep copy of this MutableFloatMatrix.
MA	decrementBy(float decrement) Decrement the value by the supplied constant and return the changed matrix.
MA	decrementBy(R decrement) Decrement the value by the supplied value and return the changed matrix.
MA	decrementBy(S decrement) Decrement the value by the supplied value and return the changed matrix.
MA	divideBy(float factor) Scale the value(s) by the inverse of a factor; i.e.
MA	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.
A	immutable() Create a immutable version of this MutableFloatMatrix.
MA	incrementBy(float increment) Increment the value by the supplied constant and return the changed matrix.
MA	incrementBy(R increment) Increment the value by the supplied value and return the changed matrix.
MA	incrementBy(S increment) Increment the value by the supplied value and return the changed matrix.
MA	multiplyBy(float factor) Scale the value(s) by a factor.
MA	multiplyBy(R factors) Multiply the values in the matrix by the supplied values and return the changed matrix.
MA	mutable() Create a mutable version of this FloatMatrix.
void	normalize() Normalize the matrix, i.e.
MA	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
MA	round() Set the value(s) to the closest long to the argument with ties rounding up.
void	set(int row, int column, S value) Set the value for a cell in the matrix.
(package private) void	setCopyOnWrite(boolean copyOnWrite) Change the copyOnWrite flag.
void	setInUnit(int row, int column, float value, AU valueUnit) Set the value for a cell in the matrix.
void	setSI(int row, int column, float valueSI) Set the value for a cell in the matrix.

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

checkUnit, ensureRectangularAndNonEmpty, get, instantiateMutableType, instantiateScalar, instantiateTypeAbs, instantiateTypeRel, minus, minus, plus

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

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.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, toDense, toSparse, toString, toString, toString, toString, zSum

Constructor Detail

AbstractMutableFloatMatrixAbs

AbstractMutableFloatMatrixAbs(float[][] values,
                              AU unit,
                              StorageType storageType)
                       throws ValueException

Construct a new Absolute Mutable FloatMatrix.

Parameters:

values - float[][]; the values of the entries in the new Absolute Immutable FloatMatrix

unit - AU; the unit of the new Absolute Immutable FloatMatrix

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

Throws:

ValueException - when values is null

AbstractMutableFloatMatrixAbs

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

Construct a new Absolute Mutable FloatMatrix.

Parameters:

values - S[][]; the values of the entries in the new Absolute Immutable FloatMatrix

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

Throws:

ValueException - when values has zero entries

AbstractMutableFloatMatrixAbs

AbstractMutableFloatMatrixAbs(FloatMatrixData data,
                              AU unit)

Construct a new Absolute Mutable FloatMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

setCopyOnWrite

final void setCopyOnWrite(boolean copyOnWrite)

Change the copyOnWrite flag.

Parameters:

copyOnWrite - boolean; the new value for the copyOnWrite flag

mutable

public final MA 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.

Overrides:

mutable in class AbstractFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>,MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>

Returns:

MA; mutable version of this FloatMatrix

immutable

public final A immutable()

Create a immutable version of this MutableFloatMatrix.

Returns:

FloatMatrix<U>; mutable version of this MutableFloatMatrix

copy

public final MA copy()

Create a deep copy of this MutableFloatMatrix.

Returns:

FloatMatrix<U>; deep copy of this MutableFloatMatrix

incrementBy

public final MA incrementBy(R increment)
                     throws ValueException

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

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 MA incrementBy(S increment)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

incrementBy

public final MA incrementBy(float increment)

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

Parameters:

increment - amount by which the value is incremented

Returns:

the changed MutableFloatMatrix.Rel<U>

decrementBy

public final MA decrementBy(R decrement)
                     throws ValueException

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

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 MA decrementBy(S decrement)

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

Parameters:

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

Returns:

the changed MutableFloatMatrix.Rel<U>

decrementBy

public final MA decrementBy(float decrement)

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

Parameters:

decrement - amount by which the value is decremented

Returns:

the changed MutableFloatMatrix.Rel<U>

multiplyBy

public final MA multiplyBy(float factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface FloatMathFunctions<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Parameters:

factor - float; the multiplier

Returns:

T; the modified T

divideBy

public MA divideBy(float factor)

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

Specified by:

divideBy in interface FloatMathFunctions<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Parameters:

factor - float; the divisor

Returns:

T; the modified T

multiplyBy

public final MA multiplyBy(R factors)
                    throws ValueException

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

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

assign

public final void assign(FloatFunction floatFunction)

Execute a function on a cell by cell basis. Note: because many functions have to act on zero cells or can generate cells with a zero value, the functions have to be applied on a dense dataset which has to be transformed back to a sparse dataset if necessary.

Parameters:

floatFunction - the function to apply

ceil

public final MA 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<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Returns:

T; the modified T

floor

public final MA 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<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Returns:

T; the modified T

rint

public final MA 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<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Returns:

T; the modified T

round

public final MA round()

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

Specified by:

round in interface MathFunctionsAbs<MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>>

Returns:

T; the modified T

checkCopyOnWrite

protected final void checkCopyOnWrite()

Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.

setSI

public final void setSI(int row,
                        int column,
                        float valueSI)
                 throws ValueException

Set the value for a cell in the matrix.

Parameters:

row - the row

column - the column

valueSI - the value, expressed in the SI unit

Throws:

ValueException - when the row/column is out of range

set

public final void set(int row,
                      int column,
                      S value)
               throws ValueException

Set the value for a cell in the matrix.

Parameters:

row - the row

column - the column

value - the value

Throws:

ValueException - when the row/column is out of range

setInUnit

public final void setInUnit(int row,
                            int column,
                            float value,
                            AU valueUnit)
                     throws ValueException

Set the value for a cell in the matrix.

Parameters:

row - the row

column - the column

value - the value, expressed in the given unit

valueUnit - the unit of the value

Throws:

ValueException - when the row/column is out of range

normalize

public final void normalize()
                     throws ValueException

Normalize the matrix, i.e. scale the values to make the sum equal to 1.

Throws:

ValueException - when the sum of the values is zero and normalization is not possible