org.djunits.value.vfloat.vector

Class FloatAreaVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

org.djunits.value.vfloat.vector.FloatAreaVector

All Implemented Interfaces:

Serializable, Iterable<FloatArea>, Relative, Value<AreaUnit>, FloatVectorInterface<AreaUnit>

public class FloatAreaVector
extends AbstractFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Immutable Float FloatAreaVector, a vector of values with a AreaUnit.

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

Method Summary

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

FloatAreaVector

public FloatAreaVector(float[] values,
                       AreaUnit unit,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatAreaVector

public FloatAreaVector(List<Float> values,
                       AreaUnit unit,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatAreaVector

public FloatAreaVector(FloatArea[] values,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatAreaVector

public FloatAreaVector(List<FloatArea> values,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatAreaVector

public FloatAreaVector(SortedMap<Integer,FloatArea> values,
                       int length,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatAreaVector

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

Construct a new Relative Immutable Float FloatAreaVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatAreaVector

FloatAreaVector(FloatVectorData data,
                AreaUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatAreaVector instantiateType(FloatVectorData dvd,
                                                AreaUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatAreaVector instantiateMutableType(FloatVectorData dvd,
                                                              AreaUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatArea instantiateScalar(float value,
                                            AreaUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatAreaVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatAreaVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatArea[] toArray()

Return an array of FloatArea Scalars from this vector.

Returns:

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

Throws:

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