org.djunits.value.vfloat.vector

Class FloatFrequencyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<FrequencyUnit,FloatFrequencyVector,MutableFloatFrequencyVector,FloatFrequency>

org.djunits.value.vfloat.vector.FloatFrequencyVector

All Implemented Interfaces:

Serializable, Iterable<FloatFrequency>, Relative, Value<FrequencyUnit>, FloatVectorInterface<FrequencyUnit>

public class FloatFrequencyVector
extends AbstractFloatVectorRel<FrequencyUnit,FloatFrequencyVector,MutableFloatFrequencyVector,FloatFrequency>

Immutable Float FloatFrequencyVector, a vector of values with a FrequencyUnit.

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
FloatFrequencyVector(float[] values, FrequencyUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.
FloatFrequencyVector(FloatFrequency[] values, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.
FloatFrequencyVector(FloatVectorData data, FrequencyUnit unit)
FloatFrequencyVector(List<Float> values, FrequencyUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.
FloatFrequencyVector(List<FloatFrequency> values, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.
FloatFrequencyVector(SortedMap<Integer,Float> values, FrequencyUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.
FloatFrequencyVector(SortedMap<Integer,FloatFrequency> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatFrequencyVector.

Method Summary

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

FloatFrequencyVector

public FloatFrequencyVector(float[] values,
                            FrequencyUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFrequencyVector

public FloatFrequencyVector(List<Float> values,
                            FrequencyUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFrequencyVector

public FloatFrequencyVector(FloatFrequency[] values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFrequencyVector

public FloatFrequencyVector(List<FloatFrequency> values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFrequencyVector

public FloatFrequencyVector(SortedMap<Integer,FloatFrequency> values,
                            int length,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatFrequencyVector

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

Construct a new Relative Immutable Float FloatFrequencyVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatFrequencyVector

FloatFrequencyVector(FloatVectorData data,
                     FrequencyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatFrequencyVector instantiateType(FloatVectorData dvd,
                                                     FrequencyUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<FrequencyUnit,FloatFrequencyVector,MutableFloatFrequencyVector,FloatFrequency>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatFrequencyVector instantiateMutableType(FloatVectorData dvd,
                                                                   FrequencyUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<FrequencyUnit,FloatFrequencyVector,MutableFloatFrequencyVector,FloatFrequency>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatFrequency instantiateScalar(float value,
                                                 FrequencyUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<FrequencyUnit,FloatFrequencyVector,MutableFloatFrequencyVector,FloatFrequency>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatFrequencyVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatFrequencyVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatFrequency[] toArray()

Return an array of FloatFrequency Scalars from this vector.

Returns:

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

Throws:

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