org.djunits.value.vdouble.vector

Class AccelerationVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<AccelerationUnit,AccelerationVector,MutableAccelerationVector,Acceleration>

org.djunits.value.vdouble.vector.AccelerationVector

All Implemented Interfaces:

Serializable, Iterable<Acceleration>, Relative, Value<AccelerationUnit>, DoubleVectorInterface<AccelerationUnit>

public class AccelerationVector
extends AbstractDoubleVectorRel<AccelerationUnit,AccelerationVector,MutableAccelerationVector,Acceleration>

Immutable Double AccelerationVector, a vector of values with a AccelerationUnit.

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

Method Summary

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

AccelerationVector

public AccelerationVector(double[] values,
                          AccelerationUnit unit,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

AccelerationVector

public AccelerationVector(List<Double> values,
                          AccelerationUnit unit,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

AccelerationVector

public AccelerationVector(Acceleration[] values,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AccelerationVector

public AccelerationVector(List<Acceleration> values,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AccelerationVector

public AccelerationVector(SortedMap<Integer,Acceleration> values,
                          int length,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

AccelerationVector

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

Construct a new Relative Immutable Double AccelerationVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

AccelerationVector

AccelerationVector(DoubleVectorData data,
                   AccelerationUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final AccelerationVector instantiateType(DoubleVectorData dvd,
                                                   AccelerationUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<AccelerationUnit,AccelerationVector,MutableAccelerationVector,Acceleration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableAccelerationVector instantiateMutableType(DoubleVectorData dvd,
                                                                 AccelerationUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<AccelerationUnit,AccelerationVector,MutableAccelerationVector,Acceleration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Acceleration instantiateScalar(double value,
                                               AccelerationUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<AccelerationUnit,AccelerationVector,MutableAccelerationVector,Acceleration>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final AccelerationVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final AccelerationVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Acceleration[] toArray()

Return an array of Acceleration Scalars from this vector.

Returns:

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

Throws:

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