Package org.djunits.value.vdouble.vector

Class LengthVector

java.lang.Object

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

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

org.djunits.value.vdouble.vector.base.AbstractDoubleVector<U,S,RV>

org.djunits.value.vdouble.vector.base.AbstractDoubleVectorRel<RU,R,RV>

org.djunits.value.vdouble.vector.base.AbstractDoubleVectorRelWithAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

org.djunits.value.vdouble.vector.LengthVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Length>, Vector<LengthUnit,Length,LengthVector>, Vector.Rel<LengthUnit,Length,LengthVector>, Vector.RelWithAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>, ValueFunctions<LengthUnit,LengthVector>, IndexedValue<LengthUnit,Length,LengthVector>, Relative<LengthUnit,LengthVector>, Value<LengthUnit,LengthVector>, DoubleVectorInterface<LengthUnit,Length,LengthVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class LengthVector
extends AbstractDoubleVectorRelWithAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Double LengthVector, a vector of values with a LengthUnit.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim 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
LengthVector(DoubleVectorData data, LengthUnit displayUnit)	Construct an LengthVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
Class<Length>	getScalarClass()	Return the class of the corresponding scalar.
Position	instantiateScalarAbsSI(double valueSI, PositionUnit displayUnit)	Instantiate a new absolute scalar for the class of this relative vector.
Length	instantiateScalarSI(double valueSI, LengthUnit displayUnit)	Instantiate a new scalar for the class of this vector.
LengthVector	instantiateVector(DoubleVectorData dvd, LengthUnit displayUnit)	Instantiate a new vector of the class of this vector.
PositionVector	instantiateVectorAbs(DoubleVectorData dvd, PositionUnit displayUnit)	Instantiate a new absolute vector of the class of this relative vector.

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

plus

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

decrementBy, decrementBy, divide, divide, divide, divideBy, incrementBy, incrementBy, minus, multiplyBy, plus, times, times, times, zSum

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.Relative

divide, divide, times, times

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

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

divideBy, minus, multiplyBy, plus

Constructor Detail

LengthVector

public LengthVector(DoubleVectorData data,
                    LengthUnit displayUnit)

Construct an LengthVector from an internal data object.

Parameters:

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

displayUnit - LengthUnit; the display unit of the vector data

Method Detail

getScalarClass

public Class<Length> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public LengthVector instantiateVector(DoubleVectorData dvd,
                                      LengthUnit 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 Length instantiateScalarSI(double valueSI,
                                  LengthUnit 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

instantiateVectorAbs

public PositionVector instantiateVectorAbs(DoubleVectorData dvd,
                                           PositionUnit displayUnit)

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

Specified by:

instantiateVectorAbs in class AbstractDoubleVectorRelWithAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - AU; the display unit of the absolute vector

Returns:

AV; an absolute vector of the correct type, belonging to this relative vector type

instantiateScalarAbsSI

public Position instantiateScalarAbsSI(double valueSI,
                                       PositionUnit displayUnit)

Instantiate a new absolute scalar for the class of this relative 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:

instantiateScalarAbsSI in class AbstractDoubleVectorRelWithAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Parameters:

valueSI - double; the SI value of the absolute scalar

displayUnit - AU; the unit in which the absolute value will be displayed

Returns:

A; an absolute scalar of the correct type, belonging to this relative vector type