Package org.djunits.value.vfloat.vector

Class FloatFrequencyVector

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

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

    • FloatFrequencyVector

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

  • Method Details