org.opentrafficsim.core.value.vfloat.vector

Interface WriteFloatVectorFunctions<U extends Unit<U>>

Type Parameters:

U - Unit of the vector

All Known Implementing Classes:

MutableFloatVector, MutableFloatVector.Abs, MutableFloatVector.Abs.Dense, MutableFloatVector.Abs.Sparse, MutableFloatVector.Rel, MutableFloatVector.Rel.Dense, MutableFloatVector.Rel.Sparse

public interface WriteFloatVectorFunctions<U extends Unit<U>>

Methods that modify the data stored in a FloatVector.

This file was generated by the OpenTrafficSim value classes generator, 09 mrt, 2015

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

Version:

09 mrt, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

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