org.opentrafficsim.core.value.vfloat.matrix

Class MutableFloatMatrix<U extends Unit<U>>

java.lang.Object

org.opentrafficsim.core.value.AbstractValue<U>

org.opentrafficsim.core.value.vfloat.matrix.FloatMatrix<U>

org.opentrafficsim.core.value.vfloat.matrix.MutableFloatMatrix<U>

Type Parameters:

U - Unit; the unit of this MutableFloatMatrix

All Implemented Interfaces:

Serializable, MathFunctions<MutableFloatMatrix<U>>, Value<U>, FloatMathFunctions<MutableFloatMatrix<U>>, ReadOnlyFloatMatrixFunctions<U>, WriteFloatMatrixFunctions<U>

Direct Known Subclasses:

MutableFloatMatrix.Abs, MutableFloatMatrix.Rel

public abstract class MutableFloatMatrix<U extends Unit<U>>
extends FloatMatrix<U>
implements WriteFloatMatrixFunctions<U>, FloatMathFunctions<MutableFloatMatrix<U>>

MutableFloatMatrix.

This file was generated by the OpenTrafficSim value classes generator, 09 mrt, 2015

Copyright (c) 2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

09 mrt, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MutableFloatMatrix.Abs<U extends Unit<U>>
static class	MutableFloatMatrix.Rel<U extends Unit<U>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableFloatMatrix(U unit) Construct a new MutableFloatMatrix.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(cern.colt.function.tfloat.FloatFunction f) Execute a function on a cell by cell basis.
protected void	checkCopyOnWrite() Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.
protected MutableFloatMatrix.Rel<U>	decrementBy(FloatMatrix.Abs<U> abs) Decrement the values in this Relative MutableFloatMatrix by the corresponding values in an Absolute FloatMatrix.
protected MutableFloatMatrix<U>	decrementByImpl(FloatMatrix.Rel<U> rel) Decrement the corresponding values of this Relative FloatMatrix from the values of this MutableFloatMatrix.
MutableFloatMatrix<U>	divide(float constant) Scale the value(s) by the inverse of a factor; i.e.
abstract FloatMatrix<U>	immutable() Make (immutable) FloatMatrix equivalent for any type of MutableFloatMatrix.
protected MutableFloatMatrix<U>	incrementByImpl(FloatMatrix.Rel<U> rel) Increment the values in this MutableFloatMatrix by the corresponding values in a Relative FloatMatrix.
MutableFloatMatrix<U>	multiply(float constant) Scale the value(s) by a factor.
void	normalize() Normalize the matrix, i.e.
protected MutableFloatMatrix<U>	scaleValueByValue(float[][] factor) Scale the values in this MutableFloatMatrix by the corresponding values in a float array.
protected void	scaleValueByValue(FloatMatrix<?> factor) Scale the values in this MutableFloatMatrix by the corresponding values in a FloatMatrix.
void	set(int row, int column, FloatScalar<U> value) Replace the value at row, column by the supplied value which is in a compatible unit.
void	setInUnit(int row, int column, float value, U valueUnit) Replace the value at row, column by the supplied value which is expressed in a supplied (compatible) unit.
void	setSI(int row, int column, float valueSI) Replace the value at row, column by the supplied value which is expressed in the standard SI unit.

Methods inherited from class org.opentrafficsim.core.value.vfloat.matrix.FloatMatrix

cardinality, checkIndex, checkNonEmpty, checkSize, checkSize, columns, createMatrix2D, deepCopyData, deepCopyOfData, denseToSparse, denseToSparse, det, equals, getInUnit, getInUnit, getMatrixSI, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, initialize, initialize, initialize, interpolate, interpolate, interpolate, interpolate, minus, minus, minus, minus, minus, minus, minus, minus, minus, mutable, plus, plus, plus, plus, plus, plus, rows, safeGet, safeSet, solve, sparseToDense, sparseToDense, times, times, times, times, times, times, times, times, times, times, toString, toString, toString, toString, zSum

Methods inherited from class org.opentrafficsim.core.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.opentrafficsim.core.value.MathFunctions

abs, acos, asin, atan, cbrt, ceil, cos, cosh, exp, expm1, floor, inv, log, log10, log1p, pow, rint, round, signum, sin, sinh, sqrt, tan, tanh, toDegrees, toRadians

Methods inherited from interface org.opentrafficsim.core.value.vfloat.matrix.ReadOnlyFloatMatrixFunctions

get

Methods inherited from interface org.opentrafficsim.core.value.Value

copy

Constructor Detail

MutableFloatMatrix

protected MutableFloatMatrix(U unit)

Construct a new MutableFloatMatrix.

Parameters:

unit - U; the unit of the new MutableFloatMatrix

Method Detail

normalize

