org.djunits.value.vfloat.matrix

Class MutableFloatLengthMatrix

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>

org.djunits.value.vfloat.matrix.MutableTypedFloatMatrixRel<LengthUnit,FloatLengthMatrix,MutableFloatLengthMatrix,FloatLength>

org.djunits.value.vfloat.matrix.MutableFloatLengthMatrix

All Implemented Interfaces:

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

public class MutableFloatLengthMatrix
extends MutableTypedFloatMatrixRel<LengthUnit,FloatLengthMatrix,MutableFloatLengthMatrix,FloatLength>

Mutable FloatLength Matrix.

Copyright (c) 2013-2016 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

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
MutableFloatLengthMatrix(float[][] values, LengthUnit unit, StorageType storageType) Construct a new Relative Mutable FloatLengthMatrix.
MutableFloatLengthMatrix(FloatLength[][] values, StorageType storageType) Construct a new Relative Mutable FloatLengthMatrix.
MutableFloatLengthMatrix(FloatMatrixData data, LengthUnit unit) Construct a new Relative Mutable FloatLengthMatrix.

Method Summary

Modifier and Type	Method and Description
FloatLength	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
protected MutableFloatLengthMatrix	instantiateMutableType(FloatMatrixData fmd, LengthUnit unit) Construct a new Relative Mutable FloatMatrix of the right type.
protected FloatLengthMatrix	instantiateType(FloatMatrixData fmd, LengthUnit unit) Construct a new Relative Immutable FloatMatrix of the right type.
MutableFloatPositionMatrix	toAbs() Translate the relative matrix into an absolute matrix (e.g., before or after a multiplication or division).

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

abs, ceil, copy, divide, divideBy, floor, immutable, minus, multiplyBy, mutable, plus, rint, round, times, toDense, toSparse

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

decrementBy, decrementBy, decrementBy, divide, divideBy, divideBy, incrementBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, plus, times

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

MutableFloatLengthMatrix

public MutableFloatLengthMatrix(float[][] values,
                                LengthUnit unit,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Mutable FloatLengthMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableFloatLengthMatrix

public MutableFloatLengthMatrix(FloatLength[][] values,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Mutable FloatLengthMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableFloatLengthMatrix

MutableFloatLengthMatrix(FloatMatrixData data,
                         LengthUnit unit)

Construct a new Relative Mutable FloatLengthMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatLengthMatrix instantiateType(FloatMatrixData fmd,
                                                  LengthUnit unit)

Construct a new Relative Immutable FloatMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class MutableTypedFloatMatrixRel<LengthUnit,FloatLengthMatrix,MutableFloatLengthMatrix,FloatLength>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatLengthMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                LengthUnit unit)

Construct a new Relative Mutable FloatMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class MutableTypedFloatMatrixRel<LengthUnit,FloatLengthMatrix,MutableFloatLengthMatrix,FloatLength>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

get

public final FloatLength 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<LengthUnit>

Specified by:

get in class MutableTypedFloatMatrixRel<LengthUnit,FloatLengthMatrix,MutableFloatLengthMatrix,FloatLength>

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

toAbs

public final MutableFloatPositionMatrix toAbs()

Translate the relative matrix into an absolute matrix (e.g., before or after a multiplication or division).

Returns:

an absolute version of this relative FloatLength matrix.