org.djunits.value.vfloat.vector

Class FloatAreaVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.FloatVector<U>

org.djunits.value.vfloat.vector.FloatVector.Rel<U>

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

org.djunits.value.vfloat.vector.FloatAreaVector

All Implemented Interfaces:

Serializable, FunctionsRel<AreaUnit,FloatVector.Abs<AreaUnit>,FloatVector.Rel<AreaUnit>>, Relative, Value<AreaUnit>, FloatVectorInterface<AreaUnit>

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

Immutable FloatAreaVector, a vector of values with a AreaUnit.

Copyright (c) 2013-2016 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.FloatVector

FloatVector.Abs<U extends Unit<U>>, FloatVector.Rel<U extends Unit<U>>

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FloatArea	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatAreaVector	instantiateMutableType(FloatVectorData dvd, AreaUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatAreaVector	instantiateType(FloatVectorData dvd, AreaUnit unit) Construct a new Relative Immutable FloatVector of the right type.

Methods inherited from class org.djunits.value.vfloat.vector.TypedFloatVectorRel

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector.Rel

divide, minus, plus, plus, times

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatAreaVector

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

Construct a new Relative Immutable FloatAreaVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable 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 FloatAreaVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable 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 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 FloatAreaVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable 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 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 FloatAreaVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable 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 TypedFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable 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 TypedFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatArea get(int index)
                    throws ValueException

Retrieve the value stored at a specified index as a FloatScalar.

Specified by:

get in interface FloatVectorInterface<AreaUnit>

Specified by:

get in class TypedFloatVectorRel<AreaUnit,FloatAreaVector,MutableFloatAreaVector,FloatArea>

Parameters:

index - int; index of the value to retrieve

Returns:

FloatScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())