View Javadoc
1   package org.djunits.value.vfloat.matrix;
2   
3   import java.util.Collection;
4   
5   import org.djunits.unit.LuminousIntensityUnit;
6   import org.djunits.value.storage.StorageType;
7   import org.djunits.value.vfloat.matrix.base.FloatMatrixRel;
8   import org.djunits.value.vfloat.matrix.base.FloatSparseValue;
9   import org.djunits.value.vfloat.matrix.data.FloatMatrixData;
10  import org.djunits.value.vfloat.scalar.FloatLuminousIntensity;
11  import org.djunits.value.vfloat.vector.FloatLuminousIntensityVector;
12  import org.djunits.value.vfloat.vector.data.FloatVectorData;
13  
14  import jakarta.annotation.Generated;
15  
16  /**
17   * Immutable FloatFloatLuminousIntensityMatrix, a matrix of values with a LuminousIntensityUnit.
18   * <p>
19   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
20   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
21   * </p>
22   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
23   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
24   */
25  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
26  public class FloatLuminousIntensityMatrix extends FloatMatrixRel<LuminousIntensityUnit, FloatLuminousIntensity,
27          FloatLuminousIntensityVector, FloatLuminousIntensityMatrix>
28  
29  {
30      /** */
31      private static final long serialVersionUID = 20151109L;
32  
33      /**
34       * Construct a FloatLuminousIntensityMatrix from an internal data object.
35       * @param data FloatMatrixData; the internal data object for the matrix
36       * @param displayUnit LuminousIntensityUnit; the display unit of the matrix data
37       */
38      public FloatLuminousIntensityMatrix(final FloatMatrixData data, final LuminousIntensityUnit displayUnit)
39      {
40          super(data, displayUnit);
41      }
42  
43      /* CONSTRUCTORS WITH float[][] */
44  
45      /**
46       * Construct a FloatLuminousIntensityMatrix from a float[][] object. The float values are expressed in the displayUnit, and
47       * will be printed using the displayUnit.
48       * @param data float[][]; the data for the matrix, expressed in the displayUnit
49       * @param displayUnit LuminousIntensityUnit; the unit of the values in the data array, and display unit when printing
50       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
51       */
52      public FloatLuminousIntensityMatrix(final float[][] data, final LuminousIntensityUnit displayUnit,
53              final StorageType storageType)
54      {
55          this(FloatMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
56      }
57  
58      /**
59       * Construct a FloatLuminousIntensityMatrix from a float[][] object. The float values are expressed in the displayUnit.
60       * Assume that the StorageType is DENSE since we offer the data as an array of an array.
61       * @param data float[][]; the data for the matrix
62       * @param displayUnit LuminousIntensityUnit; the unit of the values in the data array, and display unit when printing
63       */
64      public FloatLuminousIntensityMatrix(final float[][] data, final LuminousIntensityUnit displayUnit)
65      {
66          this(data, displayUnit, StorageType.DENSE);
67      }
68  
69      /**
70       * Construct a FloatLuminousIntensityMatrix from a float[][] object with SI-unit values.
71       * @param data float[][]; the data for the matrix, in SI units
72       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
73       */
74      public FloatLuminousIntensityMatrix(final float[][] data, final StorageType storageType)
75      {
76          this(data, LuminousIntensityUnit.SI, storageType);
77      }
78  
79      /**
80       * Construct a FloatLuminousIntensityMatrix from a float[][] object with SI-unit values. Assume that the StorageType is
81       * DENSE since we offer the data as an array of an array.
82       * @param data float[][]; the data for the matrix, in SI units
83       */
84      public FloatLuminousIntensityMatrix(final float[][] data)
85      {
86          this(data, StorageType.DENSE);
87      }
88  
89      /* CONSTRUCTORS WITH LuminousIntensity[][] */
90  
91      /**
92       * Construct a FloatLuminousIntensityMatrix from an array of an array of FloatLuminousIntensity objects. The
93       * FloatLuminousIntensity values are each expressed in their own unit, but will be internally stored as SI values, all
94       * expressed in the displayUnit when printing.
95       * @param data FloatLuminousIntensity[][]; the data for the matrix
96       * @param displayUnit LuminousIntensityUnit; the display unit of the values when printing
97       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
98       */
99      public FloatLuminousIntensityMatrix(final FloatLuminousIntensity[][] data, final LuminousIntensityUnit displayUnit,
100             final StorageType storageType)
101     {
102         this(FloatMatrixData.instantiate(data, storageType), displayUnit);
103     }
104 
105     /**
106      * Construct a FloatLuminousIntensityMatrix from an array of an array of FloatLuminousIntensity objects. The
107      * FloatLuminousIntensity values are each expressed in their own unit, but will be internally stored as SI values, all
108      * expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array of
109      * an array.
110      * @param data FloatLuminousIntensity[][]; the data for the matrix
111      * @param displayUnit LuminousIntensityUnit; the display unit of the values when printing
112      */
113     public FloatLuminousIntensityMatrix(final FloatLuminousIntensity[][] data, final LuminousIntensityUnit displayUnit)
114     {
115         this(data, displayUnit, StorageType.DENSE);
116     }
117 
118     /**
119      * Construct a FloatLuminousIntensityMatrix from an array of an array of FloatLuminousIntensity objects. The
120      * FloatLuminousIntensity values are each expressed in their own unit, but will be internally stored as SI values, and
121      * expressed using SI units when printing. since we offer the data as an array of an array.
122      * @param data FloatLuminousIntensity[][]; the data for the matrix
123      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
124      */
125     public FloatLuminousIntensityMatrix(final FloatLuminousIntensity[][] data, final StorageType storageType)
126     {
127         this(data, LuminousIntensityUnit.SI, storageType);
128     }
129 
130     /**
131      * Construct a FloatLuminousIntensityMatrix from an array of an array of FloatLuminousIntensity objects. The
132      * FloatLuminousIntensity values are each expressed in their own unit, but will be internally stored as SI values, and
133      * expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array of an
134      * array.
135      * @param data FloatLuminousIntensity[][]; the data for the matrix
136      */
137     public FloatLuminousIntensityMatrix(final FloatLuminousIntensity[][] data)
138     {
139         this(data, StorageType.DENSE);
140     }
141 
142     /* CONSTRUCTORS WITH Collection<FloatSparseValue> */
143 
144     /**
145      * Construct a FloatLuminousIntensityMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit
146      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
147      * printed.
148      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
149      * @param displayUnit LuminousIntensityUnit; the display unit of the matrix data, and the unit of the data points
150      * @param rows int; the number of rows of the matrix
151      * @param cols int; the number of columns of the matrix
152      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
153      */
154     public FloatLuminousIntensityMatrix(final Collection<FloatSparseValue<LuminousIntensityUnit, FloatLuminousIntensity>> data,
155             final LuminousIntensityUnit displayUnit, final int rows, final int cols, final StorageType storageType)
156     {
157         this(FloatMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
158     }
159 
160     /**
161      * Construct a FloatLuminousIntensityMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit
162      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
163      * printed. Assume the storage type is SPARSE, since we offer the data as a collection.
164      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
165      * @param displayUnit LuminousIntensityUnit; the display unit of the matrix data, and the unit of the data points
166      * @param rows int; the number of rows of the matrix
167      * @param cols int; the number of columns of the matrix
168      */
169     public FloatLuminousIntensityMatrix(final Collection<FloatSparseValue<LuminousIntensityUnit, FloatLuminousIntensity>> data,
170             final LuminousIntensityUnit displayUnit, final int rows, final int cols)
171     {
172         this(data, displayUnit, rows, cols, StorageType.SPARSE);
173     }
174 
175     /**
176      * Construct a FloatLuminousIntensityMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit
177      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
178      * printed. Use the SI unit or base unit as the displayUnit.
179      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
180      * @param rows int; the number of rows of the matrix
181      * @param cols int; the number of columns of the matrix
182      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
183      */
184     public FloatLuminousIntensityMatrix(final Collection<FloatSparseValue<LuminousIntensityUnit, FloatLuminousIntensity>> data,
185             final int rows, final int cols, final StorageType storageType)
186     {
187         this(data, LuminousIntensityUnit.SI, rows, cols, storageType);
188     }
189 
190     /**
191      * Construct a FloatLuminousIntensityMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit
192      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
193      * printed. Use the SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a
194      * collection.
195      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
196      * @param rows int; the number of rows of the matrix
197      * @param cols int; the number of columns of the matrix
198      */
199     public FloatLuminousIntensityMatrix(final Collection<FloatSparseValue<LuminousIntensityUnit, FloatLuminousIntensity>> data,
200             final int rows, final int cols)
201     {
202         this(data, LuminousIntensityUnit.SI, rows, cols, StorageType.SPARSE);
203     }
204 
205     /** {@inheritDoc} */
206     @Override
207     public Class<FloatLuminousIntensity> getScalarClass()
208     {
209         return FloatLuminousIntensity.class;
210     }
211 
212     /** {@inheritDoc} */
213     @Override
214     public Class<FloatLuminousIntensityVector> getVectorClass()
215     {
216         return FloatLuminousIntensityVector.class;
217     }
218 
219     /** {@inheritDoc} */
220     @Override
221     public FloatLuminousIntensityMatrix instantiateMatrix(final FloatMatrixData fmd, final LuminousIntensityUnit displayUnit)
222     {
223         return new FloatLuminousIntensityMatrix(fmd, displayUnit);
224     }
225 
226     /** {@inheritDoc} */
227     @Override
228     public FloatLuminousIntensityVector instantiateVector(final FloatVectorData fvd, final LuminousIntensityUnit displayUnit)
229     {
230         return new FloatLuminousIntensityVector(fvd, displayUnit);
231     }
232 
233     /** {@inheritDoc} */
234     @Override
235     public FloatLuminousIntensity instantiateScalarSI(final float valueSI, final LuminousIntensityUnit displayUnit)
236     {
237         FloatLuminousIntensity result = FloatLuminousIntensity.instantiateSI(valueSI);
238         result.setDisplayUnit(displayUnit);
239         return result;
240     }
241 
242 }