org.djunits.value.vfloat.vector

Class FloatLengthVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<LengthUnit,FloatLengthVector,MutableFloatLengthVector,FloatLength>

org.djunits.value.vfloat.vector.FloatLengthVector

All Implemented Interfaces:

Serializable, Iterable<FloatLength>, Relative, Value<LengthUnit>, FloatVectorInterface<LengthUnit>

public class FloatLengthVector
extends AbstractFloatVectorRel<LengthUnit,FloatLengthVector,MutableFloatLengthVector,FloatLength>

Relative FloatLength Vector.

Copyright (c) 2013-2018 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
FloatLengthVector(float[] values, LengthUnit unit, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(FloatLength[] values, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(FloatVectorData data, LengthUnit unit) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(List<Float> values, LengthUnit unit, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(List<FloatLength> values, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(SortedMap<Integer,Float> values, LengthUnit unit, int length, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.
FloatLengthVector(SortedMap<Integer,FloatLength> values, int length, StorageType storageType) Construct a new Relative Immutable FloatLengthVector.

Method Summary

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

FloatLengthVector

public FloatLengthVector(float[] values,
                         LengthUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatLengthVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable FloatLengthVector

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

Throws:

ValueException - when values is null

FloatLengthVector

public FloatLengthVector(List<Float> values,
                         LengthUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatLengthVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable FloatLengthVector

unit - U; the unit of the new Relative Immutable FloatLengthVector

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

Throws:

ValueException - when values is null

FloatLengthVector

public FloatLengthVector(FloatLength[] values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatLengthVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatLengthVector

public FloatLengthVector(List<FloatLength> values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatLengthVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable FloatLengthVector

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

Throws:

ValueException - when values has zero entries

FloatLengthVector

public FloatLengthVector(SortedMap<Integer,FloatLength> values,
                         int length,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatLengthVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatLengthVector

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

Construct a new Relative Immutable FloatLengthVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable FloatLengthVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatLengthVector

FloatLengthVector(FloatVectorData data,
                  LengthUnit unit)

Construct a new Relative Immutable FloatLengthVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatLengthVector instantiateType(FloatVectorData dvd,
                                                  LengthUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<LengthUnit,FloatLengthVector,MutableFloatLengthVector,FloatLength>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatLengthVector instantiateMutableType(FloatVectorData dvd,
                                                                LengthUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<LengthUnit,FloatLengthVector,MutableFloatLengthVector,FloatLength>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatLength instantiateScalar(float value,
                                              LengthUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<LengthUnit,FloatLengthVector,MutableFloatLengthVector,FloatLength>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatLengthVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatLengthVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatLength[] toArray()

Return an array of FloatLength Scalars from this vector.

Returns:

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

Throws:

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