org.opentrafficsim.core.value.vdouble.vector

Class MutableDoubleVector<U extends Unit<U>>

java.lang.Object

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

org.opentrafficsim.core.value.vdouble.vector.DoubleVector<U>

org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector<U>

Type Parameters:

U - Unit; the unit of this MutableDoubleVector

All Implemented Interfaces:

Serializable, MathFunctions<MutableDoubleVector<U>>, Value<U>, DoubleMathFunctions<MutableDoubleVector<U>>, ReadOnlyDoubleVectorFunctions<U>, WriteDoubleVectorFunctions<U>

Direct Known Subclasses:

MutableDoubleVector.Abs, MutableDoubleVector.Rel

public abstract class MutableDoubleVector<U extends Unit<U>>
extends DoubleVector<U>
implements WriteDoubleVectorFunctions<U>, DoubleMathFunctions<MutableDoubleVector<U>>

MutableDoubleVector.

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	MutableDoubleVector.Abs<U extends Unit<U>>
static class	MutableDoubleVector.Rel<U extends Unit<U>>

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(cern.colt.function.tdouble.DoubleFunction d) 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 MutableDoubleVector.Rel<U>	decrementBy(DoubleVector.Abs<U> abs) Decrement the values in this Relative MutableDoubleVector by the corresponding values in an Absolute DoubleVector.
protected MutableDoubleVector<U>	decrementByImpl(DoubleVector.Rel<U> rel) Decrement the corresponding values of this Relative DoubleVector from the values of this MutableDoubleVector.
MutableDoubleVector<U>	divide(double constant) Scale the value(s) by the inverse of a factor; i.e.
abstract DoubleVector<U>	immutable() Make (immutable) DoubleVector equivalent for any type of MutableDoubleVector.
protected MutableDoubleVector<U>	incrementByImpl(DoubleVector.Rel<U> rel) Increment the values in this MutableDoubleVector by the corresponding values in a Relative DoubleVector.
MutableDoubleVector<U>	multiply(double constant) Scale the value(s) by a factor.
void	normalize() Normalize the vector, i.e.
protected MutableDoubleVector<U>	scaleValueByValue(double[] factor) Scale the values in this MutableDoubleVector by the corresponding values in a double array.
protected void	scaleValueByValue(DoubleVector<?> factor) Scale the values in this MutableDoubleVector by the corresponding values in a DoubleVector.
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.

Methods inherited from class org.opentrafficsim.core.value.vdouble.vector.DoubleVector

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.vdouble.vector.ReadOnlyDoubleVectorFunctions

get

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

copy

Constructor Detail

MutableDoubleVector

protected MutableDoubleVector(U unit)

Construct a new MutableDoubleVector.

Parameters:

unit - U; the unit of the new MutableDoubleVector

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 WriteDoubleVectorFunctions<U extends Unit<U>>

Throws:

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

immutable

public abstract DoubleVector<U> immutable()

Make (immutable) DoubleVector equivalent for any type of MutableDoubleVector.

Returns:

DoubleVector<U>; immutable version of this DoubleVector

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,
         double 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 WriteDoubleVectorFunctions<U extends Unit<U>>

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

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

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

Specified by:

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

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

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

Specified by:

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

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

assign

public final void assign(cern.colt.function.tdouble.DoubleFunction d)

Execute a function on a cell by cell basis.

Parameters:

d - cern.colt.function.tdouble.DoubleFunction; the function to apply

multiply

public final MutableDoubleVector<U> multiply(double constant)

Scale the value(s) by a factor.

Specified by:

multiply in interface DoubleMathFunctions<MutableDoubleVector<U extends Unit<U>>>

Parameters:

constant - double; the multiplier

Returns:

T; the modified T

divide

public final MutableDoubleVector<U> divide(double constant)

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

Specified by:

divide in interface DoubleMathFunctions<MutableDoubleVector<U extends Unit<U>>>

Parameters:

constant - double; the divisor

Returns:

T; the modified T

incrementByImpl

protected final MutableDoubleVector<U> incrementByImpl(DoubleVector.Rel<U> rel)
                                                                throws ValueException

Increment the values in this MutableDoubleVector by the corresponding values in a Relative DoubleVector.
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 - DoubleVector.Rel<U>; the Relative DoubleVector

Returns:

MutableDoubleVector<U>; this modified MutableDoubleVector

Throws:

ValueException - when the vectors do not have the same size

decrementByImpl

protected final MutableDoubleVector<U> decrementByImpl(DoubleVector.Rel<U> rel)
                                                                throws ValueException

Decrement the corresponding values of this Relative DoubleVector from the values of this MutableDoubleVector.
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 - DoubleVector.Rel<U>; the Relative DoubleVector

Returns:

MutableDoubleVector<U>; this modified MutableDoubleVector

Throws:

ValueException - when the vectors do not have the same size

decrementBy

protected final MutableDoubleVector.Rel<U> decrementBy(DoubleVector.Abs<U> abs)
                                                                throws ValueException

Decrement the values in this Relative MutableDoubleVector by the corresponding values in an Absolute DoubleVector.

Parameters:

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

Returns:

MutableDoubleVector.Rel<U>; this modified Relative MutableDoubleVector

Throws:

ValueException - when the vectors do not have the same size

scaleValueByValue

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

Scale the values in this MutableDoubleVector by the corresponding values in a DoubleVector.

Parameters:

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

Throws:

ValueException - when the vectors do not have the same size

scaleValueByValue

protected final MutableDoubleVector<U> scaleValueByValue(double[] factor)
                                                                  throws ValueException

Scale the values in this MutableDoubleVector by the corresponding values in a double array.

Parameters:

factor - double[]; contains the values by which to scale the corresponding values in this MutableDoubleVector

Returns:

MutableDoubleVector<U>; this modified MutableDoubleVector

Throws:

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