org.opentrafficsim.core.value.vfloat.vector

Class MutableFloatVector<U extends Unit<U>>

java.lang.Object

org.opentrafficsim.core.value.AbstractValue<U>

org.opentrafficsim.core.value.vfloat.vector.FloatVector<U>

org.opentrafficsim.core.value.vfloat.vector.MutableFloatVector<U>

Type Parameters:

U - Unit; the unit of this MutableFloatVector

All Implemented Interfaces:

Serializable, MathFunctions<MutableFloatVector<U>>, Value<U>, FloatMathFunctions<MutableFloatVector<U>>, ReadOnlyFloatVectorFunctions<U>, WriteFloatVectorFunctions<U>

Direct Known Subclasses:

MutableFloatVector.Abs, MutableFloatVector.Rel

public abstract class MutableFloatVector<U extends Unit<U>>
extends FloatVector<U>
implements WriteFloatVectorFunctions<U>, FloatMathFunctions<MutableFloatVector<U>>

MutableFloatVector.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MutableFloatVector.Abs<U extends Unit<U>>
static class	MutableFloatVector.Rel<U extends Unit<U>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableFloatVector(U unit) Construct a new MutableFloatVector.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(cern.colt.function.tfloat.FloatFunction f) Execute a function on a cell by cell basis.
protected void	checkCopyOnWrite() Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.
protected MutableFloatVector.Rel<U>	decrementBy(FloatVector.Abs<U> abs) Decrement the values in this Relative MutableFloatVector by the corresponding values in an Absolute FloatVector.
protected MutableFloatVector<U>	decrementByImpl(FloatVector.Rel<U> rel) Decrement the corresponding values of this Relative FloatVector from the values of this MutableFloatVector.
MutableFloatVector<U>	divide(float constant) Scale the value(s) by the inverse of a factor; i.e.
abstract FloatVector<U>	immutable() Make (immutable) FloatVector equivalent for any type of MutableFloatVector.
protected MutableFloatVector<U>	incrementByImpl(FloatVector.Rel<U> rel) Increment the values in this MutableFloatVector by the corresponding values in a Relative FloatVector.
MutableFloatVector<U>	multiply(float constant) Scale the value(s) by a factor.
void	normalize() Normalize the vector, i.e.
protected MutableFloatVector<U>	scaleValueByValue(float[] factor) Scale the values in this MutableFloatVector by the corresponding values in a float array.
protected void	scaleValueByValue(FloatVector<?> factor) Scale the values in this MutableFloatVector by the corresponding values in a FloatVector.
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.

Methods inherited from class org.opentrafficsim.core.value.vfloat.vector.FloatVector

cardinality, checkIndex, checkNonEmpty, checkSize, checkSize, createMatrix1D, deepCopyData, deepCopyOfData, denseToSparse, denseToSparse, equals, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, getVectorSI, hashCode, initialize, initialize, initialize, interpolate, interpolate, interpolate, interpolate, minus, minus, minus, minus, minus, minus, minus, minus, minus, mutable, plus, plus, plus, plus, plus, plus, safeGet, safeSet, size, sparseToDense, sparseToDense, times, times, times, times, times, times, times, times, times, times, toString, toString, toString, toString, zSum

Methods inherited from class org.opentrafficsim.core.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.core.value.MathFunctions

abs, acos, asin, atan, cbrt, ceil, cos, cosh, exp, expm1, floor, inv, log, log10, log1p, pow, rint, round, signum, sin, sinh, sqrt, tan, tanh, toDegrees, toRadians

Methods inherited from interface org.opentrafficsim.core.value.vfloat.vector.ReadOnlyFloatVectorFunctions

get

Methods inherited from interface org.opentrafficsim.core.value.Value

copy

Constructor Detail

MutableFloatVector

protected MutableFloatVector(U unit)

Construct a new MutableFloatVector.

Parameters:

unit - U; the unit of the new MutableFloatVector

Method Detail

normalize

public final void normalize()
                     throws ValueException

