org.djunits.value.vdouble.vector

Class MassVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<MassUnit,MassVector,MutableMassVector,Mass>

org.djunits.value.vdouble.vector.MassVector

All Implemented Interfaces:

Serializable, Iterable<Mass>, Relative, Value<MassUnit>, DoubleVectorInterface<MassUnit>

public class MassVector
extends AbstractDoubleVectorRel<MassUnit,MassVector,MutableMassVector,Mass>

Immutable Double MassVector, a vector of values with a MassUnit.

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

Method Summary

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

MassVector

public MassVector(double[] values,
                  MassUnit unit,
                  StorageType storageType)
           throws ValueException

Construct a new Relative Immutable Double MassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MassVector

public MassVector(List<Double> values,
                  MassUnit unit,
                  StorageType storageType)
           throws ValueException

Construct a new Relative Immutable Double MassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MassVector

public MassVector(Mass[] values,
                  StorageType storageType)
           throws ValueException

Construct a new Relative Immutable Double MassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MassVector

public MassVector(List<Mass> values,
                  StorageType storageType)
           throws ValueException

Construct a new Relative Immutable Double MassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MassVector

public MassVector(SortedMap<Integer,Mass> values,
                  int length,
                  StorageType storageType)
           throws ValueException

Construct a new Relative Immutable Double MassVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MassVector

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

Construct a new Relative Immutable Double MassVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MassVector

MassVector(DoubleVectorData data,
           MassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final MassVector instantiateType(DoubleVectorData dvd,
                                           MassUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<MassUnit,MassVector,MutableMassVector,Mass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableMassVector instantiateMutableType(DoubleVectorData dvd,
                                                         MassUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<MassUnit,MassVector,MutableMassVector,Mass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Mass instantiateScalar(double value,
                                       MassUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<MassUnit,MassVector,MutableMassVector,Mass>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MassVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final MassVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Mass[] toArray()

Return an array of Mass Scalars from this vector.

Returns:

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

Throws:

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