Package org.djunits.value.vfloat.vector

Class FloatLengthVector

java.lang.Object

org.djunits.value.IndexedValue<U,S,V,D>

org.djunits.value.base.Vector<U,S,V,FloatVectorData>

org.djunits.value.vfloat.vector.base.FloatVector<U,S,RV>

org.djunits.value.vfloat.vector.base.FloatVectorRel<RU,R,RV>

org.djunits.value.vfloat.vector.base.FloatVectorRelWithAbs<PositionUnit,FloatPosition,FloatPositionVector,LengthUnit,FloatLength,FloatLengthVector>

org.djunits.value.vfloat.vector.FloatLengthVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FloatLength>, Relative<LengthUnit,FloatLengthVector>, RelWithAbs<PositionUnit,FloatPositionVector,LengthUnit,FloatLengthVector>, Value<LengthUnit,FloatLengthVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatLengthVector
extends FloatVectorRelWithAbs<PositionUnit,FloatPosition,FloatPositionVector,LengthUnit,FloatLength,FloatLengthVector>

Relative FloatLength Vector.

Copyright (c) 2013-2024 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.vfloat.vector.base.FloatVector

FloatVector.Itr

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.base.FloatVector

data

Constructor Summary

Constructors

Constructor	Description
FloatLengthVector(float[] data)	Construct a FloatLengthVector from a float[] object with SI-unit values.
FloatLengthVector(float[] data, LengthUnit displayUnit)	Construct a FloatLengthVector from a float[] object.
FloatLengthVector(float[] data, LengthUnit displayUnit, StorageType storageType)	Construct a FloatLengthVector from a float[] object.
FloatLengthVector(float[] data, StorageType storageType)	Construct a FloatLengthVector from a float[] object with SI-unit values.
FloatLengthVector(List<? extends Number> data)	Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects.
FloatLengthVector(List<? extends Number> data, LengthUnit displayUnit)	Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects.
FloatLengthVector(List<? extends Number> data, LengthUnit displayUnit, StorageType storageType)	Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects.
FloatLengthVector(List<? extends Number> data, StorageType storageType)	Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects.
FloatLengthVector(Map<Integer,? extends Number> data, int size)	Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects.
FloatLengthVector(Map<Integer,? extends Number> data, int size, LengthUnit displayUnit)	Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects.
FloatLengthVector(Map<Integer,? extends Number> data, int size, LengthUnit displayUnit, StorageType storageType)	Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects.
FloatLengthVector(Map<Integer,? extends Number> data, int size, StorageType storageType)	Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects.
FloatLengthVector(FloatLength[] data)	Construct a FloatLengthVector from an array of FloatLength objects.
FloatLengthVector(FloatLength[] data, LengthUnit displayUnit)	Construct a FloatLengthVector from an array of FloatLength objects.
FloatLengthVector(FloatLength[] data, LengthUnit displayUnit, StorageType storageType)	Construct a FloatLengthVector from an array of FloatLength objects.
FloatLengthVector(FloatLength[] data, StorageType storageType)	Construct a FloatLengthVector from an array of FloatLength objects.
FloatLengthVector(FloatVectorData data, LengthUnit displayUnit)	Construct a FloatLengthVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
Class<FloatLength>	getScalarClass()	Return the class of the corresponding scalar.
FloatPosition	instantiateScalarAbsSI(float valueSI, PositionUnit displayUnit)	Instantiate a new absolute scalar for the class of this relative vector.
FloatLength	instantiateScalarSI(float valueSI, LengthUnit displayUnit)	Instantiate a new scalar for the class of this vector.
FloatLengthVector	instantiateVector(FloatVectorData fvd, LengthUnit displayUnit)	Instantiate a new vector of the class of this vector.
FloatPositionVector	instantiateVectorAbs(FloatVectorData fvd, PositionUnit displayUnit)	Instantiate a new absolute vector of the class of this relative vector.

Methods inherited from class org.djunits.value.vfloat.vector.base.FloatVectorRelWithAbs

plus

Methods inherited from class org.djunits.value.vfloat.vector.base.FloatVectorRel

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.Relative

divide, divide, minus, plus, times, times

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Constructor Details

FloatLengthVector

public FloatLengthVector(FloatVectorData data,
 LengthUnit displayUnit)

Construct a FloatLengthVector from an internal data object.

Parameters:

data - FloatVectorData; the internal data object for the vector

displayUnit - LengthUnit; the display unit of the vector data

FloatLengthVector

public FloatLengthVector(float[] data,
 LengthUnit displayUnit,
 StorageType storageType)

Construct a FloatLengthVector from a float[] object. The Float values are expressed in the displayUnit, and will be printed using the displayUnit.

Parameters:

data - float[]; the data for the vector, expressed in the displayUnit

displayUnit - LengthUnit; the unit of the values in the data array, and display unit when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(float[] data,
 LengthUnit displayUnit)

Construct a FloatLengthVector from a float[] object. The Float values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - float[]; the data for the vector

displayUnit - LengthUnit; the unit of the values in the data array, and display unit when printing

FloatLengthVector

public FloatLengthVector(float[] data,
 StorageType storageType)

Construct a FloatLengthVector from a float[] object with SI-unit values.

Parameters:

data - float[]; the data for the vector, in SI units

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(float[] data)

Construct a FloatLengthVector from a float[] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - float[]; the data for the vector, in SI units

