org.djunits.value.vdouble.vector

Class TemperatureVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.DoubleVector.Rel<U>

org.djunits.value.vdouble.vector.TypedDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

org.djunits.value.vdouble.vector.TemperatureVector

All Implemented Interfaces:

Serializable, FunctionsRel<TemperatureUnit,DoubleVector.Abs<TemperatureUnit>,DoubleVector.Rel<TemperatureUnit>>, Relative, Value<TemperatureUnit>, DoubleVectorInterface<TemperatureUnit>

public class TemperatureVector
extends TypedDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Immutable Relative Temperature Vector.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.DoubleVector

DoubleVector.Abs<U extends Unit<U>>, DoubleVector.Rel<U extends Unit<U>>

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.DoubleVector

data

Constructor Summary

Constructors

Constructor and Description
TemperatureVector(double[] values, TemperatureUnit unit, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(DoubleVectorData data, TemperatureUnit unit) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(List<Double> values, TemperatureUnit unit, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(List<Temperature> values, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(SortedMap<Integer,Double> values, TemperatureUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(SortedMap<Integer,Temperature> values, int length, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.
TemperatureVector(Temperature[] values, StorageType storageType) Construct a new Relative Immutable Double TemperatureVector.

Method Summary

Modifier and Type	Method and Description
Temperature	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutableTemperatureVector	instantiateMutableType(DoubleVectorData dvd, TemperatureUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected TemperatureVector	instantiateType(DoubleVectorData dvd, TemperatureUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
AbsoluteTemperatureVector	toAbs() Translate the relative vector into an absolute vector (e.g., before or after a multiplication or division).

Methods inherited from class org.djunits.value.vdouble.vector.TypedDoubleVectorRel

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector.Rel

divide, minus, plus, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TemperatureVector

public TemperatureVector(double[] values,
                         TemperatureUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

TemperatureVector

public TemperatureVector(List<Double> values,
                         TemperatureUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

TemperatureVector

public TemperatureVector(Temperature[] values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

TemperatureVector

public TemperatureVector(List<Temperature> values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

TemperatureVector

public TemperatureVector(SortedMap<Integer,Temperature> values,
                         int length,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

TemperatureVector

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

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

TemperatureVector

TemperatureVector(DoubleVectorData data,
                  TemperatureUnit unit)

Construct a new Relative Immutable Double TemperatureVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final TemperatureVector instantiateType(DoubleVectorData dvd,
                                                  TemperatureUnit unit)

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

Specified by:

instantiateType in class TypedDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableTemperatureVector instantiateMutableType(DoubleVectorData dvd,
                                                                TemperatureUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final Temperature get(int index)
                      throws ValueException

Retrieve the value stored at a specified index as a DoubleScalar.

Specified by:

get in interface DoubleVectorInterface<TemperatureUnit>

Specified by:

get in class TypedDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

index - int; index of the value to retrieve

Returns:

DoubleScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())

toAbs

public final AbsoluteTemperatureVector toAbs()

Translate the relative vector into an absolute vector (e.g., before or after a multiplication or division).

Returns:

an absolute version of this relative Temperature vector.