org.djunits.value.vfloat.vector

Class FloatPositionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<AU,A>

org.djunits.value.vfloat.vector.AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

org.djunits.value.vfloat.vector.FloatPositionVector

All Implemented Interfaces:

Serializable, Iterable<FloatPosition>, Absolute, FunctionsAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector>, Value<PositionUnit>, FloatVectorInterface<PositionUnit>

public class FloatPositionVector
extends AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

Absolute FloatPosition 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.AbstractFloatVectorAbs

AbstractFloatVectorAbs.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FloatPositionVector(float[] values, PositionUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(FloatPosition[] values, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(FloatVectorData data, PositionUnit unit) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(List<Float> values, PositionUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(List<FloatPosition> values, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(SortedMap<Integer,Float> values, PositionUnit unit, int length, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.
FloatPositionVector(SortedMap<Integer,FloatPosition> values, int length, StorageType storageType) Construct a new Absolute Immutable FloatPositionVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatPositionVector	instantiateMutableType(FloatVectorData dvd, PositionUnit unit) Construct a new Absolute Mutable FloatVector of the right type.
protected FloatPosition	instantiateScalar(float value, PositionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected FloatPositionVector	instantiateTypeAbs(FloatVectorData dvd, PositionUnit unit) Construct a new Absolute Immutable FloatVector of the right type.
protected FloatLengthVector	instantiateTypeRel(FloatVectorData dvd, LengthUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatPosition[]	toArray() Return an array of FloatPosition Scalars from this vector.
FloatPositionVector	toDense() return a dense version of this vector.
FloatPositionVector	toSparse() return a sparse version of this vector.

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

checkUnit, checkUnit, checkUnit, get, iterator, minus, minus, mutable, plus

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

FloatPositionVector

public FloatPositionVector(float[] values,
                           PositionUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

values - float[]; the values of the entries in the new Absolute Immutable FloatPositionVector

unit - U; the unit of the new Absolute Immutable FloatPositionVector

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

Throws:

ValueException - when values is null

FloatPositionVector

public FloatPositionVector(List<Float> values,
                           PositionUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable FloatPositionVector

unit - U; the unit of the new Absolute Immutable FloatPositionVector

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

Throws:

ValueException - when values is null

FloatPositionVector

public FloatPositionVector(FloatPosition[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatPositionVector

public FloatPositionVector(List<FloatPosition> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable FloatPositionVector

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

Throws:

ValueException - when values has zero entries

FloatPositionVector

public FloatPositionVector(SortedMap<Integer,FloatPosition> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatPositionVector

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

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

values - Map; the map of indexes to values of the Absolute Sparse Mutable FloatPositionVector

unit - U; the unit of the new Absolute Sparse Mutable FloatPositionVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatPositionVector

FloatPositionVector(FloatVectorData data,
                    PositionUnit unit)

Construct a new Absolute Immutable FloatPositionVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final FloatPositionVector instantiateTypeAbs(FloatVectorData dvd,
                                                       PositionUnit unit)

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

Specified by:

instantiateTypeAbs in class AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateTypeRel

protected final FloatLengthVector instantiateTypeRel(FloatVectorData dvd,
                                                     LengthUnit unit)

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

Specified by:

instantiateTypeRel in class AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatPositionVector instantiateMutableType(FloatVectorData dvd,
                                                                  PositionUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateScalar

protected final FloatPosition instantiateScalar(float value,
                                                PositionUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorAbs<PositionUnit,LengthUnit,FloatPositionVector,FloatLengthVector,MutableFloatPositionVector,FloatPosition>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatPositionVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatPositionVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatPosition[] toArray()

Return an array of FloatPosition Scalars from this vector.

Returns:

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

Throws:

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