View Javadoc
1   package org.djunits.value.vdouble.matrix;
2   
3   import java.util.Collection;
4   
5   import org.djunits.unit.ElectricalConductanceUnit;
6   import org.djunits.value.storage.StorageType;
7   import org.djunits.value.vdouble.matrix.base.DoubleMatrixRel;
8   import org.djunits.value.vdouble.matrix.base.DoubleSparseValue;
9   import org.djunits.value.vdouble.matrix.data.DoubleMatrixData;
10  import org.djunits.value.vdouble.scalar.ElectricalConductance;
11  import org.djunits.value.vdouble.vector.ElectricalConductanceVector;
12  import org.djunits.value.vdouble.vector.data.DoubleVectorData;
13  
14  import jakarta.annotation.Generated;
15  
16  /**
17   * Immutable Double ElectricalConductanceMatrix, a matrix of values with a ElectricalConductanceUnit.
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 ElectricalConductanceMatrix extends DoubleMatrixRel<ElectricalConductanceUnit, ElectricalConductance,
27          ElectricalConductanceVector, ElectricalConductanceMatrix>
28  
29  {
30      /** */
31      private static final long serialVersionUID = 20151109L;
32  
33      /**
34       * Construct a ElectricalConductanceMatrix from an internal data object.
35       * @param data DoubleMatrixData; the internal data object for the matrix
36       * @param displayUnit ElectricalConductanceUnit; the display unit of the matrix data
37       */
38      public ElectricalConductanceMatrix(final DoubleMatrixData data, final ElectricalConductanceUnit displayUnit)
39      {
40          super(data, displayUnit);
41      }
42  
43      /* CONSTRUCTORS WITH double[][] */
44  
45      /**
46       * Construct a ElectricalConductanceMatrix from a double[][] object. The double values are expressed in the displayUnit, and
47       * will be printed using the displayUnit.
48       * @param data double[][]; the data for the matrix, expressed in the displayUnit
49       * @param displayUnit ElectricalConductanceUnit; 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 ElectricalConductanceMatrix(final double[][] data, final ElectricalConductanceUnit displayUnit,
53              final StorageType storageType)
54      {
55          this(DoubleMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
56      }
57  
58      /**
59       * Construct a ElectricalConductanceMatrix from a double[][] object. The double 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 double[][]; the data for the matrix
62       * @param displayUnit ElectricalConductanceUnit; the unit of the values in the data array, and display unit when printing
63       */
64      public ElectricalConductanceMatrix(final double[][] data, final ElectricalConductanceUnit displayUnit)
65      {
66          this(data, displayUnit, StorageType.DENSE);
67      }
68  
69      /**
70       * Construct a ElectricalConductanceMatrix from a double[][] object with SI-unit values.
71       * @param data double[][]; 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 ElectricalConductanceMatrix(final double[][] data, final StorageType storageType)
75      {
76          this(data, ElectricalConductanceUnit.SI, storageType);
77      }
78  
79      /**
80       * Construct a ElectricalConductanceMatrix from a double[][] 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 double[][]; the data for the matrix, in SI units
83       */
84      public ElectricalConductanceMatrix(final double[][] data)
85      {
86          this(data, StorageType.DENSE);
87      }
88  
89      /* CONSTRUCTORS WITH ElectricalConductance[][] */
90  
91      /**
92       * Construct a ElectricalConductanceMatrix from an array of an array of ElectricalConductance objects. The
93       * ElectricalConductance 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 ElectricalConductance[][]; the data for the matrix
96       * @param displayUnit ElectricalConductanceUnit; 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 ElectricalConductanceMatrix(final ElectricalConductance[][] data, final ElectricalConductanceUnit displayUnit,
100             final StorageType storageType)
101     {
102         this(DoubleMatrixData.instantiate(data, storageType), displayUnit);
103     }
104 
105     /**
106      * Construct a ElectricalConductanceMatrix from an array of an array of ElectricalConductance objects. The
107      * ElectricalConductance 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 ElectricalConductance[][]; the data for the matrix
111      * @param displayUnit ElectricalConductanceUnit; the display unit of the values when printing
112      */
113     public ElectricalConductanceMatrix(final ElectricalConductance[][] data, final ElectricalConductanceUnit displayUnit)
114     {
115         this(data, displayUnit, StorageType.DENSE);
116     }
117 
118     /**
119      * Construct a ElectricalConductanceMatrix from an array of an array of ElectricalConductance objects. The
120      * ElectricalConductance 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 ElectricalConductance[][]; the data for the matrix
123      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
124      */
125     public ElectricalConductanceMatrix(final ElectricalConductance[][] data, final StorageType storageType)
126     {
127         this(data, ElectricalConductanceUnit.SI, storageType);
128     }
129 
130     /**
131      * Construct a ElectricalConductanceMatrix from an array of an array of ElectricalConductance objects. The
132      * ElectricalConductance 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 ElectricalConductance[][]; the data for the matrix
136      */
137     public ElectricalConductanceMatrix(final ElectricalConductance[][] data)
138     {
139         this(data, StorageType.DENSE);
140     }
141 
142     /* CONSTRUCTORS WITH Collection<DoubleSparseValue> */
143 
144     /**
145      * Construct a ElectricalConductanceMatrix from a (sparse) collection of DoubleSparseValue 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;DoubleSparseValue&gt;; the data for the matrix
149      * @param displayUnit ElectricalConductanceUnit; 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 ElectricalConductanceMatrix(
155             final Collection<DoubleSparseValue<ElectricalConductanceUnit, ElectricalConductance>> data,
156             final ElectricalConductanceUnit displayUnit, final int rows, final int cols, final StorageType storageType)
157     {
158         this(DoubleMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
159     }
160 
161     /**
162      * Construct a ElectricalConductanceMatrix from a (sparse) collection of DoubleSparseValue objects. The displayUnit
163      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
164      * printed. Assume the storage type is SPARSE, since we offer the data as a collection.
165      * @param data Collection&lt;DoubleSparseValue&gt;; the data for the matrix
166      * @param displayUnit ElectricalConductanceUnit; the display unit of the matrix data, and the unit of the data points
167      * @param rows int; the number of rows of the matrix
168      * @param cols int; the number of columns of the matrix
169      */
170     public ElectricalConductanceMatrix(
171             final Collection<DoubleSparseValue<ElectricalConductanceUnit, ElectricalConductance>> data,
172             final ElectricalConductanceUnit displayUnit, final int rows, final int cols)
173     {
174         this(data, displayUnit, rows, cols, StorageType.SPARSE);
175     }
176 
177     /**
178      * Construct a ElectricalConductanceMatrix from a (sparse) collection of DoubleSparseValue objects. The displayUnit
179      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
180      * printed. Use the SI unit or base unit as the displayUnit.
181      * @param data Collection&lt;DoubleSparseValue&gt;; the data for the matrix
182      * @param rows int; the number of rows of the matrix
183      * @param cols int; the number of columns of the matrix
184      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
185      */
186     public ElectricalConductanceMatrix(
187             final Collection<DoubleSparseValue<ElectricalConductanceUnit, ElectricalConductance>> data, final int rows,
188             final int cols, final StorageType storageType)
189     {
190         this(data, ElectricalConductanceUnit.SI, rows, cols, storageType);
191     }
192 
193     /**
194      * Construct a ElectricalConductanceMatrix from a (sparse) collection of DoubleSparseValue objects. The displayUnit
195      * indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be
196      * printed. Use the SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a
197      * collection.
198      * @param data Collection&lt;DoubleSparseValue&gt;; the data for the matrix
199      * @param rows int; the number of rows of the matrix
200      * @param cols int; the number of columns of the matrix
201      */
202     public ElectricalConductanceMatrix(
203             final Collection<DoubleSparseValue<ElectricalConductanceUnit, ElectricalConductance>> data, final int rows,
204             final int cols)
205     {
206         this(data, ElectricalConductanceUnit.SI, rows, cols, StorageType.SPARSE);
207     }
208 
209     /** {@inheritDoc} */
210     @Override
211     public Class<ElectricalConductance> getScalarClass()
212     {
213         return ElectricalConductance.class;
214     }
215 
216     /** {@inheritDoc} */
217     @Override
218     public Class<ElectricalConductanceVector> getVectorClass()
219     {
220         return ElectricalConductanceVector.class;
221     }
222 
223     /** {@inheritDoc} */
224     @Override
225     public ElectricalConductanceMatrix instantiateMatrix(final DoubleMatrixData dmd,
226             final ElectricalConductanceUnit displayUnit)
227     {
228         return new ElectricalConductanceMatrix(dmd, displayUnit);
229     }
230 
231     /** {@inheritDoc} */
232     @Override
233     public ElectricalConductanceVector instantiateVector(final DoubleVectorData dvd,
234             final ElectricalConductanceUnit displayUnit)
235     {
236         return new ElectricalConductanceVector(dvd, displayUnit);
237     }
238 
239     /** {@inheritDoc} */
240     @Override
241     public ElectricalConductance instantiateScalarSI(final double valueSI, final ElectricalConductanceUnit displayUnit)
242     {
243         ElectricalConductance result = ElectricalConductance.instantiateSI(valueSI);
244         result.setDisplayUnit(displayUnit);
245         return result;
246     }
247 
248 }