org.djunits.value.vfloat.vector

Class FloatDurationVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<DurationUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

org.djunits.value.vfloat.vector.FloatDurationVector

All Implemented Interfaces:

Serializable, Iterable<FloatDuration>, Relative, Value<DurationUnit>, FloatVectorInterface<DurationUnit>

public class FloatDurationVector
extends AbstractFloatVectorRel<DurationUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Relative FloatDuration 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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableFloatDurationVector	instantiateMutableType(FloatVectorData dvd, DurationUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatDuration	instantiateScalar(float value, DurationUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatDurationVector	instantiateType(FloatVectorData dvd, DurationUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatDuration[]	toArray() Return an array of FloatDuration Scalars from this vector.
FloatDurationVector	toDense() return a dense version of this vector.
FloatDurationVector	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

FloatDurationVector

public FloatDurationVector(float[] values,
                           DurationUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

unit - DurationUnit; the unit of the new Relative Immutable FloatDurationVector

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

Throws:

ValueException - when values is null

FloatDurationVector

public FloatDurationVector(List<Float> values,
                           DurationUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

values - List<Float>; the values of the entries in the new Relative Immutable FloatDurationVector

unit - DurationUnit; the unit of the new Relative Immutable FloatDurationVector

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

Throws:

ValueException - when values is null

FloatDurationVector

public FloatDurationVector(FloatDuration[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

values - FloatDuration[]; the values of the entries in the new Relative Immutable FloatDurationVector

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

Throws:

ValueException - when values has zero entries

FloatDurationVector

public FloatDurationVector(List<FloatDuration> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

values - List<FloatDuration>; the values of the entries in the new Relative Immutable FloatDurationVector

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

Throws:

ValueException - when values has zero entries

FloatDurationVector

public FloatDurationVector(SortedMap<Integer,FloatDuration> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

values - SortedMap<Integer, FloatDuration>; the values of the entries in the new Relative Sparse Mutable FloatDurationVector

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

FloatDurationVector

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

Construct a new Relative Immutable FloatDurationVector.

Parameters:

values - SortedMap<Integer, Float>; the map of indexes to values of the Relative Sparse Mutable FloatDurationVector

unit - DurationUnit; the unit of the new Relative Sparse Mutable FloatDurationVector

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

FloatDurationVector

FloatDurationVector(FloatVectorData data,
                    DurationUnit unit)

Construct a new Relative Immutable FloatDurationVector.

Parameters:

data - FloatVectorData; an internal data object

unit - DurationUnit; the unit

Method Detail

instantiateType

protected final FloatDurationVector instantiateType(FloatVectorData dvd,
                                                    DurationUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<DurationUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatDurationVector instantiateMutableType(FloatVectorData dvd,
                                                                  DurationUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<DurationUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatDuration instantiateScalar(float value,
                                                DurationUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<DurationUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Parameters:

value - float; the value

unit - U; the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatDurationVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatDurationVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatDuration[] toArray()

Return an array of FloatDuration Scalars from this vector.

Returns:

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

Throws:

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