org.djunits.value.vdouble.vector

Interface MutableDoubleVectorInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Superinterfaces:

DoubleVectorInterface<U>

All Known Implementing Classes:

MutableAccelerationVector, MutableAccelerationVector.Dense, MutableAccelerationVector.Sparse, MutableAnglePlaneVector.Abs, MutableAnglePlaneVector.Abs.Dense, MutableAnglePlaneVector.Abs.Sparse, MutableAnglePlaneVector.Rel, MutableAnglePlaneVector.Rel.Dense, MutableAnglePlaneVector.Rel.Sparse, MutableAngleSlopeVector.Abs, MutableAngleSlopeVector.Abs.Dense, MutableAngleSlopeVector.Abs.Sparse, MutableAngleSlopeVector.Rel, MutableAngleSlopeVector.Rel.Dense, MutableAngleSlopeVector.Rel.Sparse, MutableAngleSolidVector, MutableAngleSolidVector.Dense, MutableAngleSolidVector.Sparse, MutableAreaVector, MutableAreaVector.Dense, MutableAreaVector.Sparse, MutableDensityVector, MutableDensityVector.Dense, MutableDensityVector.Sparse, MutableDimensionlessVector.Abs, MutableDimensionlessVector.Abs.Dense, MutableDimensionlessVector.Abs.Sparse, MutableDimensionlessVector.Rel, MutableDimensionlessVector.Rel.Dense, MutableDimensionlessVector.Rel.Sparse, MutableDoubleVector, MutableDoubleVector.Abs, MutableDoubleVector.Abs.Dense, MutableDoubleVector.Abs.Sparse, MutableDoubleVector.Rel, MutableDoubleVector.Rel.Dense, MutableDoubleVector.Rel.Sparse, MutableElectricalChargeVector, MutableElectricalChargeVector.Dense, MutableElectricalChargeVector.Sparse, MutableElectricalCurrentVector, MutableElectricalCurrentVector.Dense, MutableElectricalCurrentVector.Sparse, MutableElectricalPotentialVector, MutableElectricalPotentialVector.Dense, MutableElectricalPotentialVector.Sparse, MutableElectricalResistanceVector, MutableElectricalResistanceVector.Dense, MutableElectricalResistanceVector.Sparse, MutableEnergyVector, MutableEnergyVector.Dense, MutableEnergyVector.Sparse, MutableFlowMassVector, MutableFlowMassVector.Dense, MutableFlowMassVector.Sparse, MutableFlowVolumeVector, MutableFlowVolumeVector.Dense, MutableFlowVolumeVector.Sparse, MutableForceVector, MutableForceVector.Dense, MutableForceVector.Sparse, MutableFrequencyVector, MutableFrequencyVector.Dense, MutableFrequencyVector.Sparse, MutableLengthVector.Abs, MutableLengthVector.Abs.Dense, MutableLengthVector.Abs.Sparse, MutableLengthVector.Rel, MutableLengthVector.Rel.Dense, MutableLengthVector.Rel.Sparse, MutableLinearDensityVector, MutableLinearDensityVector.Dense, MutableLinearDensityVector.Sparse, MutableMassVector, MutableMassVector.Dense, MutableMassVector.Sparse, MutableMoneyPerAreaVector, MutableMoneyPerAreaVector.Dense, MutableMoneyPerAreaVector.Sparse, MutableMoneyPerEnergyVector, MutableMoneyPerEnergyVector.Dense, MutableMoneyPerEnergyVector.Sparse, MutableMoneyPerLengthVector, MutableMoneyPerLengthVector.Dense, MutableMoneyPerLengthVector.Sparse, MutableMoneyPerMassVector, MutableMoneyPerMassVector.Dense, MutableMoneyPerMassVector.Sparse, MutableMoneyPerTimeVector, MutableMoneyPerTimeVector.Dense, MutableMoneyPerTimeVector.Sparse, MutableMoneyPerVolumeVector, MutableMoneyPerVolumeVector.Dense, MutableMoneyPerVolumeVector.Sparse, MutableMoneyVector, MutableMoneyVector.Dense, MutableMoneyVector.Sparse, MutablePowerVector, MutablePowerVector.Dense, MutablePowerVector.Sparse, MutablePressureVector, MutablePressureVector.Dense, MutablePressureVector.Sparse, MutableSpeedVector, MutableSpeedVector.Dense, MutableSpeedVector.Sparse, MutableTemperatureVector.Abs, MutableTemperatureVector.Abs.Dense, MutableTemperatureVector.Abs.Sparse, MutableTemperatureVector.Rel, MutableTemperatureVector.Rel.Dense, MutableTemperatureVector.Rel.Sparse, MutableTimeVector.Abs, MutableTimeVector.Abs.Dense, MutableTimeVector.Abs.Sparse, MutableTimeVector.Rel, MutableTimeVector.Rel.Dense, MutableTimeVector.Rel.Sparse, MutableTorqueVector, MutableTorqueVector.Dense, MutableTorqueVector.Sparse, MutableVolumeVector, MutableVolumeVector.Dense, MutableVolumeVector.Sparse

