org.djunits.value.vfloat.vector

Class FloatLinearDensityVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<LinearDensityUnit,FloatLinearDensityVector,MutableFloatLinearDensityVector,FloatLinearDensity>

org.djunits.value.vfloat.vector.FloatLinearDensityVector

All Implemented Interfaces:

Serializable, Iterable<FloatLinearDensity>, Relative, Value<LinearDensityUnit>, FloatVectorInterface<LinearDensityUnit>

public class FloatLinearDensityVector
extends AbstractFloatVectorRel<LinearDensityUnit,FloatLinearDensityVector,MutableFloatLinearDensityVector,FloatLinearDensity>

Immutable Float FloatLinearDensityVector, 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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

data

Constructor Summary

Constructors

Constructor and Description
FloatLinearDensityVector(float[] values, LinearDensityUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.
FloatLinearDensityVector(FloatLinearDensity[] values, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.
FloatLinearDensityVector(FloatVectorData data, LinearDensityUnit unit)
FloatLinearDensityVector(List<Float> values, LinearDensityUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.
FloatLinearDensityVector(List<FloatLinearDensity> values, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.
FloatLinearDensityVector(SortedMap<Integer,Float> values, LinearDensityUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.
FloatLinearDensityVector(SortedMap<Integer,FloatLinearDensity> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatLinearDensityVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatLinearDensityVector	instantiateMutableType(FloatVectorData dvd, LinearDensityUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatLinearDensity	instantiateScalar(float value, LinearDensityUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatLinearDensityVector	instantiateType(FloatVectorData dvd, LinearDensityUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatLinearDensity[]	toArray() Return an array of FloatLinearDensity Scalars from this vector.
FloatLinearDensityVector	toDense() return a dense version of this vector.
FloatLinearDensityVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVectorRel

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

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

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

FloatLinearDensityVector

public FloatLinearDensityVector(float[] values,
                                LinearDensityUnit unit,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

values - float[]; the values of the entries in the new Relative Immutable Float FloatLinearDensityVector

unit - LinearDensityUnit; the unit of the new Relative Immutable Float FloatLinearDensityVector

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

Throws:

ValueException - when values is null

FloatLinearDensityVector

public FloatLinearDensityVector(List<Float> values,
                                LinearDensityUnit unit,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

values - List<Float>; the values of the entries in the new Relative Immutable Float FloatLinearDensityVector

unit - LinearDensityUnit; the unit of the new Relative Immutable Float FloatLinearDensityVector

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

Throws:

ValueException - when values is null

FloatLinearDensityVector

public FloatLinearDensityVector(FloatLinearDensity[] values,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

values - FloatLinearDensity[]; the values of the entries in the new Relative Immutable Float FloatLinearDensityVector

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

Throws:

ValueException - when values has zero entries

FloatLinearDensityVector

public FloatLinearDensityVector(List<FloatLinearDensity> values,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

values - List<FloatLinearDensity>; the values of the entries in the new Relative Immutable Float FloatLinearDensityVector

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

Throws:

ValueException - when values has zero entries

FloatLinearDensityVector

public FloatLinearDensityVector(SortedMap<Integer,FloatLinearDensity> values,
                                int length,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

values - SortedMap<Integer, FloatLinearDensity>; the values of the entries in the new Relative Sparse Mutable Float FloatLinearDensityVector

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

FloatLinearDensityVector

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

Construct a new Relative Immutable Float FloatLinearDensityVector.

Parameters:

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

unit - LinearDensityUnit; the unit of the new Relative Sparse Mutable Float FloatLinearDensityVector

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

FloatLinearDensityVector

FloatLinearDensityVector(FloatVectorData data,
                         LinearDensityUnit unit)

Parameters:

data - FloatVectorData; an internal data object

unit - LinearDensityUnit; the unit

Method Detail

instantiateType

protected final FloatLinearDensityVector instantiateType(FloatVectorData dvd,
                                                         LinearDensityUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<LinearDensityUnit,FloatLinearDensityVector,MutableFloatLinearDensityVector,FloatLinearDensity>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatLinearDensityVector instantiateMutableType(FloatVectorData dvd,
                                                                       LinearDensityUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<LinearDensityUnit,FloatLinearDensityVector,MutableFloatLinearDensityVector,FloatLinearDensity>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatLinearDensity instantiateScalar(float value,
                                                     LinearDensityUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<LinearDensityUnit,FloatLinearDensityVector,MutableFloatLinearDensityVector,FloatLinearDensity>

Parameters:

value - float; the value

unit - U; the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatLinearDensityVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatLinearDensityVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatLinearDensity[] toArray()

Return an array of FloatLinearDensity Scalars from this vector.

Returns:

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

Throws:

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