org.djunits.value.vfloat.matrix

Interface MutableFloatMatrixInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Superinterfaces:

FloatMatrixInterface<U>

All Known Implementing Classes:

MutableFloatAbsoluteTemperatureMatrix, MutableFloatAccelerationMatrix, MutableFloatAngleMatrix, MutableFloatAngleSolidMatrix, MutableFloatAreaMatrix, MutableFloatDensityMatrix, MutableFloatDimensionlessMatrix, MutableFloatDirectionMatrix, MutableFloatDurationMatrix, MutableFloatElectricalChargeMatrix, MutableFloatElectricalCurrentMatrix, MutableFloatElectricalPotentialMatrix, MutableFloatElectricalResistanceMatrix, MutableFloatEnergyMatrix, MutableFloatFlowMassMatrix, MutableFloatFlowVolumeMatrix, MutableFloatForceMatrix, MutableFloatFrequencyMatrix, MutableFloatLengthMatrix, MutableFloatLinearDensityMatrix, MutableFloatMassMatrix, MutableFloatMatrix, MutableFloatMatrix.Abs, MutableFloatMatrix.Rel, MutableFloatMoneyMatrix, MutableFloatMoneyPerAreaMatrix, MutableFloatMoneyPerEnergyMatrix, MutableFloatMoneyPerLengthMatrix, MutableFloatMoneyPerMassMatrix, MutableFloatMoneyPerTimeMatrix, MutableFloatMoneyPerVolumeMatrix, MutableFloatPositionMatrix, MutableFloatPowerMatrix, MutableFloatPressureMatrix, MutableFloatSpeedMatrix, MutableFloatTemperatureMatrix, MutableFloatTimeMatrix, MutableFloatTorqueMatrix, MutableFloatVolumeMatrix, MutableTypedFloatMatrixAbs, MutableTypedFloatMatrixDimensionless, MutableTypedFloatMatrixRel

public interface MutableFloatMatrixInterface<U extends Unit<U>>
extends FloatMatrixInterface<U>

Interface with specific (write) functions for the Mutable FloatMatrix classes.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 6, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
MutableFloatMatrixInterface<U>	copy() Create a deep copy of this MutableFloatMatrix.
FloatMatrixInterface<U>	immutable() Create a immutable version of this MutableFloatMatrix.
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.
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.
MutableFloatMatrixInterface<U>	toDense() Create a dense version of this FloatMatrix.
MutableFloatMatrixInterface<U>	toSparse() Create a sparse version of this FloatMatrix.

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

Method Detail

copy

MutableFloatMatrixInterface<U> copy()

Create a deep copy of this MutableFloatMatrix.

Returns:

FloatMatrix<U>; deep copy of this MutableFloatMatrix

immutable

FloatMatrixInterface<U> immutable()

Create a immutable version of this MutableFloatMatrix.

Returns:

FloatMatrix<U>; mutable version of this MutableFloatMatrix

setSI

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.

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

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.

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

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.

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

normalize

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

toDense

MutableFloatMatrixInterface<U> toDense()

Create a dense version of this FloatMatrix.

Specified by:

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

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

MutableFloatMatrixInterface<U> toSparse()

Create a sparse version of this FloatMatrix.

Specified by:

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

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix