org.djunits.value.vfloat.vector

Class FloatEnergyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<EnergyUnit,FloatEnergyVector,MutableFloatEnergyVector,FloatEnergy>

org.djunits.value.vfloat.vector.FloatEnergyVector

All Implemented Interfaces:

Serializable, Iterable<FloatEnergy>, Relative, Value<EnergyUnit>, FloatVectorInterface<EnergyUnit>

public class FloatEnergyVector
extends AbstractFloatVectorRel<EnergyUnit,FloatEnergyVector,MutableFloatEnergyVector,FloatEnergy>

Immutable Float FloatEnergyVector, 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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

data

Constructor Summary

Constructors

Constructor and Description
FloatEnergyVector(float[] values, EnergyUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.
FloatEnergyVector(FloatEnergy[] values, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.
FloatEnergyVector(FloatVectorData data, EnergyUnit unit)
FloatEnergyVector(List<Float> values, EnergyUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.
FloatEnergyVector(List<FloatEnergy> values, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.
FloatEnergyVector(SortedMap<Integer,Float> values, EnergyUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.
FloatEnergyVector(SortedMap<Integer,FloatEnergy> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatEnergyVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatEnergyVector	instantiateMutableType(FloatVectorData dvd, EnergyUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatEnergy	instantiateScalar(float value, EnergyUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatEnergyVector	instantiateType(FloatVectorData dvd, EnergyUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatEnergy[]	toArray() Return an array of FloatEnergy Scalars from this vector.
FloatEnergyVector	toDense() return a dense version of this vector.
FloatEnergyVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVectorRel

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

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

FloatEnergyVector

public FloatEnergyVector(float[] values,
                         EnergyUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - float[]; the values of the entries in the new Relative Immutable Float FloatEnergyVector

unit - U; the unit of the new Relative Immutable Float FloatEnergyVector

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

Throws:

ValueException - when values is null

FloatEnergyVector

public FloatEnergyVector(List<Float> values,
                         EnergyUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatEnergyVector

unit - U; the unit of the new Relative Immutable Float FloatEnergyVector

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

Throws:

ValueException - when values is null

FloatEnergyVector

public FloatEnergyVector(FloatEnergy[] values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Float FloatEnergyVector

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

Throws:

ValueException - when values has zero entries

FloatEnergyVector

public FloatEnergyVector(List<FloatEnergy> values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatEnergyVector

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

Throws:

ValueException - when values has zero entries

FloatEnergyVector

public FloatEnergyVector(SortedMap<Integer,FloatEnergy> values,
                         int length,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Float FloatEnergyVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatEnergyVector

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

Construct a new Relative Immutable Float FloatEnergyVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Float FloatEnergyVector

unit - U; the unit of the new Relative Sparse Mutable Float FloatEnergyVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatEnergyVector

FloatEnergyVector(FloatVectorData data,
                  EnergyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatEnergyVector instantiateType(FloatVectorData dvd,
                                                  EnergyUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<EnergyUnit,FloatEnergyVector,MutableFloatEnergyVector,FloatEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatEnergyVector instantiateMutableType(FloatVectorData dvd,
                                                                EnergyUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<EnergyUnit,FloatEnergyVector,MutableFloatEnergyVector,FloatEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatEnergy instantiateScalar(float value,
                                              EnergyUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<EnergyUnit,FloatEnergyVector,MutableFloatEnergyVector,FloatEnergy>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatEnergyVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatEnergyVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatEnergy[] toArray()

Return an array of FloatEnergy Scalars from this vector.

Returns:

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

Throws:

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