org.djunits.value.vfloat.matrix

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

Type Parameters:

U - Unit; the unit of this MutableFloatMatrix

All Implemented Interfaces:

Serializable, Value<U>, FloatMatrixInterface<U>, MutableFloatMatrixInterface<U>

Direct Known Subclasses:

MutableFloatMatrix.Abs, MutableFloatMatrix.Rel

public abstract class MutableFloatMatrix<U extends Unit<U>>
extends FloatMatrix<U>
implements MutableFloatMatrixInterface<U>

MutableFloatMatrix.

This file was generated by the djunits value classes generator, 26 jun, 2015

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

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version 26 jun, 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>> ABSOLUTE implementation of MutableFloatVector.
static class	MutableFloatMatrix.Rel<U extends Unit<U>> RELATIVE implementation of MutableFloatMatrix.

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	assign(FloatFunction floatFunction) 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.
(package private) static <U extends Unit<U>> MutableFloatMatrix.Abs<U>	instantiateMutableAbs(FloatMatrixData dmData, U unit) Instantiate a matrix based on the type of data.
void	normalize() Normalize the matrix, i.e.
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.
(package private) void	setCopyOnWrite(boolean copyOnWrite) Change the copyOnWrite flag.
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.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.matrix.MutableFloatMatrixInterface

copy, immutable, toDense, toSparse

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

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

Constructor Detail

MutableFloatMatrix

protected MutableFloatMatrix(U unit)

Construct a new MutableFloatMatrix.

Parameters:

unit - U; the unit of the new MutableFloatMatrix

Method Detail

setCopyOnWrite

final void setCopyOnWrite(boolean copyOnWrite)

Change the copyOnWrite flag.

Parameters:

copyOnWrite - boolean; the new value for the copyOnWrite flag

instantiateMutableAbs

static <U extends Unit<U>> MutableFloatMatrix.Abs<U> instantiateMutableAbs(FloatMatrixData dmData,
                                                                           U unit)

Instantiate a matrix based on the type of data.

Type Parameters:

U - the unit

Parameters:

dmData - the FloatMatrixData

unit - the unit to use

Returns:

an instantiated vector

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 MutableFloatMatrixInterface<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 MutableFloatMatrixInterface<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 MutableFloatMatrixInterface<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(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 dense dataset if necessary.

Parameters:

floatFunction - the function to apply

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 MutableFloatMatrixInterface<U extends Unit<U>>

Throws:

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