org.djunits.value.vfloat.vector

Class FloatDirectionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

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

org.djunits.value.vfloat.vector.FloatDirectionVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<AngleUnit,FloatVector.Abs<AngleUnit>,FloatVector.Rel<AngleUnit>>, Value<AngleUnit>, FloatVectorInterface<AngleUnit>

public class FloatDirectionVector
extends TypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Absolute FloatDirection Vector.

Copyright (c) 2013-2016 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.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
FloatDirectionVector(float[] values, AngleUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(FloatDirection[] values, StorageType storageType) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(FloatVectorData data, AngleUnit unit) Construct a new Absolute Immutable FloatDirectionVector.
FloatDirectionVector(List<Float> values, AngleUnit 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, AngleUnit 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
FloatDirection	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatDirectionVector	instantiateMutableType(FloatVectorData dvd, AngleUnit unit) Construct a new Absolute Mutable FloatVector of the right type.
protected FloatDirectionVector	instantiateTypeAbs(FloatVectorData dvd, AngleUnit 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.
FloatAngleVector	toRel() Translate the absolute vector into a relative vector (e.g., before or after a multiplication or division).

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

minus, minus, mutable, plus, toDense, toSparse

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

minus, minus, plus

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

FloatDirectionVector

public FloatDirectionVector(float[] values,
                            AngleUnit 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,
                            AngleUnit 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,
                            AngleUnit 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,
                     AngleUnit 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,
                                                        AngleUnit unit)

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

Specified by:

instantiateTypeAbs in class TypedFloatVectorAbs<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 TypedFloatVectorAbs<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,
                                                                   AngleUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatDirection get(int index)
                         throws ValueException

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

Specified by:

get in interface FloatVectorInterface<AngleUnit>

Specified by:

get in class TypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

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())

toRel

public final FloatAngleVector toRel()

Translate the absolute vector into a relative vector (e.g., before or after a multiplication or division).

Returns:

a relative version of this absolute FloatDirection vector.