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