Package org.djunits.value.vdouble.vector

Class IlluminanceVector

java.lang.Object
org.djunits.value.IndexedValue<U,S,V,D>
org.djunits.value.base.Vector<U,S,V,DoubleVectorData>
org.djunits.value.vdouble.vector.base.DoubleVector<U,S,RV>
org.djunits.value.vdouble.vector.base.DoubleVectorRel<IlluminanceUnit,Illuminance,IlluminanceVector>
org.djunits.value.vdouble.vector.IlluminanceVector
All Implemented Interfaces:
Serializable, Cloneable, Iterable<Illuminance>, Relative<IlluminanceUnit,IlluminanceVector>, Value<IlluminanceUnit,IlluminanceVector>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-07-23T14:06:38.224104100Z") public class IlluminanceVector extends DoubleVectorRel<IlluminanceUnit,Illuminance,IlluminanceVector>
Double IlluminanceVector, a vector of values with a IlluminanceUnit.

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

    • IlluminanceVector

      public IlluminanceVector(DoubleVectorData data, IlluminanceUnit displayUnit)
      Construct an IlluminanceVector from an internal data object.
      Parameters:
      data - DoubleVectorData; the internal data object for the vector
      displayUnit - IlluminanceUnit; the display unit of the vector data

    • IlluminanceVector

      public IlluminanceVector(double[] data, IlluminanceUnit displayUnit, StorageType storageType)
      Construct an IlluminanceVector from a double[] object. The double values are expressed in the displayUnit, and will be printed using the displayUnit.
      Parameters:
      data - double[]; the data for the vector, expressed in the displayUnit
      displayUnit - IlluminanceUnit; 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

    • IlluminanceVector

      public IlluminanceVector(double[] data, IlluminanceUnit displayUnit)
      Construct an IlluminanceVector from a double[] object. The double values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array.
      Parameters:
      data - double[]; the data for the vector
      displayUnit - IlluminanceUnit; the unit of the values in the data array, and display unit when printing

    • IlluminanceVector

      public IlluminanceVector(double[] data, StorageType storageType)
      Construct an IlluminanceVector from a double[] object with SI-unit values.
      Parameters:
      data - double[]; the data for the vector, in SI units
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • IlluminanceVector

      public IlluminanceVector(double[] data)
      Construct an IlluminanceVector from a double[] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array.
      Parameters:
      data - double[]; the data for the vector, in SI units

    • IlluminanceVector

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

    • IlluminanceVector

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

    • IlluminanceVector

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

    • IlluminanceVector

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

    • IlluminanceVector

      public IlluminanceVector(List<? extends Number> data, IlluminanceUnit displayUnit, StorageType storageType)
      Construct an IlluminanceVector from a list of Number objects or a list of Illuminance objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Illuminance 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 Illuminance objects, each Illuminance 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<Double> or List<Illuminance>; the data for the vector
      displayUnit - IlluminanceUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • IlluminanceVector

      public IlluminanceVector(List<? extends Number> data, IlluminanceUnit displayUnit)
      Construct an IlluminanceVector from a list of Number objects or a list of Illuminance objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Illuminance 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 Illuminance objects, each Illuminance 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<Double> or List<Illuminance>; the data for the vector
      displayUnit - IlluminanceUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

    • IlluminanceVector

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

    • IlluminanceVector

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

    • IlluminanceVector

      public IlluminanceVector(Map<Integer,? extends Number> data, int size, IlluminanceUnit displayUnit, StorageType storageType)
      Construct an IlluminanceVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Illuminance 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., Double objects) or Illuminance 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 Illuminance objects, each Illuminance 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, Double> or Map<Integer, Illuminance>; the data for the vector
      size - int; the size off the vector, i.e., the highest index
      displayUnit - IlluminanceUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general
      storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

    • IlluminanceVector

      public IlluminanceVector(Map<Integer,? extends Number> data, int size, IlluminanceUnit displayUnit)
      Construct an IlluminanceVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Illuminance 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., Double objects) or Illuminance 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 Illuminance objects, each Illuminance 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, Double> or Map<Integer, Illuminance>; the data for the vector
      size - int; the size off the vector, i.e., the highest index
      displayUnit - IlluminanceUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

    • IlluminanceVector

      public IlluminanceVector(Map<Integer,? extends Number> data, int size, StorageType storageType)
      Construct an IlluminanceVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Illuminance 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 Double, assume that they are expressed using SI units. When the data consists of Illuminance 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, Double> or Map<Integer, Illuminance>; 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

    • IlluminanceVector

      public IlluminanceVector(Map<Integer,? extends Number> data, int size)
      Construct an IlluminanceVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Illuminance 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 Double, assume that they are expressed using SI units. When the data consists of Illuminance 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, Double> or Map<Integer, Illuminance>; the data for the vector
      size - int; the size off the vector, i.e., the highest index

  • Method Details

    • getScalarClass

      public Class<Illuminance> getScalarClass()
      Return the class of the corresponding scalar.
      Specified by:
      getScalarClass in class IndexedValue<IlluminanceUnit,Illuminance,IlluminanceVector,DoubleVectorData>
      Returns:
      Class<S>; the class of the corresponding scalar

    • instantiateVector

      public IlluminanceVector instantiateVector(DoubleVectorData dvd, IlluminanceUnit 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.
      Specified by:
      instantiateVector in class DoubleVector<IlluminanceUnit,Illuminance,IlluminanceVector>
      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 Illuminance instantiateScalarSI(double valueSI, IlluminanceUnit 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.
      Specified by:
      instantiateScalarSI in class DoubleVector<IlluminanceUnit,Illuminance,IlluminanceVector>
      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