Package org.djunits.value.vdouble.vector

Class DirectionVector

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,V,DoubleVectorData>

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

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

org.djunits.value.vdouble.vector.DirectionVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Direction>, Absolute, Vector<DirectionUnit,Direction,DirectionVector>, Vector.Abs<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>, ValueFunctions<DirectionUnit,DirectionVector>, IndexedValue<DirectionUnit,Direction,DirectionVector>, Value<DirectionUnit,DirectionVector>, DoubleVectorInterface<DirectionUnit,Direction,DirectionVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class DirectionVector
extends AbstractDoubleVectorAbs<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>

Double DirectionVector, a vector of values with a DirectionUnit.

Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.base.AbstractDoubleVector

AbstractDoubleVector.Itr

Nested classes/interfaces inherited from interface org.djunits.value.base.Vector

Vector.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>, Vector.Rel<U extends Unit<U>,S extends Scalar<U,S>,RV extends Vector.Rel<U,S,RV>>, Vector.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>

Field Summary

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

data

Constructor Summary

Constructors

Constructor	Description
DirectionVector(DoubleVectorData data, DirectionUnit unit)	Construct an DirectionVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
Class<Direction>	getScalarClass()	Return the class of the corresponding scalar.
Angle	instantiateScalarRelSI(double valueSI, AngleUnit displayUnit)	Instantiate a new relative scalar for the class of this absolute vector.
Direction	instantiateScalarSI(double valueSI, DirectionUnit displayUnit)	Instantiate a new scalar for the class of this vector.
DirectionVector	instantiateVector(DoubleVectorData dvd, DirectionUnit displayUnit)	Instantiate a new vector of the class of this vector.
AngleVector	instantiateVectorRel(DoubleVectorData dvd, AngleUnit displayUnit)	Instantiate a new relative vector of the class of this absolute vector.

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

decrementBy, decrementBy, minus, minus, plus

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

abs, assign, ceil, checkIndex, checkSize, equals, floor, get, getData, getInUnit, getInUnit, getScalars, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, iterator, neg, rint, set, setData, setInUnit, setInUnit, setSI, size, toDense, toSparse, toString, toString, toString, toString

Methods inherited from class org.djunits.value.AbstractIndexedValue

cardinality, checkCopyOnWrite, clone, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setMutable

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getStorageType, immutable, isDense, isMutable, isSparse, mutable, toDense, toSparse

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Methods inherited from interface org.djunits.value.base.Vector

get, getScalars, iterator, size

Constructor Detail

DirectionVector

public DirectionVector(DoubleVectorData data,
                       DirectionUnit unit)

Construct an DirectionVector from an internal data object.

Parameters:

data - DoubleVectorData; the internal data object for the vector data

unit - DirectionUnit; the display unit of the vector data

Method Detail

getScalarClass

public Class<Direction> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public DirectionVector instantiateVector(DoubleVectorData dvd,
                                         DirectionUnit displayUnit)

Instantiate a new vector of the class of this vector. This can be used instead of the DoubleVector.instiantiate() methods in case another vector of this class is known. The method is faster than DoubleVector.instantiate, and it will also work if the vector is user-defined.

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - U; the display unit of the vector

Returns:

V; a vector of the correct type

instantiateScalarSI

public Direction instantiateScalarSI(double valueSI,
                                     DirectionUnit displayUnit)

Instantiate a new scalar for the class of this vector. This can be used instead of the DoubleScalar.instiantiate() methods in case a vector of this class is known. The method is faster than DoubleScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.

Parameters:

valueSI - double; the SI value of the scalar

displayUnit - U; the unit in which the value will be displayed

Returns:

S; a scalar of the correct type, belonging to the vector type

instantiateVectorRel

public AngleVector instantiateVectorRel(DoubleVectorData dvd,
                                        AngleUnit displayUnit)

Instantiate a new relative vector of the class of this absolute vector. This can be used instead of the DoubleVector.instiantiate() methods in case another vector of this absolute vector class is known. The method is faster than DoubleVector.instantiate, and it will also work if the vector is user-defined.

Specified by:

instantiateVectorRel in class AbstractDoubleVectorAbs<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - RU; the display unit of the relative vector

Returns:

RV; a relative vector of the correct type, belonging to this absolute vector type

instantiateScalarRelSI

public Angle instantiateScalarRelSI(double valueSI,
                                    AngleUnit displayUnit)

Instantiate a new relative scalar for the class of this absolute vector. This can be used instead of the DoubleScalar.instiantiate() methods in case a vector of this class is known. The method is faster than DoubleScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.

Specified by:

instantiateScalarRelSI in class AbstractDoubleVectorAbs<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>

Parameters:

valueSI - double; the SI value of the relative scalar

displayUnit - RU; the unit in which the relative value will be displayed

Returns:

R; a relative scalar of the correct type, belonging to this absolute vector type