org.djunits.value.vdouble.vector

Class LinearDensityVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<LinearDensityUnit,LinearDensityVector,MutableLinearDensityVector,LinearDensity>

org.djunits.value.vdouble.vector.LinearDensityVector

All Implemented Interfaces:

Serializable, Iterable<LinearDensity>, Relative, Value<LinearDensityUnit>, DoubleVectorInterface<LinearDensityUnit>

public class LinearDensityVector
extends AbstractDoubleVectorRel<LinearDensityUnit,LinearDensityVector,MutableLinearDensityVector,LinearDensity>

Immutable Double LinearDensityVector, a vector of values with a LinearDensityUnit.

Copyright (c) 2013-2019 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
LinearDensityVector(double[] values, LinearDensityUnit unit, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.
LinearDensityVector(DoubleVectorData data, LinearDensityUnit unit)
LinearDensityVector(LinearDensity[] values, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.
LinearDensityVector(List<Double> values, LinearDensityUnit unit, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.
LinearDensityVector(List<LinearDensity> values, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.
LinearDensityVector(SortedMap<Integer,Double> values, LinearDensityUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.
LinearDensityVector(SortedMap<Integer,LinearDensity> values, int length, StorageType storageType) Construct a new Relative Immutable Double LinearDensityVector.

Method Summary

Modifier and Type	Method and Description
protected MutableLinearDensityVector	instantiateMutableType(DoubleVectorData dvd, LinearDensityUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected LinearDensity	instantiateScalar(double value, LinearDensityUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected LinearDensityVector	instantiateType(DoubleVectorData dvd, LinearDensityUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
LinearDensity[]	toArray() Return an array of LinearDensity Scalars from this vector.
LinearDensityVector	toDense() return a dense version of this vector.
LinearDensityVector	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

LinearDensityVector

public LinearDensityVector(double[] values,
                           LinearDensityUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

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

unit - LinearDensityUnit; the unit of the new Relative Immutable Double LinearDensityVector

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

Throws:

ValueException - when values is null

LinearDensityVector

public LinearDensityVector(List<Double> values,
                           LinearDensityUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

values - List<Double>; the values of the entries in the new Relative Immutable Double LinearDensityVector

unit - LinearDensityUnit; the unit of the new Relative Immutable Double LinearDensityVector

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

Throws:

ValueException - when values is null

LinearDensityVector

public LinearDensityVector(LinearDensity[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

values - LinearDensity[]; the values of the entries in the new Relative Immutable Double LinearDensityVector

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

Throws:

ValueException - when values has zero entries

LinearDensityVector

public LinearDensityVector(List<LinearDensity> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

values - List<LinearDensity>; the values of the entries in the new Relative Immutable Double LinearDensityVector

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

Throws:

ValueException - when values has zero entries

LinearDensityVector

public LinearDensityVector(SortedMap<Integer,LinearDensity> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

values - SortedMap<Integer, LinearDensity>; the values of the entries in the new Relative Sparse Mutable Double LinearDensityVector

length - int; the size of the vector

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

Throws:

ValueException - when values has zero entries

LinearDensityVector

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

Construct a new Relative Immutable Double LinearDensityVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable Double LinearDensityVector

unit - LinearDensityUnit; the unit of the new Relative Sparse Mutable Double LinearDensityVector

length - int; the size of the vector

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

Throws:

ValueException - when values is null

LinearDensityVector

LinearDensityVector(DoubleVectorData data,
                    LinearDensityUnit unit)

Parameters:

data - DoubleVectorData; an internal data object

unit - LinearDensityUnit; the unit

Method Detail

instantiateType

protected final LinearDensityVector instantiateType(DoubleVectorData dvd,
                                                    LinearDensityUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<LinearDensityUnit,LinearDensityVector,MutableLinearDensityVector,LinearDensity>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableLinearDensityVector instantiateMutableType(DoubleVectorData dvd,
                                                                  LinearDensityUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<LinearDensityUnit,LinearDensityVector,MutableLinearDensityVector,LinearDensity>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final LinearDensity instantiateScalar(double value,
                                                LinearDensityUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<LinearDensityUnit,LinearDensityVector,MutableLinearDensityVector,LinearDensity>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final LinearDensityVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final LinearDensityVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public LinearDensity[] toArray()

Return an array of LinearDensity Scalars from this vector.

Returns:

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

Throws:

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