public final void normalize()
                     throws ValueException

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

Specified by:

normalize in interface WriteFloatMatrixFunctions<U extends Unit<U>>

Throws:

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

immutable

public abstract FloatMatrix<U> immutable()

Make (immutable) FloatMatrix equivalent for any type of MutableFloatMatrix.

Returns:

FloatMatrix<U>; immutable version of this FloatMatrix

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

Replace the value at row, column by the supplied value which is expressed in the standard SI unit.

Specified by:

setSI in interface WriteFloatMatrixFunctions<U extends Unit<U>>

Parameters:

row - int; row of the value to replace

column - int; column of the value to replace

valueSI - float; the value to store (expressed in the standard SI unit)

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

set

public final void set(int row,
       int column,
       FloatScalar<U> value)
               throws ValueException

Replace the value at row, column by the supplied value which is in a compatible unit.

Specified by:

set in interface WriteFloatMatrixFunctions<U extends Unit<U>>

Parameters:

row - int; row of the value to replace

column - int; column of the value to replace

value - FloatScalar<U>; the strongly typed value to store

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

setInUnit

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

Replace the value at row, column by the supplied value which is expressed in a supplied (compatible) unit.

Specified by:

setInUnit in interface WriteFloatMatrixFunctions<U extends Unit<U>>

Parameters:

row - int; row of the value to replace

column - int; column of the value to replace

value - float; the value to store (which is expressed in valueUnit)

valueUnit - U; unit of the supplied value

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

assign

public final void assign(cern.colt.function.tfloat.FloatFunction f)

Execute a function on a cell by cell basis.

Parameters:

f - cern.colt.function.tfloat.FloatFunction; the function to apply

multiply

public final MutableFloatMatrix<U> multiply(float constant)

Scale the value(s) by a factor.

Specified by:

multiply in interface FloatMathFunctions<MutableFloatMatrix<U extends Unit<U>>>

Parameters:

constant - float; the multiplier

Returns:

T; the modified T

divide

public final MutableFloatMatrix<U> divide(float constant)

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

Specified by:

divide in interface FloatMathFunctions<MutableFloatMatrix<U extends Unit<U>>>

Parameters:

constant - float; the divisor

Returns:

T; the modified T

incrementByImpl

protected final MutableFloatMatrix<U> incrementByImpl(FloatMatrix.Rel<U> rel)
                                                               throws ValueException

Increment the values in this MutableFloatMatrix by the corresponding values in a Relative FloatMatrix.
Only Relative values are allowed; adding an Absolute value to an Absolute value is not allowed. Adding an Absolute value to an existing Relative value would require the result to become Absolute, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatMatrix.Rel<U>; the Relative FloatMatrix

Returns:

MutableFloatMatrix<U>; this modified MutableFloatMatrix

Throws:

ValueException - when the matrices do not have the same size

decrementByImpl

protected final MutableFloatMatrix<U> decrementByImpl(FloatMatrix.Rel<U> rel)
                                                               throws ValueException

Decrement the corresponding values of this Relative FloatMatrix from the values of this MutableFloatMatrix.
Only Relative values are allowed; subtracting an Absolute value from a Relative value is not allowed. Subtracting an Absolute value from an existing Absolute value would require the result to become Relative, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatMatrix.Rel<U>; the Relative FloatMatrix

Returns:

MutableFloatMatrix<U>; this modified MutableFloatMatrix

Throws:

ValueException - when the matrices do not have the same size

decrementBy

protected final MutableFloatMatrix.Rel<U> decrementBy(FloatMatrix.Abs<U> abs)
                                                               throws ValueException

Decrement the values in this Relative MutableFloatMatrix by the corresponding values in an Absolute FloatMatrix.

Parameters:

abs - FloatMatrix.Abs<U>; the Absolute FloatMatrix

Returns:

MutableFloatMatrix.Rel<U>; this modified Relative MutableFloatMatrix

Throws:

ValueException - when the matrices do not have the same size

scaleValueByValue

protected final void scaleValueByValue(FloatMatrix<?> factor)
                                throws ValueException

Scale the values in this MutableFloatMatrix by the corresponding values in a FloatMatrix.

Parameters:

factor - FloatMatrix<?>; contains the values by which to scale the corresponding values in this MutableFloatMatrix

Throws:

ValueException - when the matrices do not have the same size

scaleValueByValue

protected final MutableFloatMatrix<U> scaleValueByValue(float[][] factor)
                                                                 throws ValueException

Scale the values in this MutableFloatMatrix by the corresponding values in a float array.

Parameters:

factor - float[][]; contains the values by which to scale the corresponding values in this MutableFloatMatrix

Returns:

MutableFloatMatrix<U>; this modified MutableFloatMatrix

Throws:

ValueException - when the matrix and the array do not have the same size