org.djunits.value.vdouble.vector

Class DirectionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<AU,A>

org.djunits.value.vdouble.vector.AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

org.djunits.value.vdouble.vector.DirectionVector

All Implemented Interfaces:

Serializable, Iterable<Direction>, Absolute, FunctionsAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector>, Value<DirectionUnit>, DoubleVectorInterface<DirectionUnit>

public class DirectionVector
extends AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

Immutable Absolute Direction Vector.

Copyright (c) 2013-2019 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.vdouble.vector.AbstractDoubleVectorAbs

AbstractDoubleVectorAbs.Itr

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

data

Constructor Summary

Constructors

Constructor and Description
DirectionVector(Direction[] values, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(double[] values, DirectionUnit unit, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(DoubleVectorData data, DirectionUnit unit) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(List<Direction> values, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(List<Double> values, DirectionUnit unit, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(SortedMap<Integer,Direction> values, int length, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.
DirectionVector(SortedMap<Integer,Double> values, DirectionUnit unit, int length, StorageType storageType) Construct a new Absolute Immutable Double DirectionVector.

Method Summary

Modifier and Type	Method and Description
protected MutableDirectionVector	instantiateMutableType(DoubleVectorData dvd, DirectionUnit unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected Direction	instantiateScalar(double value, DirectionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
protected DirectionVector	instantiateTypeAbs(DoubleVectorData dvd, DirectionUnit unit) Construct a new Absolute Immutable DoubleVector of the right type.
protected AngleVector	instantiateTypeRel(DoubleVectorData dvd, AngleUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Direction[]	toArray() Return an array of Direction Scalars from this vector.
DirectionVector	toDense() return a dense version of this vector.
DirectionVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorAbs

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

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

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

DirectionVector

public DirectionVector(double[] values,
                       DirectionUnit unit,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - double[]; the values of the entries in the new Absolute Immutable Double DirectionVector

unit - DirectionUnit; the unit of the new Absolute Immutable Double DirectionVector

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

Throws:

ValueException - when values is null

DirectionVector

public DirectionVector(List<Double> values,
                       DirectionUnit unit,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - List<Double>; the values of the entries in the new Absolute Immutable Double DirectionVector

unit - DirectionUnit; the unit of the new Absolute Immutable Double DirectionVector

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

Throws:

ValueException - when values is null

DirectionVector

public DirectionVector(Direction[] values,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - Direction[]; the values of the entries in the new Absolute Immutable Double DirectionVector

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

Throws:

ValueException - when values has zero entries

DirectionVector

public DirectionVector(List<Direction> values,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - List<Direction>; the values of the entries in the new Absolute Immutable Double DirectionVector

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

Throws:

ValueException - when values has zero entries

DirectionVector

public DirectionVector(SortedMap<Integer,Direction> values,
                       int length,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - SortedMap<Integer, Direction>; the values of the entries in the new Absolute Sparse Mutable Double DirectionVector

length - int; the size of the vector

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

Throws:

ValueException - when values has zero entries

DirectionVector

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

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Absolute Sparse Mutable Double DirectionVector

unit - DirectionUnit; the unit of the new Absolute Sparse Mutable Double DirectionVector

length - int; the size of the vector

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

Throws:

ValueException - when values is null

DirectionVector

DirectionVector(DoubleVectorData data,
                DirectionUnit unit)

Construct a new Absolute Immutable Double DirectionVector.

Parameters:

data - DoubleVectorData; an internal data object

unit - DirectionUnit; the unit

Method Detail

instantiateTypeAbs

protected final DirectionVector instantiateTypeAbs(DoubleVectorData dvd,
                                                   DirectionUnit unit)

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

Specified by:

instantiateTypeAbs in class AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateTypeRel

protected final AngleVector instantiateTypeRel(DoubleVectorData dvd,
                                               AngleUnit unit)

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

Specified by:

instantiateTypeRel in class AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - RU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableDirectionVector instantiateMutableType(DoubleVectorData dvd,
                                                              DirectionUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateScalar

protected final Direction instantiateScalar(double value,
                                            DirectionUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorAbs<DirectionUnit,AngleUnit,DirectionVector,AngleVector,MutableDirectionVector,Direction>

Parameters:

value - double; the value

unit - AU; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final DirectionVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final DirectionVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Direction[] toArray()

Return an array of Direction Scalars from this vector.

Returns:

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

Throws:

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