Normalize the vector, i.e. scale the values to make the sum equal to 1.

Specified by:

normalize in interface WriteFloatVectorFunctions<U extends Unit<U>>

Throws:

ValueException - when the sum of the values is zero and normalization is not possible

immutable

public abstract FloatVector<U> immutable()

Make (immutable) FloatVector equivalent for any type of MutableFloatVector.

Returns:

FloatVector<U>; immutable version of this FloatVector

checkCopyOnWrite

protected final void checkCopyOnWrite()

Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.

setSI

public final 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.

Specified by:

setSI in interface WriteFloatVectorFunctions<U extends Unit<U>>

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

public final void set(int index,
       FloatScalar<U> value)
               throws ValueException

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

Specified by:

set in interface WriteFloatVectorFunctions<U extends Unit<U>>

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

public final 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.

Specified by:

setInUnit in interface WriteFloatVectorFunctions<U extends Unit<U>>

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

assign

public final void assign(cern.colt.function.tfloat.FloatFunction f)

Execute a function on a cell by cell basis.

Parameters:

f - cern.colt.function.tfloat.FloatFunction; the function to apply

multiply

public final MutableFloatVector<U> multiply(float constant)

Scale the value(s) by a factor.

Specified by:

multiply in interface FloatMathFunctions<MutableFloatVector<U extends Unit<U>>>

Parameters:

constant - float; the multiplier

Returns:

T; the modified T

divide

public final MutableFloatVector<U> divide(float constant)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divide in interface FloatMathFunctions<MutableFloatVector<U extends Unit<U>>>

Parameters:

constant - float; the divisor

Returns:

T; the modified T

incrementByImpl

protected final MutableFloatVector<U> incrementByImpl(FloatVector.Rel<U> rel)
                                                               throws ValueException

Increment the values in this MutableFloatVector by the corresponding values in a Relative FloatVector.
Only Relative values are allowed; adding an Absolute value to an Absolute value is not allowed. Adding an Absolute value to an existing Relative value would require the result to become Absolute, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatVector.Rel<U>; the Relative FloatVector

Returns:

MutableFloatVector<U>; this modified MutableFloatVector

Throws:

ValueException - when the vectors do not have the same size

decrementByImpl

protected final MutableFloatVector<U> decrementByImpl(FloatVector.Rel<U> rel)
                                                               throws ValueException

Decrement the corresponding values of this Relative FloatVector from the values of this MutableFloatVector.
Only Relative values are allowed; subtracting an Absolute value from a Relative value is not allowed. Subtracting an Absolute value from an existing Absolute value would require the result to become Relative, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatVector.Rel<U>; the Relative FloatVector

Returns:

MutableFloatVector<U>; this modified MutableFloatVector

Throws:

ValueException - when the vectors do not have the same size

decrementBy

protected final MutableFloatVector.Rel<U> decrementBy(FloatVector.Abs<U> abs)
                                                               throws ValueException

Decrement the values in this Relative MutableFloatVector by the corresponding values in an Absolute FloatVector.

Parameters:

abs - FloatVector.Abs<U>; the Absolute FloatVector

Returns:

MutableFloatVector.Rel<U>; this modified Relative MutableFloatVector

Throws:

ValueException - when the vectors do not have the same size

scaleValueByValue

protected final void scaleValueByValue(FloatVector<?> factor)
                                throws ValueException

Scale the values in this MutableFloatVector by the corresponding values in a FloatVector.

Parameters:

factor - FloatVector<?>; contains the values by which to scale the corresponding values in this MutableFloatVector

Throws:

ValueException - when the vectors do not have the same size

scaleValueByValue

protected final MutableFloatVector<U> scaleValueByValue(float[] factor)
                                                                 throws ValueException

Scale the values in this MutableFloatVector by the corresponding values in a float array.

Parameters:

factor - float[]; contains the values by which to scale the corresponding values in this MutableFloatVector

Returns:

MutableFloatVector<U>; this modified MutableFloatVector

Throws:

ValueException - when the vector and the array do not have the same size