org.djunits.value.vfloat.vector

Class FloatDirectionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

org.djunits.value.vfloat.vector.FloatDirectionVector

All Implemented Interfaces:

Serializable, Iterable<FloatDirection>, Absolute, FunctionsAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector>, Value<DirectionUnit>, FloatVectorInterface<DirectionUnit>

public class FloatDirectionVector
extends AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Absolute FloatDirection 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
FloatDirectionVector(float[] values, DirectionUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(FloatDirection[] values, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(FloatVectorData data, DirectionUnit unit) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(List<Float> values, DirectionUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(List<FloatDirection> values, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(SortedMap<Integer,Float> values, DirectionUnit unit, int length, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(SortedMap<Integer,FloatDirection> values, int length, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatDirectionVector	instantiateMutableType(FloatVectorData dvd, DirectionUnit unit) Construct a new Absolute Mutable FloatVector of the right type.
protected FloatDirection	instantiateScalar(float value, DirectionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected FloatDirectionVector	instantiateTypeAbs(FloatVectorData dvd, DirectionUnit unit) Construct a new Absolute Immutable FloatVector of the right type.
protected FloatAngleVector	instantiateTypeRel(FloatVectorData dvd, AngleUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatDirection[]	toArray() Return an array of FloatDirection Scalars from this vector.
FloatDirectionVector	toDense() return a dense version of this vector.
FloatDirectionVector	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

FloatDirectionVector

public FloatDirectionVector(float[] values,
                            DirectionUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDirectionVector

public FloatDirectionVector(List<Float> values,
                            DirectionUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDirectionVector

public FloatDirectionVector(FloatDirection[] values,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDirectionVector

public FloatDirectionVector(List<FloatDirection> values,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDirectionVector

public FloatDirectionVector(SortedMap<Integer,FloatDirection> values,
                            int length,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatDirectionVector

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

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatDirectionVector

FloatDirectionVector(FloatVectorData data,
                     DirectionUnit unit)

Construct a new Absolute Immutable FloatDirectionVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final FloatDirectionVector instantiateTypeAbs(FloatVectorData dvd,
                                                        DirectionUnit unit)

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

Specified by:

instantiateTypeAbs in class AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateTypeRel

protected final FloatAngleVector instantiateTypeRel(FloatVectorData dvd,
                                                    AngleUnit unit)

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

Specified by:

instantiateTypeRel in class AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatDirectionVector instantiateMutableType(FloatVectorData dvd,
                                                                   DirectionUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateScalar

protected final FloatDirection instantiateScalar(float value,
                                                 DirectionUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorAbs<DirectionUnit,AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatDirectionVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatDirectionVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatDirection[] toArray()

Return an array of FloatDirection Scalars from this vector.

Returns:

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

Throws:

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