public interface MutableDoubleVectorInterface<U extends Unit<U>>
extends DoubleVectorInterface<U>

Copyright (c) 2013-2015 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
MutableDoubleVectorInterface<U>	copy() Create a deep copy of this MutableDoubleVector.
DoubleVectorInterface<U>	immutable() Create a immutable version of this MutableDoubleVector.
void	normalize() Normalize the vector, i.e.
void	set(int index, DoubleScalar<U> value) Replace the value at index by the supplied value which is in a compatible unit.
void	setInUnit(int index, double value, U valueUnit) Replace the value at index by the supplied value which is expressed in a supplied (compatible) unit.
void	setSI(int index, double valueSI) Replace the value at index by the supplied value which is expressed in the standard SI unit.
MutableDoubleVectorInterface<U>	toDense() Create a dense version of this DoubleVector.
MutableDoubleVectorInterface<U>	toSparse() Create a sparse version of this DoubleVector.

Methods inherited from interface org.djunits.value.vdouble.vector.DoubleVectorInterface

cardinality, get, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, mutable, size, toString, toString, toString, toString, zSum

Method Detail

copy

MutableDoubleVectorInterface<U> copy()

Create a deep copy of this MutableDoubleVector.

Returns:

DoubleVector<U>; deep copy of this MutableDoubleVector

immutable

DoubleVectorInterface<U> immutable()

Create a immutable version of this MutableDoubleVector.

Returns:

DoubleVector<U>; mutable version of this MutableDoubleVector

setSI

void setSI(int index,
           double valueSI)
    throws ValueException

Replace the value at index by the supplied value which is expressed in the standard SI unit.

Parameters:

index - int; index of the value to replace

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

Throws:

ValueException - when index out of range (index < 0 or index >= size())

set

void set(int index,
         DoubleScalar<U> value)
  throws ValueException

Replace the value at index by the supplied value which is in a compatible unit.

Parameters:

index - int; index of the value to replace

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

Throws:

ValueException - when index out of range (index < 0 or index >= size())

setInUnit

void setInUnit(int index,
               double value,
               U valueUnit)
        throws ValueException

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

Parameters:

index - int; index 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 index out of range (index < 0 or index >= size())

normalize

void normalize()
        throws ValueException

Normalize the vector, 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

MutableDoubleVectorInterface<U> toDense()

Create a dense version of this DoubleVector.

Specified by:

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

Returns:

MutableDoubleVector<U>; dense version of this DoubleVector

toSparse

MutableDoubleVectorInterface<U> toSparse()

Create a sparse version of this DoubleVector.

Specified by:

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

Returns:

MutableDoubleVector<U>; sparse version of this DoubleVector