Package org.djunits.value.vfloat.vector

Class FloatEnergyVector

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<EnergyUnit,FloatEnergy,FloatEnergyVector>

org.djunits.value.vfloat.vector.FloatEnergyVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FloatEnergy>, Relative<EnergyUnit,FloatEnergyVector>, Value<EnergyUnit,FloatEnergyVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatEnergyVector
extends FloatVectorRel<EnergyUnit,FloatEnergy,FloatEnergyVector>

Immutable Float FloatEnergyVector, a vector of values with a EnergyUnit.

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
FloatEnergyVector(float[] data)	Construct a FloatEnergyVector from a float[] object with SI-unit values.
FloatEnergyVector(float[] data, EnergyUnit displayUnit)	Construct a FloatEnergyVector from a float[] object.
FloatEnergyVector(float[] data, EnergyUnit displayUnit, StorageType storageType)	Construct a FloatEnergyVector from a float[] object.
FloatEnergyVector(float[] data, StorageType storageType)	Construct a FloatEnergyVector from a float[] object with SI-unit values.
FloatEnergyVector(List<? extends Number> data)	Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects.
FloatEnergyVector(List<? extends Number> data, EnergyUnit displayUnit)	Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects.
FloatEnergyVector(List<? extends Number> data, EnergyUnit displayUnit, StorageType storageType)	Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects.
FloatEnergyVector(List<? extends Number> data, StorageType storageType)	Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects.
FloatEnergyVector(Map<Integer,? extends Number> data, int size)	Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy objects.
FloatEnergyVector(Map<Integer,? extends Number> data, int size, EnergyUnit displayUnit)	Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy objects.
FloatEnergyVector(Map<Integer,? extends Number> data, int size, EnergyUnit displayUnit, StorageType storageType)	Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy objects.
FloatEnergyVector(Map<Integer,? extends Number> data, int size, StorageType storageType)	Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy objects.
FloatEnergyVector(FloatEnergy[] data)	Construct a FloatEnergyVector from an array of FloatEnergy objects.
FloatEnergyVector(FloatEnergy[] data, EnergyUnit displayUnit)	Construct a FloatEnergyVector from an array of FloatEnergy objects.
FloatEnergyVector(FloatEnergy[] data, EnergyUnit displayUnit, StorageType storageType)	Construct a FloatEnergyVector from an array of FloatEnergy objects.
FloatEnergyVector(FloatEnergy[] data, StorageType storageType)	Construct a FloatEnergyVector from an array of FloatEnergy objects.
FloatEnergyVector(FloatVectorData data, EnergyUnit displayUnit)	Construct a FloatEnergyVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
Class<FloatEnergy>	getScalarClass()	Return the class of the corresponding scalar.
FloatEnergy	instantiateScalarSI(float valueSI, EnergyUnit displayUnit)	Instantiate a new scalar for the class of this vector.
FloatEnergyVector	instantiateVector(FloatVectorData fvd, EnergyUnit displayUnit)	Instantiate a new vector of the class of this vector.

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

isAbsolute, isRelative

Constructor Details

FloatEnergyVector

public FloatEnergyVector(FloatVectorData data,
 EnergyUnit displayUnit)

Construct a FloatEnergyVector from an internal data object.

Parameters:

data - FloatVectorData; the internal data object for the vector

displayUnit - EnergyUnit; the display unit of the vector data

FloatEnergyVector

public FloatEnergyVector(float[] data,
 EnergyUnit displayUnit,
 StorageType storageType)

Construct a FloatEnergyVector 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 - EnergyUnit; 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

FloatEnergyVector

public FloatEnergyVector(float[] data,
 EnergyUnit displayUnit)

Construct a FloatEnergyVector 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 - EnergyUnit; the unit of the values in the data array, and display unit when printing

FloatEnergyVector

public FloatEnergyVector(float[] data,
 StorageType storageType)

Construct a FloatEnergyVector 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

FloatEnergyVector

public FloatEnergyVector(float[] data)

Construct a FloatEnergyVector 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

FloatEnergyVector

public FloatEnergyVector(FloatEnergy[] data,
 EnergyUnit displayUnit,
 StorageType storageType)

Construct a FloatEnergyVector from an array of FloatEnergy objects. The FloatEnergy 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 - FloatEnergy[]; the data for the vector

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

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

FloatEnergyVector

public FloatEnergyVector(FloatEnergy[] data,
 EnergyUnit displayUnit)

Construct a FloatEnergyVector from an array of FloatEnergy objects. The FloatEnergy 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 - FloatEnergy[]; the data for the vector

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

FloatEnergyVector

public FloatEnergyVector(FloatEnergy[] data,
 StorageType storageType)

Construct a FloatEnergyVector from an array of FloatEnergy objects. The FloatEnergy 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 - FloatEnergy[]; the data for the vector

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

FloatEnergyVector

public FloatEnergyVector(FloatEnergy[] data)

Construct a FloatEnergyVector from an array of FloatEnergy objects. The FloatEnergy 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 - FloatEnergy[]; the data for the vector

FloatEnergyVector

public FloatEnergyVector(List<? extends Number> data,
 EnergyUnit displayUnit,
 StorageType storageType)

Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatEnergy 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 FloatEnergy objects, each FloatEnergy 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<Energy>; the data for the vector

displayUnit - EnergyUnit; 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

FloatEnergyVector

public FloatEnergyVector(List<? extends Number> data,
 EnergyUnit displayUnit)

Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatEnergy 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 FloatEnergy objects, each FloatEnergy 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<Energy>; the data for the vector

displayUnit - EnergyUnit; 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

FloatEnergyVector

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

Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatEnergy 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<Energy>; the data for the vector

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

FloatEnergyVector

public FloatEnergyVector(List<? extends Number> data)

Construct a FloatEnergyVector from a list of Number objects or a list of FloatEnergy objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatEnergy 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<Energy>; the data for the vector

FloatEnergyVector

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

Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy 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 FloatEnergy 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 FloatEnergy objects, each FloatEnergy 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, FloatEnergy>; the data for the vector

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

displayUnit - EnergyUnit; 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

FloatEnergyVector

public FloatEnergyVector(Map<Integer,? extends Number> data,
 int size,
 EnergyUnit displayUnit)

Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy 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 FloatEnergy 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 FloatEnergy objects, each FloatEnergy 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, FloatEnergy>; the data for the vector

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

displayUnit - EnergyUnit; 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

FloatEnergyVector

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

Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy 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 FloatEnergy 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, FloatEnergy>; 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

FloatEnergyVector

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

Construct a FloatEnergyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatEnergy 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 FloatEnergy 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, FloatEnergy>; the data for the vector

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

Method Details

getScalarClass

public Class<FloatEnergy> getScalarClass()

Description copied from class: IndexedValue

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<EnergyUnit,FloatEnergy,FloatEnergyVector,FloatVectorData>

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public FloatEnergyVector instantiateVector(FloatVectorData fvd,
 EnergyUnit 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<EnergyUnit,FloatEnergy,FloatEnergyVector>

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 FloatEnergy instantiateScalarSI(float valueSI,
 EnergyUnit 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<EnergyUnit,FloatEnergy,FloatEnergyVector>

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