Package org.djunits.value.vfloat.vector

Class FloatVolumeVector

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<VolumeUnit,FloatVolume,FloatVolumeVector>
org.djunits.value.vfloat.vector.FloatVolumeVector
All Implemented Interfaces:
Serializable, Cloneable, Iterable<FloatVolume>, Relative<VolumeUnit,FloatVolumeVector>, Value<VolumeUnit,FloatVolumeVector>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-07-23T14:06:38.224104100Z") public class FloatVolumeVector extends FloatVectorRel<VolumeUnit,FloatVolume,FloatVolumeVector>
Immutable Float FloatVolumeVector, a vector of values with a VolumeUnit.

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:

  • Constructor Details

    • FloatVolumeVector

      public FloatVolumeVector(FloatVectorData data, VolumeUnit displayUnit)
      Construct a FloatVolumeVector from an internal data object.
      Parameters:
      data - FloatVectorData; the internal data object for the vector
      displayUnit - VolumeUnit; the display unit of the vector data

    • FloatVolumeVector

      public FloatVolumeVector(float[] data, VolumeUnit displayUnit, StorageType storageType)
      Construct a FloatVolumeVector 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 - VolumeUnit; 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

    • FloatVolumeVector

      public FloatVolumeVector(float[] data, VolumeUnit displayUnit)
      Construct a FloatVolumeVector 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 - VolumeUnit; the unit of the values in the data array, and display unit when printing

    • FloatVolumeVector

      public FloatVolumeVector(float[] data, StorageType storageType)
      Construct a FloatVolumeVector 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

    • FloatVolumeVector

      public FloatVolumeVector(float[] data)
      Construct a FloatVolumeVector 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

    • FloatVolumeVector

      public FloatVolumeVector(FloatVolume[] data, VolumeUnit displayUnit, StorageType storageType)
      Construct a FloatVolumeVector from an array of FloatVolume objects. The FloatVolume 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 - FloatVolume[]; the data for the vector
      displayUnit - VolumeUnit; the display unit of the values when printing
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • FloatVolumeVector

      public FloatVolumeVector(FloatVolume[] data, VolumeUnit displayUnit)
      Construct a FloatVolumeVector from an array of FloatVolume objects. The FloatVolume 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 - FloatVolume[]; the data for the vector
      displayUnit - VolumeUnit; the display unit of the values when printing

    • FloatVolumeVector

      public FloatVolumeVector(FloatVolume[] data, StorageType storageType)
      Construct a FloatVolumeVector from an array of FloatVolume objects. The FloatVolume 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 - FloatVolume[]; the data for the vector
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • FloatVolumeVector

      public FloatVolumeVector(FloatVolume[] data)
      Construct a FloatVolumeVector from an array of FloatVolume objects. The FloatVolume 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 - FloatVolume[]; the data for the vector

    • FloatVolumeVector

      public FloatVolumeVector(List<? extends Number> data, VolumeUnit displayUnit, StorageType storageType)
      Construct a FloatVolumeVector from a list of Number objects or a list of FloatVolume objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatVolume 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 FloatVolume objects, each FloatVolume 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<Volume>; the data for the vector
      displayUnit - VolumeUnit; 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

    • FloatVolumeVector

      public FloatVolumeVector(List<? extends Number> data, VolumeUnit displayUnit)
      Construct a FloatVolumeVector from a list of Number objects or a list of FloatVolume objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatVolume 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 FloatVolume objects, each FloatVolume 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<Volume>; the data for the vector
      displayUnit - VolumeUnit; 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

    • FloatVolumeVector

      public FloatVolumeVector(List<? extends Number> data, StorageType storageType)
      Construct a FloatVolumeVector from a list of Number objects or a list of FloatVolume objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatVolume 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<Volume>; the data for the vector
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • FloatVolumeVector

      public FloatVolumeVector(List<? extends Number> data)
      Construct a FloatVolumeVector from a list of Number objects or a list of FloatVolume objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatVolume 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<Volume>; the data for the vector

    • FloatVolumeVector

      public FloatVolumeVector(Map<Integer,? extends Number> data, int size, VolumeUnit displayUnit, StorageType storageType)
      Construct a FloatVolumeVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatVolume 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 FloatVolume 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 FloatVolume objects, each FloatVolume 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, FloatVolume>; the data for the vector
      size - int; the size off the vector, i.e., the highest index
      displayUnit - VolumeUnit; 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

    • FloatVolumeVector

      public FloatVolumeVector(Map<Integer,? extends Number> data, int size, VolumeUnit displayUnit)
      Construct a FloatVolumeVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatVolume 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 FloatVolume 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 FloatVolume objects, each FloatVolume 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, FloatVolume>; the data for the vector
      size - int; the size off the vector, i.e., the highest index
      displayUnit - VolumeUnit; 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

    • FloatVolumeVector

      public FloatVolumeVector(Map<Integer,? extends Number> data, int size, StorageType storageType)
      Construct a FloatVolumeVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatVolume 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 FloatVolume 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, FloatVolume>; 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

    • FloatVolumeVector

      public FloatVolumeVector(Map<Integer,? extends Number> data, int size)
      Construct a FloatVolumeVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatVolume 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 FloatVolume 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, FloatVolume>; the data for the vector
      size - int; the size off the vector, i.e., the highest index

  • Method Details

    • getScalarClass

      public Class<FloatVolume> getScalarClass()
      Return the class of the corresponding scalar.
      Specified by:
      getScalarClass in class IndexedValue<VolumeUnit,FloatVolume,FloatVolumeVector,FloatVectorData>
      Returns:
      Class<S>; the class of the corresponding scalar

    • instantiateVector

      public FloatVolumeVector instantiateVector(FloatVectorData fvd, VolumeUnit displayUnit)
      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<VolumeUnit,FloatVolume,FloatVolumeVector>
      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 FloatVolume instantiateScalarSI(float valueSI, VolumeUnit displayUnit)
      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<VolumeUnit,FloatVolume,FloatVolumeVector>
      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