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