org.djunits.value.vdouble.matrix

Interface MutableDoubleMatrixInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Superinterfaces:

DoubleMatrixInterface<U>

All Known Implementing Classes:

MutableAbsoluteTemperatureMatrix, MutableAccelerationMatrix, MutableAngleMatrix, MutableAngleSolidMatrix, MutableAreaMatrix, MutableDensityMatrix, MutableDimensionlessMatrix, MutableDirectionMatrix, MutableDoubleMatrix, MutableDoubleMatrix.Abs, MutableDoubleMatrix.Rel, MutableDurationMatrix, MutableElectricalChargeMatrix, MutableElectricalCurrentMatrix, MutableElectricalPotentialMatrix, MutableElectricalResistanceMatrix, MutableEnergyMatrix, MutableFlowMassMatrix, MutableFlowVolumeMatrix, MutableForceMatrix, MutableFrequencyMatrix, MutableLengthMatrix, MutableLinearDensityMatrix, MutableMassMatrix, MutableMoneyMatrix, MutableMoneyPerAreaMatrix, MutableMoneyPerEnergyMatrix, MutableMoneyPerLengthMatrix, MutableMoneyPerMassMatrix, MutableMoneyPerTimeMatrix, MutableMoneyPerVolumeMatrix, MutablePositionMatrix, MutablePowerMatrix, MutablePressureMatrix, MutableSpeedMatrix, MutableTemperatureMatrix, MutableTimeMatrix, MutableTorqueMatrix, MutableTypedDoubleMatrixAbs, MutableTypedDoubleMatrixDimensionless, MutableTypedDoubleMatrixRel, MutableVolumeMatrix

public interface MutableDoubleMatrixInterface<U extends Unit<U>>
extends DoubleMatrixInterface<U>

Interface with specific (write) functions for the Mutable DoubleMatrix 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
MutableDoubleMatrixInterface<U>	copy() Create a deep copy of this MutableDoubleMatrix.
DoubleMatrixInterface<U>	immutable() Create a immutable version of this MutableDoubleMatrix.
void	normalize() Normalize the matrix, i.e.
void	set(int row, int column, DoubleScalar<U> value) Replace the value at row, column by the supplied value which is in a compatible unit.
void	setInUnit(int row, int column, double 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, double valueSI) Replace the value at row, column by the supplied value which is expressed in the standard SI unit.
MutableDoubleMatrixInterface<U>	toDense() Create a dense version of this DoubleMatrix.
MutableDoubleMatrixInterface<U>	toSparse() Create a sparse version of this DoubleMatrix.

Methods inherited from interface org.djunits.value.vdouble.matrix.DoubleMatrixInterface

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

Method Detail

copy

MutableDoubleMatrixInterface<U> copy()

Create a deep copy of this MutableDoubleMatrix.

Returns:

DoubleMatrix<U>; deep copy of this MutableDoubleMatrix

immutable

DoubleMatrixInterface<U> immutable()

Create a immutable version of this MutableDoubleMatrix.

Returns:

DoubleMatrix<U>; mutable version of this MutableDoubleMatrix

setSI

void setSI(int row,
           int column,
           double 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 - double; 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,
         DoubleScalar<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 - DoubleScalar<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,
               double 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 - double; 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

MutableDoubleMatrixInterface<U> toDense()

Create a dense version of this DoubleMatrix.

Specified by:

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

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

MutableDoubleMatrixInterface<U> toSparse()

Create a sparse version of this DoubleMatrix.

Specified by:

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

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix