org.djunits.value.vdouble.vector

Class MutableDoubleVector<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.MutableDoubleVector<U>

Type Parameters:

U - Unit; the unit of this MutableDoubleVector

All Implemented Interfaces:

Serializable, Value<U>, DoubleVectorInterface<U>, MutableDoubleVectorInterface<U>

Direct Known Subclasses:

MutableDoubleVector.Abs, MutableDoubleVector.Rel

public abstract class MutableDoubleVector<U extends Unit<U>>
extends DoubleVector<U>
implements MutableDoubleVectorInterface<U>

MutableDoubleVector.

This file was generated by the djunits value classes generator, 26 jun, 2015

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

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version 30 Oct, 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>> ABSOLUTE implementation of MutableDoubleVector.
static class	MutableDoubleVector.Rel<U extends Unit<U>> RELATIVE implementation of MutableDoubleVector.

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.DoubleVector

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	assign(DoubleFunction doubleFunction) 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.
(package private) static <U extends Unit<U>> MutableDoubleVector.Abs<U>	instantiateMutableAbs(DoubleVectorData dvData, U unit) Instantiate a vector based on the type of data.
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.
(package private) void	setCopyOnWrite(boolean copyOnWrite) Change the copyOnWrite flag.
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.djunits.value.vdouble.vector.DoubleVector

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.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.djunits.value.vdouble.vector.MutableDoubleVectorInterface

copy, immutable, toDense, toSparse

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

Constructor Detail

MutableDoubleVector

protected MutableDoubleVector(U unit)

Construct a new MutableDoubleVector.

Parameters:

unit - U; the unit of the new MutableDoubleVector

Method Detail

setCopyOnWrite

final void setCopyOnWrite(boolean copyOnWrite)

Change the copyOnWrite flag.

Parameters:

copyOnWrite - boolean; the new value for the copyOnWrite flag

instantiateMutableAbs

static <U extends Unit<U>> MutableDoubleVector.Abs<U> instantiateMutableAbs(DoubleVectorData dvData,
                                                                            U unit)

Instantiate a vector based on the type of data.

Type Parameters:

U - the unit

Parameters:

dvData - the DoubleVectorData

unit - the unit to use

Returns:

an instantiated vector

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 MutableDoubleVectorInterface<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 MutableDoubleVectorInterface<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 MutableDoubleVectorInterface<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(DoubleFunction doubleFunction)

Execute a function on a cell by cell basis. Note: because many functions have to act on zero cells or can generate cells with a zero value, the functions have to be applied on a dense dataset which has to be transformed back to a sparse dataset if necessary.

Parameters:

doubleFunction - the function to apply

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

Throws:

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