org.djunits.value.vdouble.vector

Class TemperatureVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.vector.TemperatureVector

All Implemented Interfaces:

Serializable, Iterable<Temperature>, Relative, Value<TemperatureUnit>, DoubleVectorInterface<TemperatureUnit>

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

Immutable Relative Temperature Vector.

Copyright (c) 2013-2019 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.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

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
protected MutableTemperatureVector	instantiateMutableType(DoubleVectorData dvd, TemperatureUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Temperature	instantiateScalar(double value, TemperatureUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected TemperatureVector	instantiateType(DoubleVectorData dvd, TemperatureUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Temperature[]	toArray() Return an array of Temperature Scalars from this vector.
TemperatureVector	toDense() return a dense version of this vector.
TemperatureVector	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

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 - TemperatureUnit; the unit of the new Relative Immutable Double TemperatureVector

storageType - 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<Double>; the values of the entries in the new Relative Immutable Double TemperatureVector

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

storageType - 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 - Temperature[]; the values of the entries in the new Relative Immutable Double TemperatureVector

storageType - 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<Temperature>; the values of the entries in the new Relative Immutable Double TemperatureVector

storageType - 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 - SortedMap<Integer, Temperature>; the values of the entries in the new Relative Sparse Mutable Double TemperatureVector

length - int; the size of the vector

storageType - 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 - SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable Double TemperatureVector

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

length - int; the size of the vector

storageType - 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 - DoubleVectorData; an internal data object

unit - TemperatureUnit; 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 AbstractDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the 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 AbstractDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Temperature instantiateScalar(double value,
                                              TemperatureUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<TemperatureUnit,TemperatureVector,MutableTemperatureVector,Temperature>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final TemperatureVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final TemperatureVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Temperature[] toArray()

Return an array of Temperature Scalars from this vector.

Returns:

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

Throws:

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