org.djunits.value.vdouble.vector

Class DensityVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<DensityUnit,DensityVector,MutableDensityVector,Density>

org.djunits.value.vdouble.vector.DensityVector

All Implemented Interfaces:

Serializable, Iterable<Density>, Relative, Value<DensityUnit>, DoubleVectorInterface<DensityUnit>

public class DensityVector
extends AbstractDoubleVectorRel<DensityUnit,DensityVector,MutableDensityVector,Density>

Immutable Double DensityVector, a vector of values with a DensityUnit.

Copyright (c) 2013-2018 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 9, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
DensityVector(Density[] values, StorageType storageType) Construct a new Relative Immutable Double DensityVector.
DensityVector(double[] values, DensityUnit unit, StorageType storageType) Construct a new Relative Immutable Double DensityVector.
DensityVector(DoubleVectorData data, DensityUnit unit)
DensityVector(List<Density> values, StorageType storageType) Construct a new Relative Immutable Double DensityVector.
DensityVector(List<Double> values, DensityUnit unit, StorageType storageType) Construct a new Relative Immutable Double DensityVector.
DensityVector(SortedMap<Integer,Density> values, int length, StorageType storageType) Construct a new Relative Immutable Double DensityVector.
DensityVector(SortedMap<Integer,Double> values, DensityUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double DensityVector.

Method Summary

Modifier and Type	Method and Description
protected MutableDensityVector	instantiateMutableType(DoubleVectorData dvd, DensityUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Density	instantiateScalar(double value, DensityUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected DensityVector	instantiateType(DoubleVectorData dvd, DensityUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Density[]	toArray() Return an array of Density Scalars from this vector.
DensityVector	toDense() return a dense version of this vector.
DensityVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

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

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DensityVector

public DensityVector(double[] values,
                     DensityUnit unit,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - double[]; the values of the entries in the new Relative Immutable Double DensityVector

unit - U; the unit of the new Relative Immutable Double DensityVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

DensityVector

public DensityVector(List<Double> values,
                     DensityUnit unit,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double DensityVector

unit - U; the unit of the new Relative Immutable Double DensityVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

DensityVector

public DensityVector(Density[] values,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double DensityVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

DensityVector

public DensityVector(List<Density> values,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double DensityVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

DensityVector

public DensityVector(SortedMap<Integer,Density> values,
                     int length,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double DensityVector

length - the size of the vector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

DensityVector

public DensityVector(SortedMap<Integer,Double> values,
                     DensityUnit unit,
                     int length,
                     StorageType storageType)
              throws ValueException

Construct a new Relative Immutable Double DensityVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Double DensityVector

unit - U; the unit of the new Relative Sparse Mutable Double DensityVector

length - the size of the vector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

DensityVector

DensityVector(DoubleVectorData data,
              DensityUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final DensityVector instantiateType(DoubleVectorData dvd,
                                              DensityUnit unit)

Construct a new Relative Immutable DoubleVector of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class AbstractDoubleVectorRel<DensityUnit,DensityVector,MutableDensityVector,Density>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableDensityVector instantiateMutableType(DoubleVectorData dvd,
                                                            DensityUnit unit)

Construct a new Relative Mutable DoubleVector of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<DensityUnit,DensityVector,MutableDensityVector,Density>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Density instantiateScalar(double value,
                                          DensityUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<DensityUnit,DensityVector,MutableDensityVector,Density>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final DensityVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final DensityVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Density[] toArray()

Return an array of Density Scalars from this vector.

Returns:

Density[]; an array of Density Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values