1 package org.djunits.value.vdouble.vector; 2 3 import java.util.List; 4 import java.util.Map; 5 6 import org.djunits.unit.LinearDensityUnit; 7 import org.djunits.unit.scale.IdentityScale; 8 import org.djunits.value.storage.StorageType; 9 import org.djunits.value.vdouble.scalar.LinearDensity; 10 import org.djunits.value.vdouble.vector.base.DoubleVectorRel; 11 import org.djunits.value.vdouble.vector.data.DoubleVectorData; 12 13 import jakarta.annotation.Generated; 14 15 /** 16 * Double LinearDensityVector, a vector of values with a LinearDensityUnit. 17 * <p> 18 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br> 19 * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>. 20 * </p> 21 * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a> 22 * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a> 23 */ 24 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z") 25 public class LinearDensityVector extends DoubleVectorRel<LinearDensityUnit, LinearDensity, LinearDensityVector> 26 27 { 28 /** */ 29 private static final long serialVersionUID = 20190905L; 30 31 /** 32 * Construct an LinearDensityVector from an internal data object. 33 * @param data DoubleVectorData; the internal data object for the vector 34 * @param displayUnit LinearDensityUnit; the display unit of the vector data 35 */ 36 public LinearDensityVector(final DoubleVectorData data, final LinearDensityUnit displayUnit) 37 { 38 super(data, displayUnit); 39 } 40 41 /* CONSTRUCTORS WITH double[] */ 42 43 /** 44 * Construct an LinearDensityVector from a double[] object. The double values are expressed in the displayUnit, and will be 45 * printed using the displayUnit. 46 * @param data double[]; the data for the vector, expressed in the displayUnit 47 * @param displayUnit LinearDensityUnit; the unit of the values in the data array, and display unit when printing 48 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 49 */ 50 public LinearDensityVector(final double[] data, final LinearDensityUnit displayUnit, final StorageType storageType) 51 { 52 this(DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType), displayUnit); 53 } 54 55 /** 56 * Construct an LinearDensityVector from a double[] object. The double values are expressed in the displayUnit. Assume that 57 * the StorageType is DENSE since we offer the data as an array. 58 * @param data double[]; the data for the vector 59 * @param displayUnit LinearDensityUnit; the unit of the values in the data array, and display unit when printing 60 */ 61 public LinearDensityVector(final double[] data, final LinearDensityUnit displayUnit) 62 { 63 this(data, displayUnit, StorageType.DENSE); 64 } 65 66 /** 67 * Construct an LinearDensityVector from a double[] object with SI-unit values. 68 * @param data double[]; the data for the vector, in SI units 69 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 70 */ 71 public LinearDensityVector(final double[] data, final StorageType storageType) 72 { 73 this(data, LinearDensityUnit.SI, storageType); 74 } 75 76 /** 77 * Construct an LinearDensityVector from a double[] object with SI-unit values. Assume that the StorageType is DENSE since 78 * we offer the data as an array. 79 * @param data double[]; the data for the vector, in SI units 80 */ 81 public LinearDensityVector(final double[] data) 82 { 83 this(data, StorageType.DENSE); 84 } 85 86 /* CONSTRUCTORS WITH LinearDensity[] */ 87 88 /** 89 * Construct an LinearDensityVector from an array of LinearDensity objects. The LinearDensity values are each expressed in 90 * their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. 91 * @param data LinearDensity[]; the data for the vector 92 * @param displayUnit LinearDensityUnit; the display unit of the values when printing 93 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 94 */ 95 public LinearDensityVector(final LinearDensity[] data, final LinearDensityUnit displayUnit, final StorageType storageType) 96 { 97 this(DoubleVectorData.instantiate(data, storageType), displayUnit); 98 } 99 100 /** 101 * Construct an LinearDensityVector from an array of LinearDensity objects. The LinearDensity values are each expressed in 102 * their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that 103 * the StorageType is DENSE since we offer the data as an array. 104 * @param data LinearDensity[]; the data for the vector 105 * @param displayUnit LinearDensityUnit; the display unit of the values when printing 106 */ 107 public LinearDensityVector(final LinearDensity[] data, final LinearDensityUnit displayUnit) 108 { 109 this(data, displayUnit, StorageType.DENSE); 110 } 111 112 /** 113 * Construct an LinearDensityVector from an array of LinearDensity objects. The LinearDensity values are each expressed in 114 * their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer 115 * the data as an array. 116 * @param data LinearDensity[]; the data for the vector 117 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 118 */ 119 public LinearDensityVector(final LinearDensity[] data, final StorageType storageType) 120 { 121 this(data, LinearDensityUnit.SI, storageType); 122 } 123 124 /** 125 * Construct an LinearDensityVector from an array of LinearDensity objects. The LinearDensity values are each expressed in 126 * their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the 127 * StorageType is DENSE since we offer the data as an array. 128 * @param data LinearDensity[]; the data for the vector 129 */ 130 public LinearDensityVector(final LinearDensity[] data) 131 { 132 this(data, StorageType.DENSE); 133 } 134 135 /* CONSTRUCTORS WITH List<Double> or List<LinearDensity> */ 136 137 /** 138 * Construct an LinearDensityVector from a list of Number objects or a list of LinearDensity objects. Note that the 139 * displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or 140 * LinearDensity objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values 141 * in the list are expressed, as well as the unit in which they will be printed. In case the list contains LinearDensity 142 * objects, each LinearDensity has its own unit, and the displayUnit is just used for printing. The values but will always 143 * be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. 144 * @param data List<Double> or List<LinearDensity>; the data for the vector 145 * @param displayUnit LinearDensityUnit; the display unit of the vector data, and the unit of the data points when the data 146 * is expressed as List<Double> or List<Number> in general 147 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 148 */ 149 public LinearDensityVector(final List<? extends Number> data, final LinearDensityUnit displayUnit, 150 final StorageType storageType) 151 { 152 this(data.size() == 0 ? DoubleVectorData.instantiate(new double[] {}, IdentityScale.SCALE, storageType) 153 : data.get(0) instanceof LinearDensity ? DoubleVectorData.instantiate(data, IdentityScale.SCALE, storageType) 154 : DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType), 155 displayUnit); 156 } 157 158 /** 159 * Construct an LinearDensityVector from a list of Number objects or a list of LinearDensity objects. Note that the 160 * displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or 161 * LinearDensity objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values 162 * in the list are expressed, as well as the unit in which they will be printed. In case the list contains LinearDensity 163 * objects, each LinearDensity has its own unit, and the displayUnit is just used for printing. The values but will always 164 * be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume 165 * the storage type is DENSE since we offer the data as a List. 166 * @param data List<Double> or List<LinearDensity>; the data for the vector 167 * @param displayUnit LinearDensityUnit; the display unit of the vector data, and the unit of the data points when the data 168 * is expressed as List<Double> or List<Number> in general 169 */ 170 public LinearDensityVector(final List<? extends Number> data, final LinearDensityUnit displayUnit) 171 { 172 this(data, displayUnit, StorageType.DENSE); 173 } 174 175 /** 176 * Construct an LinearDensityVector from a list of Number objects or a list of LinearDensity objects. When data contains 177 * numbers such as Double, assume that they are expressed using SI units. When the data consists of LinearDensity objects, 178 * they each have their own unit, but will be printed using SI units or base units. The values but will always be internally 179 * stored as SI values or base values, and expressed using the display unit or base unit when printing. 180 * @param data List<Double> or List<LinearDensity>; the data for the vector 181 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 182 */ 183 public LinearDensityVector(final List<? extends Number> data, final StorageType storageType) 184 { 185 this(data, LinearDensityUnit.SI, storageType); 186 } 187 188 /** 189 * Construct an LinearDensityVector from a list of Number objects or a list of LinearDensity objects. When data contains 190 * numbers such as Double, assume that they are expressed using SI units. When the data consists of LinearDensity objects, 191 * they each have their own unit, but will be printed using SI units or base units. The values but will always be internally 192 * stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage 193 * type is DENSE since we offer the data as a List. 194 * @param data List<Double> or List<LinearDensity>; the data for the vector 195 */ 196 public LinearDensityVector(final List<? extends Number> data) 197 { 198 this(data, StorageType.DENSE); 199 } 200 201 /* CONSTRUCTORS WITH Map<Integer, Double> or Map<Integer, LinearDensity> */ 202 203 /** 204 * Construct an LinearDensityVector from a (sparse) map of index values to Number objects or a (sparse) map of index values 205 * to of LinearDensity objects. Using index values is particularly useful for sparse vectors. The size parameter indicates 206 * the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a 207 * different meaning depending on whether the map contains Number objects (e.g., Double objects) or LinearDensity objects. 208 * In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, 209 * as well as the unit in which they will be printed. In case the map contains LinearDensity objects, each LinearDensity has 210 * its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values 211 * or base values, and expressed using the display unit or base unit when printing. 212 * @param data Map<Integer, Double> or Map<Integer, LinearDensity>; the data for the vector 213 * @param size int; the size off the vector, i.e., the highest index 214 * @param displayUnit LinearDensityUnit; the display unit of the vector data, and the unit of the data points when the data 215 * is expressed as List<Double> or List<Number> in general 216 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 217 */ 218 public LinearDensityVector(final Map<Integer, ? extends Number> data, final int size, final LinearDensityUnit displayUnit, 219 final StorageType storageType) 220 { 221 this(data.size() == 0 ? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType) 222 : data.values().iterator().next() instanceof LinearDensity 223 ? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType) 224 : DoubleVectorData.instantiate(data, size, displayUnit.getScale(), storageType), 225 displayUnit); 226 } 227 228 /** 229 * Construct an LinearDensityVector from a (sparse) map of index values to Number objects or a (sparse) map of index values 230 * to of LinearDensity objects. Using index values is particularly useful for sparse vectors. The size parameter indicates 231 * the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a 232 * different meaning depending on whether the map contains Number objects (e.g., Double objects) or LinearDensity objects. 233 * In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, 234 * as well as the unit in which they will be printed. In case the map contains LinearDensity objects, each LinearDensity has 235 * its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values 236 * or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since 237 * we offer the data as a Map. 238 * @param data Map<Integer, Double> or Map<Integer, LinearDensity>; the data for the vector 239 * @param size int; the size off the vector, i.e., the highest index 240 * @param displayUnit LinearDensityUnit; the display unit of the vector data, and the unit of the data points when the data 241 * is expressed as List<Double> or List<Number> in general 242 */ 243 public LinearDensityVector(final Map<Integer, ? extends Number> data, final int size, final LinearDensityUnit displayUnit) 244 { 245 this(data, size, displayUnit, StorageType.SPARSE); 246 } 247 248 /** 249 * Construct an LinearDensityVector from a (sparse) map of index values to Number objects or a (sparse) map of index values 250 * to of LinearDensity objects. Using index values is particularly useful for sparse vectors. The size parameter indicates 251 * the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as 252 * Double, assume that they are expressed using SI units. When the data consists of LinearDensity objects, they each have 253 * their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI 254 * values or base values, and expressed using the display unit or base unit when printing. 255 * @param data Map<Integer, Double> or Map<Integer, LinearDensity>; the data for the vector 256 * @param size int; the size off the vector, i.e., the highest index 257 * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector 258 */ 259 public LinearDensityVector(final Map<Integer, ? extends Number> data, final int size, final StorageType storageType) 260 { 261 this(data, size, LinearDensityUnit.SI, storageType); 262 } 263 264 /** 265 * Construct an LinearDensityVector from a (sparse) map of index values to Number objects or a (sparse) map of index values 266 * to of LinearDensity objects. Using index values is particularly useful for sparse vectors. The size parameter indicates 267 * the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as 268 * Double, assume that they are expressed using SI units. When the data consists of LinearDensity objects, they each have 269 * their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI 270 * values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE 271 * since we offer the data as a Map. 272 * @param data Map<Integer, Double> or Map<Integer, LinearDensity>; the data for the vector 273 * @param size int; the size off the vector, i.e., the highest index 274 */ 275 public LinearDensityVector(final Map<Integer, ? extends Number> data, final int size) 276 { 277 this(data, size, StorageType.SPARSE); 278 } 279 280 /* ****************************** Other methods ****************************** */ 281 282 /** {@inheritDoc} */ 283 @Override 284 public Class<LinearDensity> getScalarClass() 285 { 286 return LinearDensity.class; 287 } 288 289 /** {@inheritDoc} */ 290 @Override 291 public LinearDensityVector instantiateVector(final DoubleVectorData dvd, final LinearDensityUnit displayUnit) 292 { 293 return new LinearDensityVector(dvd, displayUnit); 294 } 295 296 /** {@inheritDoc} */ 297 @Override 298 public LinearDensity instantiateScalarSI(final double valueSI, final LinearDensityUnit displayUnit) 299 { 300 LinearDensity result = LinearDensity.instantiateSI(valueSI); 301 result.setDisplayUnit(displayUnit); 302 return result; 303 } 304 305 }