1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitRuntimeException;
6 import org.djunits.unit.Unitless;
7 import org.djunits.unit.Units;
8 import org.djunits.unit.scale.LinearScale;
9 import org.djunits.unit.scale.Scale;
10 import org.djunits.unit.si.SIUnit;
11 import org.djunits.unit.system.UnitSystem;
12
13 /**
14 * Linear object density counts the number of objects per unit of length, measured in number per meter (/m).
15 * <p>
16 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
17 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
18 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
19 * @author Alexander Verbraeck
20 */
21 public class LinearObjectDensity extends Quantity<LinearObjectDensity>
22 {
23 /** Constant with value zero. */
24 public static final LinearObjectDensity ZERO = LinearObjectDensity.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final LinearObjectDensity ONE = LinearObjectDensity.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final LinearObjectDensity NaN = LinearObjectDensity.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final LinearObjectDensity POSITIVE_INFINITY = LinearObjectDensity.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final LinearObjectDensity NEGATIVE_INFINITY = LinearObjectDensity.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final LinearObjectDensity POS_MAXVALUE = LinearObjectDensity.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final LinearObjectDensity NEG_MAXVALUE = LinearObjectDensity.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a LinearObjectDensity quantity with a unit.
50 * @param valueInUnit the value, expressed in the unit
51 * @param unit the unit in which the value is expressed
52 */
53 public LinearObjectDensity(final double valueInUnit, final LinearObjectDensity.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a LinearObjectDensity quantity with a unit, expressed as a String.
60 * @param valueInUnit the value, expressed in the unit
61 * @param abbreviation the String abbreviation of the unit in which the value is expressed
62 */
63 public LinearObjectDensity(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(LinearObjectDensity.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct LinearObjectDensity quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public LinearObjectDensity(final LinearObjectDensity value)
73 {
74 super(value.si(), LinearObjectDensity.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a LinearObjectDensity instance based on an SI value.
80 * @param si the si value
81 * @return the LinearObjectDensity instance based on an SI value
82 */
83 public static LinearObjectDensity ofSi(final double si)
84 {
85 return new LinearObjectDensity(si, LinearObjectDensity.Unit.SI);
86 }
87
88 @Override
89 public LinearObjectDensity instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return LinearObjectDensity.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a LinearObjectDensity representation of a textual representation of a value with a unit. The String
102 * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
103 * unit. Spaces are allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a LinearObjectDensity
105 * @return the Scalar representation of the value in its unit
106 * @throws IllegalArgumentException when the text cannot be parsed
107 * @throws NullPointerException when the text argument is null
108 */
109 public static LinearObjectDensity valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a LinearObjectDensity based on a value and the textual representation of the unit, which can be localized.
116 * @param valueInUnit the value, expressed in the unit as given by unitString
117 * @param unitString the textual representation of the unit
118 * @return the Scalar representation of the value in its unit
119 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
120 * @throws NullPointerException when the unitString argument is null
121 */
122 public static LinearObjectDensity of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public LinearObjectDensity.Unit getDisplayUnit()
129 {
130 return (LinearObjectDensity.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of LinearObjectDensity and LinearObjectDensity, which results in a Dimensionless quantity.
135 * @param v quantity
136 * @return quantity as a division of LinearObjectDensity and LinearObjectDensity
137 */
138 public final Dimensionless divide(final LinearObjectDensity v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the multiplication of LinearObjectDensity and Length, which results in a Dimensionless scalar.
145 * @param v scalar
146 * @return scalar as a multiplication of LinearObjectDensity and Length
147 */
148 public final Dimensionless multiply(final Length v)
149 {
150 return new Dimensionless(this.si() * v.si(), Unitless.BASE);
151 }
152
153 /**
154 * Calculate the multiplication of LinearObjectDensity and Area, which results in a Length scalar.
155 * @param v scalar
156 * @return scalar as a multiplication of LinearObjectDensity and Area
157 */
158 public final Length multiply(final Area v)
159 {
160 return new Length(this.si() * v.si(), Length.Unit.SI);
161 }
162
163 /**
164 * Calculate the multiplication of LinearObjectDensity and Energy, which results in a Force scalar.
165 * @param v scalar
166 * @return scalar as a multiplication of LinearObjectDensity and Energy
167 */
168 public final Force multiply(final Energy v)
169 {
170 return new Force(this.si() * v.si(), Force.Unit.SI);
171 }
172
173 /**
174 * Calculate the multiplication of LinearObjectDensity and Speed, which results in a Frequency scalar.
175 * @param v scalar
176 * @return scalar as a multiplication of LinearObjectDensity and Speed
177 */
178 public final Frequency multiply(final Speed v)
179 {
180 return new Frequency(this.si() * v.si(), Frequency.Unit.SI);
181 }
182
183 @Override
184 public Length reciprocal()
185 {
186 return Length.ofSi(1.0 / this.si());
187 }
188
189 /******************************************************************************************************/
190 /********************************************** UNIT CLASS ********************************************/
191 /******************************************************************************************************/
192
193 /**
194 * LinearObjectDensity.Unit encodes the unit for the number of objects per unit of length.
195 * <p>
196 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
197 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
198 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
199 * @author Alexander Verbraeck
200 */
201 @SuppressWarnings("checkstyle:constantname")
202 public static class Unit extends AbstractUnit<LinearObjectDensity.Unit, LinearObjectDensity>
203 {
204 /** The dimensions of the number of objects per unit of length: per meter (/m). */
205 public static final SIUnit SI_UNIT = SIUnit.of("/m");
206
207 /** per meter. */
208 public static final LinearObjectDensity.Unit per_m =
209 new LinearObjectDensity.Unit("/m", "per meter", 1.0, UnitSystem.SI_DERIVED);
210
211 /** The SI or BASE unit. */
212 public static final LinearObjectDensity.Unit SI = per_m.generateSiPrefixes(false, true);
213
214 /** per millimeter. */
215 public static final LinearObjectDensity.Unit per_mm = Units.resolve(LinearObjectDensity.Unit.class, "/mm");
216
217 /** per centimeter. */
218 public static final LinearObjectDensity.Unit per_cm = Units.resolve(LinearObjectDensity.Unit.class, "/cm");
219
220 /** per decimeter. */
221 public static final LinearObjectDensity.Unit per_dm = Units.resolve(LinearObjectDensity.Unit.class, "/dm");
222
223 /** per decameter. */
224 public static final LinearObjectDensity.Unit per_dam = Units.resolve(LinearObjectDensity.Unit.class, "/dam");
225
226 /** per hectometer. */
227 public static final LinearObjectDensity.Unit per_hm = Units.resolve(LinearObjectDensity.Unit.class, "/hm");
228
229 /** per kilometer. */
230 public static final LinearObjectDensity.Unit per_km = Units.resolve(LinearObjectDensity.Unit.class, "/km");
231
232 /** per inch. */
233 public static final LinearObjectDensity.Unit per_in =
234 new LinearObjectDensity.Unit("/in", "per inch", 1.0 / Length.Unit.CONST_IN, UnitSystem.IMPERIAL);
235
236 /** per foot. */
237 public static final LinearObjectDensity.Unit per_ft =
238 new LinearObjectDensity.Unit("/ft", "per foot", 1.0 / Length.Unit.CONST_FT, UnitSystem.IMPERIAL);
239
240 /** per yard. */
241 public static final LinearObjectDensity.Unit per_yd =
242 new LinearObjectDensity.Unit("/yd", "per yard", 1.0 / Length.Unit.CONST_YD, UnitSystem.IMPERIAL);
243
244 /** per mile. */
245 public static final LinearObjectDensity.Unit per_mi =
246 new LinearObjectDensity.Unit("/mi", "per mile", 1.0 / Length.Unit.CONST_MI, UnitSystem.IMPERIAL);
247
248 /**
249 * Create a new LinearObjectDensity unit.
250 * @param id the id or main abbreviation of the unit
251 * @param name the full name of the unit
252 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
253 * @param unitSystem the unit system such as SI or IMPERIAL
254 */
255 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
256 {
257 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
258 }
259
260 /**
261 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
262 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
263 * @param displayAbbreviation the display abbreviation of the unit
264 * @param name the full name of the unit
265 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
266 * @param unitSystem unit system, e.g. SI or Imperial
267 */
268 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
269 final UnitSystem unitSystem)
270 {
271 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
272 }
273
274 @Override
275 public SIUnit siUnit()
276 {
277 return SI_UNIT;
278 }
279
280 @Override
281 public Unit getBaseUnit()
282 {
283 return SI;
284 }
285
286 @Override
287 public LinearObjectDensity ofSi(final double si)
288 {
289 return LinearObjectDensity.ofSi(si);
290 }
291
292 @Override
293 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
294 final double scaleFactor, final UnitSystem unitSystem)
295 {
296 if (getScale() instanceof LinearScale ls)
297 {
298 return new LinearObjectDensity.Unit(textualAbbreviation, displayAbbreviation, name,
299 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
300 }
301 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
302 }
303
304 }
305 }