org.djunits.value.vfloat.vector

Interface MutableFloatVectorInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Superinterfaces:

FloatVectorInterface<U>

All Known Implementing Classes:

MutableFloatAbsoluteTemperatureVector, MutableFloatAccelerationVector, MutableFloatAngleSolidVector, MutableFloatAngleVector, MutableFloatAreaVector, MutableFloatDensityVector, MutableFloatDimensionlessVector, MutableFloatDirectionVector, MutableFloatDurationVector, MutableFloatElectricalChargeVector, MutableFloatElectricalCurrentVector, MutableFloatElectricalPotentialVector, MutableFloatElectricalResistanceVector, MutableFloatEnergyVector, MutableFloatFlowMassVector, MutableFloatFlowVolumeVector, MutableFloatForceVector, MutableFloatFrequencyVector, MutableFloatLengthVector, MutableFloatLinearDensityVector, MutableFloatMassVector, MutableFloatMoneyPerAreaVector, MutableFloatMoneyPerEnergyVector, MutableFloatMoneyPerLengthVector, MutableFloatMoneyPerMassVector, MutableFloatMoneyPerTimeVector, MutableFloatMoneyPerVolumeVector, MutableFloatMoneyVector, MutableFloatPositionVector, MutableFloatPowerVector, MutableFloatPressureVector, MutableFloatSpeedVector, MutableFloatTemperatureVector, MutableFloatTimeVector, MutableFloatTorqueVector, MutableFloatVector, MutableFloatVector.Abs, MutableFloatVector.Rel, MutableFloatVolumeVector, MutableTypedFloatVectorAbs, MutableTypedFloatVectorDimensionless, MutableTypedFloatVectorRel

public interface MutableFloatVectorInterface<U extends Unit<U>>
extends FloatVectorInterface<U>

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
MutableFloatVectorInterface<U>	copy() Create a deep copy of this MutableFloatVector.
FloatVectorInterface<U>	immutable() Create a immutable version of this MutableFloatVector.
void	normalize() Normalize the vector, i.e.
void	set(int index, FloatScalar<U> value) Replace the value at index by the supplied value which is in a compatible unit.
void	setInUnit(int index, float value, U valueUnit) Replace the value at index by the supplied value which is expressed in a supplied (compatible) unit.
void	setSI(int index, float valueSI) Replace the value at index by the supplied value which is expressed in the standard SI unit.
MutableFloatVectorInterface<U>	toDense() Create a dense version of this FloatVector.
MutableFloatVectorInterface<U>	toSparse() Create a sparse version of this FloatVector.

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

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

Method Detail

copy

MutableFloatVectorInterface<U> copy()

Create a deep copy of this MutableFloatVector.

Returns:

FloatVector<U>; deep copy of this MutableFloatVector

immutable

FloatVectorInterface<U> immutable()

Create a immutable version of this MutableFloatVector.

Returns:

FloatVector<U>; mutable version of this MutableFloatVector

setSI

void setSI(int index,
           float 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 - float; 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,
         FloatScalar<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 - FloatScalar<U>; the strongly typed value to store

Throws:

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

setInUnit

void setInUnit(int index,
               float 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 - float; 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

MutableFloatVectorInterface<U> toDense()

Create a dense version of this FloatVector.

Specified by:

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

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

MutableFloatVectorInterface<U> toSparse()

Create a sparse version of this FloatVector.

Specified by:

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

Returns:

MutableFloatVector<U>; sparse version of this FloatVector