org.djunits.value.vdouble.vector

Class SpeedVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<SpeedUnit,SpeedVector,MutableSpeedVector,Speed>

org.djunits.value.vdouble.vector.SpeedVector

All Implemented Interfaces:

Serializable, Iterable<Speed>, Relative, Value<SpeedUnit>, DoubleVectorInterface<SpeedUnit>

public class SpeedVector
extends AbstractDoubleVectorRel<SpeedUnit,SpeedVector,MutableSpeedVector,Speed>

Immutable Double SpeedVector, a vector of values with a SpeedUnit.

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
SpeedVector(double[] values, SpeedUnit unit, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.
SpeedVector(DoubleVectorData data, SpeedUnit unit)
SpeedVector(List<Double> values, SpeedUnit unit, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.
SpeedVector(List<Speed> values, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.
SpeedVector(SortedMap<Integer,Double> values, SpeedUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.
SpeedVector(SortedMap<Integer,Speed> values, int length, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.
SpeedVector(Speed[] values, StorageType storageType) Construct a new Relative Immutable Double SpeedVector.

Method Summary

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

SpeedVector

public SpeedVector(double[] values,
                   SpeedUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

SpeedVector

public SpeedVector(List<Double> values,
                   SpeedUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

SpeedVector

public SpeedVector(Speed[] values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

SpeedVector

public SpeedVector(List<Speed> values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

SpeedVector

public SpeedVector(SortedMap<Integer,Speed> values,
                   int length,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

SpeedVector

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

Construct a new Relative Immutable Double SpeedVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

SpeedVector

SpeedVector(DoubleVectorData data,
            SpeedUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final SpeedVector instantiateType(DoubleVectorData dvd,
                                            SpeedUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<SpeedUnit,SpeedVector,MutableSpeedVector,Speed>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableSpeedVector instantiateMutableType(DoubleVectorData dvd,
                                                          SpeedUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<SpeedUnit,SpeedVector,MutableSpeedVector,Speed>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Speed instantiateScalar(double value,
                                        SpeedUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<SpeedUnit,SpeedVector,MutableSpeedVector,Speed>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final SpeedVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final SpeedVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Speed[] toArray()

Return an array of Speed Scalars from this vector.

Returns:

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

Throws:

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