FloatLengthVector

public FloatLengthVector(FloatLength[] data,
 LengthUnit displayUnit,
 StorageType storageType)

Construct a FloatLengthVector from an array of FloatLength objects. The FloatLength values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.

Parameters:

data - FloatLength[]; the data for the vector

displayUnit - LengthUnit; the display unit of the values when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(FloatLength[] data,
 LengthUnit displayUnit)

Construct a FloatLengthVector from an array of FloatLength objects. The FloatLength values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - FloatLength[]; the data for the vector

displayUnit - LengthUnit; the display unit of the values when printing

FloatLengthVector

public FloatLengthVector(FloatLength[] data,
 StorageType storageType)

Construct a FloatLengthVector from an array of FloatLength objects. The FloatLength values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer the data as an array.

Parameters:

data - FloatLength[]; the data for the vector

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(FloatLength[] data)

Construct a FloatLengthVector from an array of FloatLength objects. The FloatLength values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - FloatLength[]; the data for the vector

FloatLengthVector

public FloatLengthVector(List<? extends Number> data,
 LengthUnit displayUnit,
 StorageType storageType)

Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatLength objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed, as well as the unit in which they will be printed. In case the list contains FloatLength objects, each FloatLength has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - List<Float> or List<Length>; the data for the vector

displayUnit - LengthUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Float> or List<Number> in general

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(List<? extends Number> data,
 LengthUnit displayUnit)

Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatLength objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed, as well as the unit in which they will be printed. In case the list contains FloatLength objects, each FloatLength has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE since we offer the data as a List.

Parameters:

data - List<Float> or List<Length>; the data for the vector

displayUnit - LengthUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Float> or List<Number> in general

FloatLengthVector

public FloatLengthVector(List<? extends Number> data,
 StorageType storageType)

Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatLength objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - List<Float> or List<Length>; the data for the vector

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(List<? extends Number> data)

Construct a FloatLengthVector from a list of Number objects or a list of FloatLength objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatLength objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE since we offer the data as a List.

Parameters:

data - List<Float> or List<Length>; the data for the vector

FloatLengthVector

public FloatLengthVector(Map<Integer,? extends Number> data,
 int size,
 LengthUnit displayUnit,
 StorageType storageType)

Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different meaning depending on whether the map contains Number objects (e.g., Float objects) or FloatLength objects. In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the unit in which they will be printed. In case the map contains FloatLength objects, each FloatLength has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - Map<Integer, Float> or Map<Integer, FloatLength>; the data for the vector

size - int; the size off the vector, i.e., the highest index

displayUnit - LengthUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Float> or List<Number> in general

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(Map<Integer,? extends Number> data,
 int size,
 LengthUnit displayUnit)

Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different meaning depending on whether the map contains Number objects (e.g., Float objects) or FloatLength objects. In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the unit in which they will be printed. In case the map contains FloatLength objects, each FloatLength has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer the data as a Map.

Parameters:

data - Map<Integer, Float> or Map<Integer, FloatLength>; the data for the vector

size - int; the size off the vector, i.e., the highest index

displayUnit - LengthUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Float> or List<Number> in general

FloatLengthVector

public FloatLengthVector(Map<Integer,? extends Number> data,
 int size,
 StorageType storageType)

Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatLength objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - Map<Integer, Float> or Map<Integer, FloatLength>; the data for the vector

size - int; the size off the vector, i.e., the highest index

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

FloatLengthVector

public FloatLengthVector(Map<Integer,? extends Number> data,
 int size)

Construct a FloatLengthVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatLength objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatLength objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer the data as a Map.

Parameters:

data - Map<Integer, Float> or Map<Integer, FloatLength>; the data for the vector

size - int; the size off the vector, i.e., the highest index

Method Details

getScalarClass

public Class<FloatLength> getScalarClass()

Description copied from class: IndexedValue

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<LengthUnit,FloatLength,FloatLengthVector,FloatVectorData>

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public FloatLengthVector instantiateVector(FloatVectorData fvd,
 LengthUnit displayUnit)

Description copied from class: FloatVector

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

Specified by:

instantiateVector in class FloatVector<LengthUnit,FloatLength,FloatLengthVector>

Parameters:

fvd - FloatVectorData; 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 FloatLength instantiateScalarSI(float valueSI,
 LengthUnit displayUnit)

Description copied from class: FloatVector

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

Specified by:

instantiateScalarSI in class FloatVector<LengthUnit,FloatLength,FloatLengthVector>

Parameters:

valueSI - float; 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 FloatPositionVector instantiateVectorAbs(FloatVectorData fvd,
 PositionUnit displayUnit)

Description copied from class: FloatVectorRelWithAbs

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

Specified by:

instantiateVectorAbs in class FloatVectorRelWithAbs<PositionUnit,FloatPosition,FloatPositionVector,LengthUnit,FloatLength,FloatLengthVector>

Parameters:

fvd - FloatVectorData; 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 FloatPosition instantiateScalarAbsSI(float valueSI,
 PositionUnit displayUnit)

Description copied from class: FloatVectorRelWithAbs

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

Specified by:

instantiateScalarAbsSI in class FloatVectorRelWithAbs<PositionUnit,FloatPosition,FloatPositionVector,LengthUnit,FloatLength,FloatLengthVector>

Parameters:

valueSI - float; 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