org.djunits.value.vfloat.vector

Class FloatDimensionlessVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionlessVector,MutableFloatDimensionlessVector,FloatDimensionless>

org.djunits.value.vfloat.vector.FloatDimensionlessVector

All Implemented Interfaces:

Serializable, Iterable<FloatDimensionless>, Relative, Value<DimensionlessUnit>, FloatVectorInterface<DimensionlessUnit>

public class FloatDimensionlessVector
extends AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionlessVector,MutableFloatDimensionlessVector,FloatDimensionless>

Immutable Float FloatDimensionlessVector, a vector of values with a DimensionlessUnit.

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

Method Summary

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

FloatDimensionlessVector

public FloatDimensionlessVector(float[] values,
                                DimensionlessUnit unit,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDimensionlessVector

public FloatDimensionlessVector(List<Float> values,
                                DimensionlessUnit unit,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDimensionlessVector

public FloatDimensionlessVector(FloatDimensionless[] values,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDimensionlessVector

public FloatDimensionlessVector(List<FloatDimensionless> values,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDimensionlessVector

public FloatDimensionlessVector(SortedMap<Integer,FloatDimensionless> values,
                                int length,
                                StorageType storageType)
                         throws ValueException

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatDimensionlessVector

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

Construct a new Relative Immutable Float FloatDimensionlessVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatDimensionlessVector

FloatDimensionlessVector(FloatVectorData data,
                         DimensionlessUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatDimensionlessVector instantiateType(FloatVectorData dvd,
                                                         DimensionlessUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionlessVector,MutableFloatDimensionlessVector,FloatDimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatDimensionlessVector instantiateMutableType(FloatVectorData dvd,
                                                                       DimensionlessUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionlessVector,MutableFloatDimensionlessVector,FloatDimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatDimensionless instantiateScalar(float value,
                                                     DimensionlessUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionlessVector,MutableFloatDimensionlessVector,FloatDimensionless>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatDimensionlessVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatDimensionlessVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatDimensionless[] toArray()

Return an array of FloatDimensionless Scalars from this vector.

Returns:

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

Throws:

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