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