1 package org.djunits.value.vdouble.scalar;
2
3 import java.util.Locale;
4
5 import org.djunits.unit.AccelerationUnit;
6 import org.djunits.unit.DimensionlessUnit;
7 import org.djunits.unit.DurationUnit;
8 import org.djunits.unit.EnergyUnit;
9 import org.djunits.unit.FlowVolumeUnit;
10 import org.djunits.unit.ForceUnit;
11 import org.djunits.unit.FrequencyUnit;
12 import org.djunits.unit.LengthUnit;
13 import org.djunits.unit.MomentumUnit;
14 import org.djunits.unit.PowerUnit;
15 import org.djunits.unit.SpeedUnit;
16 import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
17 import org.djunits.value.vdouble.scalar.base.DoubleScalar;
18 import org.djutils.base.NumberParser;
19 import org.djutils.exceptions.Throw;
20
21 import jakarta.annotation.Generated;
22
23
24
25
26
27
28
29
30
31
32 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
33 public class Speed extends AbstractDoubleScalarRel<SpeedUnit, Speed>
34 {
35
36 private static final long serialVersionUID = 20150905L;
37
38
39 public static final Speed ZERO = new Speed(0.0, SpeedUnit.SI);
40
41
42 public static final Speed ONE = new Speed(1.0, SpeedUnit.SI);
43
44
45 @SuppressWarnings("checkstyle:constantname")
46 public static final Speed NaN = new Speed(Double.NaN, SpeedUnit.SI);
47
48
49 public static final Speed POSITIVE_INFINITY = new Speed(Double.POSITIVE_INFINITY, SpeedUnit.SI);
50
51
52 public static final Speed NEGATIVE_INFINITY = new Speed(Double.NEGATIVE_INFINITY, SpeedUnit.SI);
53
54
55 public static final Speed POS_MAXVALUE = new Speed(Double.MAX_VALUE, SpeedUnit.SI);
56
57
58 public static final Speed NEG_MAXVALUE = new Speed(-Double.MAX_VALUE, SpeedUnit.SI);
59
60
61
62
63
64
65 public Speed(final double value, final SpeedUnit unit)
66 {
67 super(value, unit);
68 }
69
70
71
72
73
74 public Speed(final Speed value)
75 {
76 super(value);
77 }
78
79
80 @Override
81 public final Speed instantiateRel(final double value, final SpeedUnit unit)
82 {
83 return new Speed(value, unit);
84 }
85
86
87
88
89
90
91 public static final Speed instantiateSI(final double value)
92 {
93 return new Speed(value, SpeedUnit.SI);
94 }
95
96
97
98
99
100
101
102
103 public static Speed interpolate(final Speed zero, final Speed one, final double ratio)
104 {
105 return new Speed(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio, zero.getDisplayUnit());
106 }
107
108
109
110
111
112
113
114 public static Speed max(final Speed r1, final Speed r2)
115 {
116 return r1.gt(r2) ? r1 : r2;
117 }
118
119
120
121
122
123
124
125
126 public static Speed max(final Speed r1, final Speed r2, final Speed... rn)
127 {
128 Speed maxr = r1.gt(r2) ? r1 : r2;
129 for (Speed r : rn)
130 {
131 if (r.gt(maxr))
132 {
133 maxr = r;
134 }
135 }
136 return maxr;
137 }
138
139
140
141
142
143
144
145 public static Speed min(final Speed r1, final Speed r2)
146 {
147 return r1.lt(r2) ? r1 : r2;
148 }
149
150
151
152
153
154
155
156
157 public static Speed min(final Speed r1, final Speed r2, final Speed... rn)
158 {
159 Speed minr = r1.lt(r2) ? r1 : r2;
160 for (Speed r : rn)
161 {
162 if (r.lt(minr))
163 {
164 minr = r;
165 }
166 }
167 return minr;
168 }
169
170
171
172
173
174
175
176
177
178
179 public static Speed valueOf(final String text)
180 {
181 Throw.whenNull(text, "Error parsing Speed: text to parse is null");
182 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing Speed: empty text to parse");
183 try
184 {
185 NumberParser numberParser = new NumberParser().lenient().trailing();
186 double d = numberParser.parseDouble(text);
187 String unitString = text.substring(numberParser.getTrailingPosition()).trim();
188 SpeedUnit unit = SpeedUnit.BASE.getUnitByAbbreviation(unitString);
189 if (unit == null)
190 throw new IllegalArgumentException("Unit " + unitString + " not found");
191 return new Speed(d, unit);
192 }
193 catch (Exception exception)
194 {
195 throw new IllegalArgumentException(
196 "Error parsing Speed from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
197 exception);
198 }
199 }
200
201
202
203
204
205
206
207
208
209 public static Speed of(final double value, final String unitString)
210 {
211 Throw.whenNull(unitString, "Error parsing Speed: unitString is null");
212 Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing Speed: empty unitString");
213 SpeedUnit unit = SpeedUnit.BASE.getUnitByAbbreviation(unitString);
214 if (unit != null)
215 {
216 return new Speed(value, unit);
217 }
218 throw new IllegalArgumentException("Error parsing Speed with unit " + unitString);
219 }
220
221
222
223
224
225
226 public final Dimensionless divide(final Speed v)
227 {
228 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
229 }
230
231
232
233
234
235
236 public final FlowVolume times(final Area v)
237 {
238 return new FlowVolume(this.si * v.si, FlowVolumeUnit.SI);
239 }
240
241
242
243
244
245
246 public final Power times(final Force v)
247 {
248 return new Power(this.si * v.si, PowerUnit.SI);
249 }
250
251
252
253
254
255
256 public final Acceleration times(final Frequency v)
257 {
258 return new Acceleration(this.si * v.si, AccelerationUnit.SI);
259 }
260
261
262
263
264
265
266 public final Frequency divide(final Length v)
267 {
268 return new Frequency(this.si / v.si, FrequencyUnit.SI);
269 }
270
271
272
273
274
275
276 public final Length divide(final Frequency v)
277 {
278 return new Length(this.si / v.si, LengthUnit.SI);
279 }
280
281
282
283
284
285
286 public final Frequency times(final LinearDensity v)
287 {
288 return new Frequency(this.si * v.si, FrequencyUnit.SI);
289 }
290
291
292
293
294
295
296 public final Length times(final Duration v)
297 {
298 return new Length(this.si * v.si, LengthUnit.SI);
299 }
300
301
302
303
304
305
306 public final Acceleration divide(final Duration v)
307 {
308 return new Acceleration(this.si / v.si, AccelerationUnit.SI);
309 }
310
311
312
313
314
315
316 public final Duration divide(final Acceleration v)
317 {
318 return new Duration(this.si / v.si, DurationUnit.SI);
319 }
320
321
322
323
324
325
326 public final Force times(final FlowMass v)
327 {
328 return new Force(this.si * v.si, ForceUnit.SI);
329 }
330
331
332
333
334
335
336 public final Momentum times(final Mass v)
337 {
338 return new Momentum(this.si * v.si, MomentumUnit.SI);
339 }
340
341
342
343
344
345
346 public final Energy times(final Momentum v)
347 {
348 return new Energy(this.si * v.si, EnergyUnit.SI);
349 }
350
351
352 @Override
353 public SIScalar reciprocal()
354 {
355 return DoubleScalar.divide(Dimensionless.ONE, this);
356 }
357
358 }