org.djunits.value.vdouble.vector

Class EnergyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<EnergyUnit,EnergyVector,MutableEnergyVector,Energy>

org.djunits.value.vdouble.vector.EnergyVector

All Implemented Interfaces:

Serializable, Iterable<Energy>, Relative, Value<EnergyUnit>, DoubleVectorInterface<EnergyUnit>

public class EnergyVector
extends AbstractDoubleVectorRel<EnergyUnit,EnergyVector,MutableEnergyVector,Energy>

Immutable Double EnergyVector, a vector of values with a EnergyUnit.

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

Method Summary

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

EnergyVector

public EnergyVector(double[] values,
                    EnergyUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

EnergyVector

public EnergyVector(List<Double> values,
                    EnergyUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

EnergyVector

public EnergyVector(Energy[] values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

EnergyVector

public EnergyVector(List<Energy> values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

EnergyVector

public EnergyVector(SortedMap<Integer,Energy> values,
                    int length,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

EnergyVector

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

Construct a new Relative Immutable Double EnergyVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

EnergyVector

EnergyVector(DoubleVectorData data,
             EnergyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final EnergyVector instantiateType(DoubleVectorData dvd,
                                             EnergyUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<EnergyUnit,EnergyVector,MutableEnergyVector,Energy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableEnergyVector instantiateMutableType(DoubleVectorData dvd,
                                                           EnergyUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<EnergyUnit,EnergyVector,MutableEnergyVector,Energy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Energy instantiateScalar(double value,
                                         EnergyUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<EnergyUnit,EnergyVector,MutableEnergyVector,Energy>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final EnergyVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final EnergyVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Energy[] toArray()

Return an array of Energy Scalars from this vector.

Returns:

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

Throws:

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