1 package org.djunits.value.vfloat.scalar;
2
3 import java.util.Locale;
4
5 import org.djunits.unit.AbsorbedDoseUnit;
6 import org.djunits.unit.AccelerationUnit;
7 import org.djunits.unit.AmountOfSubstanceUnit;
8 import org.djunits.unit.AngleUnit;
9 import org.djunits.unit.AreaUnit;
10 import org.djunits.unit.CatalyticActivityUnit;
11 import org.djunits.unit.DensityUnit;
12 import org.djunits.unit.DimensionlessUnit;
13 import org.djunits.unit.DurationUnit;
14 import org.djunits.unit.ElectricalCapacitanceUnit;
15 import org.djunits.unit.ElectricalChargeUnit;
16 import org.djunits.unit.ElectricalConductanceUnit;
17 import org.djunits.unit.ElectricalCurrentUnit;
18 import org.djunits.unit.ElectricalInductanceUnit;
19 import org.djunits.unit.ElectricalPotentialUnit;
20 import org.djunits.unit.ElectricalResistanceUnit;
21 import org.djunits.unit.EnergyUnit;
22 import org.djunits.unit.EquivalentDoseUnit;
23 import org.djunits.unit.FlowMassUnit;
24 import org.djunits.unit.FlowVolumeUnit;
25 import org.djunits.unit.ForceUnit;
26 import org.djunits.unit.FrequencyUnit;
27 import org.djunits.unit.IlluminanceUnit;
28 import org.djunits.unit.LengthUnit;
29 import org.djunits.unit.LinearDensityUnit;
30 import org.djunits.unit.LuminousFluxUnit;
31 import org.djunits.unit.LuminousIntensityUnit;
32 import org.djunits.unit.MagneticFluxDensityUnit;
33 import org.djunits.unit.MagneticFluxUnit;
34 import org.djunits.unit.MassUnit;
35 import org.djunits.unit.PowerUnit;
36 import org.djunits.unit.PressureUnit;
37 import org.djunits.unit.RadioActivityUnit;
38 import org.djunits.unit.SolidAngleUnit;
39 import org.djunits.unit.SpeedUnit;
40 import org.djunits.unit.TemperatureUnit;
41 import org.djunits.unit.TorqueUnit;
42 import org.djunits.unit.VolumeUnit;
43 import org.djunits.value.function.DimensionlessFunctions;
44 import org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel;
45 import org.djutils.base.NumberParser;
46 import org.djutils.exceptions.Throw;
47
48 import jakarta.annotation.Generated;
49
50
51
52
53
54
55
56
57
58
59 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
60 public class FloatDimensionless extends AbstractFloatScalarRel<DimensionlessUnit, FloatDimensionless>
61 implements DimensionlessFunctions<DimensionlessUnit, FloatDimensionless>
62 {
63
64 private static final long serialVersionUID = 20150901L;
65
66
67 public static final FloatDimensionless ZERO = new FloatDimensionless(0.0f, DimensionlessUnit.SI);
68
69
70 public static final FloatDimensionless ONE = new FloatDimensionless(1.0f, DimensionlessUnit.SI);
71
72
73 @SuppressWarnings("checkstyle:constantname")
74 public static final FloatDimensionless NaN = new FloatDimensionless(Float.NaN, DimensionlessUnit.SI);
75
76
77 public static final FloatDimensionless POSITIVE_INFINITY =
78 new FloatDimensionless(Float.POSITIVE_INFINITY, DimensionlessUnit.SI);
79
80
81 public static final FloatDimensionless NEGATIVE_INFINITY =
82 new FloatDimensionless(Float.NEGATIVE_INFINITY, DimensionlessUnit.SI);
83
84
85 public static final FloatDimensionless POS_MAXVALUE = new FloatDimensionless(Float.MAX_VALUE, DimensionlessUnit.SI);
86
87
88 public static final FloatDimensionless NEG_MAXVALUE = new FloatDimensionless(-Float.MAX_VALUE, DimensionlessUnit.SI);
89
90
91
92
93
94
95 public FloatDimensionless(final float value, final DimensionlessUnit unit)
96 {
97 super(value, unit);
98 }
99
100
101
102
103
104 public FloatDimensionless(final FloatDimensionless value)
105 {
106 super(value);
107 }
108
109
110
111
112
113
114 public FloatDimensionless(final double value, final DimensionlessUnit unit)
115 {
116 super((float) value, unit);
117 }
118
119
120 @Override
121 public final FloatDimensionless instantiateRel(final float value, final DimensionlessUnit unit)
122 {
123 return new FloatDimensionless(value, unit);
124 }
125
126
127
128
129
130
131 public static final FloatDimensionless instantiateSI(final float value)
132 {
133 return new FloatDimensionless(value, DimensionlessUnit.SI);
134 }
135
136
137
138
139
140
141
142
143 public static FloatDimensionless interpolate(final FloatDimensionless zero, final FloatDimensionless one, final float ratio)
144 {
145 return new FloatDimensionless(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
146 zero.getDisplayUnit());
147 }
148
149
150
151
152
153
154
155 public static FloatDimensionless max(final FloatDimensionless r1, final FloatDimensionless r2)
156 {
157 return r1.gt(r2) ? r1 : r2;
158 }
159
160
161
162
163
164
165
166
167 public static FloatDimensionless max(final FloatDimensionless r1, final FloatDimensionless r2,
168 final FloatDimensionless... rn)
169 {
170 FloatDimensionless maxr = r1.gt(r2) ? r1 : r2;
171 for (FloatDimensionless r : rn)
172 {
173 if (r.gt(maxr))
174 {
175 maxr = r;
176 }
177 }
178 return maxr;
179 }
180
181
182
183
184
185
186
187 public static FloatDimensionless min(final FloatDimensionless r1, final FloatDimensionless r2)
188 {
189 return r1.lt(r2) ? r1 : r2;
190 }
191
192
193
194
195
196
197
198
199 public static FloatDimensionless min(final FloatDimensionless r1, final FloatDimensionless r2,
200 final FloatDimensionless... rn)
201 {
202 FloatDimensionless minr = r1.lt(r2) ? r1 : r2;
203 for (FloatDimensionless r : rn)
204 {
205 if (r.lt(minr))
206 {
207 minr = r;
208 }
209 }
210 return minr;
211 }
212
213
214
215
216
217
218
219
220
221
222 public static FloatDimensionless valueOf(final String text)
223 {
224 Throw.whenNull(text, "Error parsing FloatDimensionless: text to parse is null");
225 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatDimensionless: empty text to parse");
226 try
227 {
228 NumberParser numberParser = new NumberParser().lenient().trailing();
229 float f = numberParser.parseFloat(text);
230 String unitString = text.substring(numberParser.getTrailingPosition()).trim();
231 DimensionlessUnit unit = DimensionlessUnit.BASE.getUnitByAbbreviation(unitString);
232 if (unit == null)
233 throw new IllegalArgumentException("Unit " + unitString + " not found");
234 return new FloatDimensionless(f, unit);
235 }
236 catch (Exception exception)
237 {
238 throw new IllegalArgumentException("Error parsing FloatDimensionless from " + text + " using Locale "
239 + Locale.getDefault(Locale.Category.FORMAT), exception);
240 }
241 }
242
243
244
245
246
247
248
249
250
251 public static FloatDimensionless of(final float value, final String unitString)
252 {
253 Throw.whenNull(unitString, "Error parsing FloatDimensionless: unitString is null");
254 Throw.when(unitString.length() == 0, IllegalArgumentException.class,
255 "Error parsing FloatDimensionless: empty unitString");
256 DimensionlessUnit unit = DimensionlessUnit.BASE.getUnitByAbbreviation(unitString);
257 if (unit != null)
258 {
259 return new FloatDimensionless(value, unit);
260 }
261 throw new IllegalArgumentException("Error parsing FloatDimensionless with unit " + unitString);
262 }
263
264
265 @Override
266 public String toStringSIPrefixed(final int smallestPower, final int biggestPower)
267 {
268 return toString();
269 }
270
271
272 @Override
273 public final FloatDimensionless acos()
274 {
275 return instantiateRel((float) Math.acos(getInUnit()), getDisplayUnit());
276 }
277
278
279 @Override
280 public final FloatDimensionless asin()
281 {
282 return instantiateRel((float) Math.asin(getInUnit()), getDisplayUnit());
283 }
284
285
286 @Override
287 public final FloatDimensionless atan()
288 {
289 return instantiateRel((float) Math.atan(getInUnit()), getDisplayUnit());
290 }
291
292
293 @Override
294 public final FloatDimensionless cbrt()
295 {
296 return instantiateRel((float) Math.cbrt(getInUnit()), getDisplayUnit());
297 }
298
299
300 @Override
301 public final FloatDimensionless cos()
302 {
303 return instantiateRel((float) Math.cos(getInUnit()), getDisplayUnit());
304 }
305
306
307 @Override
308 public final FloatDimensionless cosh()
309 {
310 return instantiateRel((float) Math.cosh(getInUnit()), getDisplayUnit());
311 }
312
313
314 @Override
315 public final FloatDimensionless exp()
316 {
317 return instantiateRel((float) Math.exp(getInUnit()), getDisplayUnit());
318 }
319
320
321 @Override
322 public final FloatDimensionless expm1()
323 {
324 return instantiateRel((float) Math.expm1(getInUnit()), getDisplayUnit());
325 }
326
327
328 @Override
329 public final FloatDimensionless log()
330 {
331 return instantiateRel((float) Math.log(getInUnit()), getDisplayUnit());
332 }
333
334
335 @Override
336 public final FloatDimensionless log10()
337 {
338 return instantiateRel((float) Math.log10(getInUnit()), getDisplayUnit());
339 }
340
341
342 @Override
343 public final FloatDimensionless log1p()
344 {
345 return instantiateRel((float) Math.log1p(getInUnit()), getDisplayUnit());
346 }
347
348
349 @Override
350 public final FloatDimensionless pow(final double x)
351 {
352 return instantiateRel((float) Math.pow(getInUnit(), x), getDisplayUnit());
353 }
354
355
356 @Override
357 public final FloatDimensionless signum()
358 {
359 return instantiateRel(Math.signum(getInUnit()), getDisplayUnit());
360 }
361
362
363 @Override
364 public final FloatDimensionless sin()
365 {
366 return instantiateRel((float) Math.sin(getInUnit()), getDisplayUnit());
367 }
368
369
370 @Override
371 public final FloatDimensionless sinh()
372 {
373 return instantiateRel((float) Math.sinh(getInUnit()), getDisplayUnit());
374 }
375
376
377 @Override
378 public final FloatDimensionless sqrt()
379 {
380 return instantiateRel((float) Math.sqrt(getInUnit()), getDisplayUnit());
381 }
382
383
384 @Override
385 public final FloatDimensionless tan()
386 {
387 return instantiateRel((float) Math.tan(getInUnit()), getDisplayUnit());
388 }
389
390
391 @Override
392 public final FloatDimensionless tanh()
393 {
394 return instantiateRel((float) Math.tanh(getInUnit()), getDisplayUnit());
395 }
396
397
398 @Override
399 public final FloatDimensionless inv()
400 {
401 return instantiateRel(1.0f / getInUnit(), getDisplayUnit());
402 }
403
404
405
406
407
408
409 public final FloatDimensionless divide(final FloatDimensionless v)
410 {
411 return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
412 }
413
414
415
416
417
418
419 public final FloatAbsorbedDose times(final FloatAbsorbedDose v)
420 {
421 return new FloatAbsorbedDose(this.si * v.si, AbsorbedDoseUnit.SI);
422 }
423
424
425
426
427
428
429 public final FloatAcceleration times(final FloatAcceleration v)
430 {
431 return new FloatAcceleration(this.si * v.si, AccelerationUnit.SI);
432 }
433
434
435
436
437
438
439
440 public final FloatAmountOfSubstance times(final FloatAmountOfSubstance v)
441 {
442 return new FloatAmountOfSubstance(this.si * v.si, AmountOfSubstanceUnit.SI);
443 }
444
445
446
447
448
449
450 public final FloatAngle times(final FloatAngle v)
451 {
452 return new FloatAngle(this.si * v.si, AngleUnit.SI);
453 }
454
455
456
457
458
459
460 public final FloatSolidAngle times(final FloatSolidAngle v)
461 {
462 return new FloatSolidAngle(this.si * v.si, SolidAngleUnit.SI);
463 }
464
465
466
467
468
469
470 public final FloatArea times(final FloatArea v)
471 {
472 return new FloatArea(this.si * v.si, AreaUnit.SI);
473 }
474
475
476
477
478
479
480
481 public final FloatCatalyticActivity times(final FloatCatalyticActivity v)
482 {
483 return new FloatCatalyticActivity(this.si * v.si, CatalyticActivityUnit.SI);
484 }
485
486
487
488
489
490
491 public final FloatDensity times(final FloatDensity v)
492 {
493 return new FloatDensity(this.si * v.si, DensityUnit.SI);
494 }
495
496
497
498
499
500
501 public final FloatDimensionless times(final FloatDimensionless v)
502 {
503 return new FloatDimensionless(this.si * v.si, DimensionlessUnit.SI);
504 }
505
506
507
508
509
510
511
512 public final FloatElectricalCapacitance times(final FloatElectricalCapacitance v)
513 {
514 return new FloatElectricalCapacitance(this.si * v.si, ElectricalCapacitanceUnit.SI);
515 }
516
517
518
519
520
521
522
523 public final FloatElectricalCharge times(final FloatElectricalCharge v)
524 {
525 return new FloatElectricalCharge(this.si * v.si, ElectricalChargeUnit.SI);
526 }
527
528
529
530
531
532
533
534 public final FloatElectricalConductance times(final FloatElectricalConductance v)
535 {
536 return new FloatElectricalConductance(this.si * v.si, ElectricalConductanceUnit.SI);
537 }
538
539
540
541
542
543
544
545 public final FloatElectricalCurrent times(final FloatElectricalCurrent v)
546 {
547 return new FloatElectricalCurrent(this.si * v.si, ElectricalCurrentUnit.SI);
548 }
549
550
551
552
553
554
555
556 public final FloatElectricalInductance times(final FloatElectricalInductance v)
557 {
558 return new FloatElectricalInductance(this.si * v.si, ElectricalInductanceUnit.SI);
559 }
560
561
562
563
564
565
566
567 public final FloatElectricalPotential times(final FloatElectricalPotential v)
568 {
569 return new FloatElectricalPotential(this.si * v.si, ElectricalPotentialUnit.SI);
570 }
571
572
573
574
575
576
577
578 public final FloatElectricalResistance times(final FloatElectricalResistance v)
579 {
580 return new FloatElectricalResistance(this.si * v.si, ElectricalResistanceUnit.SI);
581 }
582
583
584
585
586
587
588 public final FloatEnergy times(final FloatEnergy v)
589 {
590 return new FloatEnergy(this.si * v.si, EnergyUnit.SI);
591 }
592
593
594
595
596
597
598
599 public final FloatEquivalentDose times(final FloatEquivalentDose v)
600 {
601 return new FloatEquivalentDose(this.si * v.si, EquivalentDoseUnit.SI);
602 }
603
604
605
606
607
608
609 public final FloatFlowMass times(final FloatFlowMass v)
610 {
611 return new FloatFlowMass(this.si * v.si, FlowMassUnit.SI);
612 }
613
614
615
616
617
618
619 public final FloatFlowVolume times(final FloatFlowVolume v)
620 {
621 return new FloatFlowVolume(this.si * v.si, FlowVolumeUnit.SI);
622 }
623
624
625
626
627
628
629 public final FloatForce times(final FloatForce v)
630 {
631 return new FloatForce(this.si * v.si, ForceUnit.SI);
632 }
633
634
635
636
637
638
639 public final FloatFrequency times(final FloatFrequency v)
640 {
641 return new FloatFrequency(this.si * v.si, FrequencyUnit.SI);
642 }
643
644
645
646
647
648
649 public final FloatIlluminance times(final FloatIlluminance v)
650 {
651 return new FloatIlluminance(this.si * v.si, IlluminanceUnit.SI);
652 }
653
654
655
656
657
658
659 public final FloatLength times(final FloatLength v)
660 {
661 return new FloatLength(this.si * v.si, LengthUnit.SI);
662 }
663
664
665
666
667
668
669 public final FloatLinearDensity times(final FloatLinearDensity v)
670 {
671 return new FloatLinearDensity(this.si * v.si, LinearDensityUnit.SI);
672 }
673
674
675
676
677
678
679 public final FloatLuminousFlux times(final FloatLuminousFlux v)
680 {
681 return new FloatLuminousFlux(this.si * v.si, LuminousFluxUnit.SI);
682 }
683
684
685
686
687
688
689
690 public final FloatLuminousIntensity times(final FloatLuminousIntensity v)
691 {
692 return new FloatLuminousIntensity(this.si * v.si, LuminousIntensityUnit.SI);
693 }
694
695
696
697
698
699
700
701 public final FloatMagneticFluxDensity times(final FloatMagneticFluxDensity v)
702 {
703 return new FloatMagneticFluxDensity(this.si * v.si, MagneticFluxDensityUnit.SI);
704 }
705
706
707
708
709
710
711 public final FloatMagneticFlux times(final FloatMagneticFlux v)
712 {
713 return new FloatMagneticFlux(this.si * v.si, MagneticFluxUnit.SI);
714 }
715
716
717
718
719
720
721 public final FloatMass times(final FloatMass v)
722 {
723 return new FloatMass(this.si * v.si, MassUnit.SI);
724 }
725
726
727
728
729
730
731 public final FloatPower times(final FloatPower v)
732 {
733 return new FloatPower(this.si * v.si, PowerUnit.SI);
734 }
735
736
737
738
739
740
741 public final FloatPressure times(final FloatPressure v)
742 {
743 return new FloatPressure(this.si * v.si, PressureUnit.SI);
744 }
745
746
747
748
749
750
751 public final FloatRadioActivity times(final FloatRadioActivity v)
752 {
753 return new FloatRadioActivity(this.si * v.si, RadioActivityUnit.SI);
754 }
755
756
757
758
759
760
761 public final FloatSpeed times(final FloatSpeed v)
762 {
763 return new FloatSpeed(this.si * v.si, SpeedUnit.SI);
764 }
765
766
767
768
769
770
771 public final FloatTemperature times(final FloatTemperature v)
772 {
773 return new FloatTemperature(this.si * v.si, TemperatureUnit.SI);
774 }
775
776
777
778
779
780
781 public final FloatDuration times(final FloatDuration v)
782 {
783 return new FloatDuration(this.si * v.si, DurationUnit.SI);
784 }
785
786
787
788
789
790
791 public final FloatTorque times(final FloatTorque v)
792 {
793 return new FloatTorque(this.si * v.si, TorqueUnit.SI);
794 }
795
796
797
798
799
800
801 public final FloatVolume times(final FloatVolume v)
802 {
803 return new FloatVolume(this.si * v.si, VolumeUnit.SI);
804 }
805
806
807
808
809
810
811 public final FloatLinearDensity divide(final FloatLength v)
812 {
813 return new FloatLinearDensity(this.si / v.si, LinearDensityUnit.SI);
814 }
815
816
817
818
819
820
821 public final FloatLength divide(final FloatLinearDensity v)
822 {
823 return new FloatLength(this.si / v.si, LengthUnit.SI);
824 }
825
826
827
828
829
830
831 public final FloatFrequency divide(final FloatDuration v)
832 {
833 return new FloatFrequency(this.si / v.si, FrequencyUnit.SI);
834 }
835
836
837
838
839
840
841 public final FloatDuration divide(final FloatFrequency v)
842 {
843 return new FloatDuration(this.si / v.si, DurationUnit.SI);
844 }
845
846
847
848
849
850
851
852 public final FloatElectricalResistance divide(final FloatElectricalConductance v)
853 {
854 return new FloatElectricalResistance(this.si / v.si, ElectricalResistanceUnit.SI);
855 }
856
857
858
859
860
861
862
863 public final FloatElectricalConductance divide(final FloatElectricalResistance v)
864 {
865 return new FloatElectricalConductance(this.si / v.si, ElectricalConductanceUnit.SI);
866 }
867
868
869 @Override
870 public FloatDimensionless reciprocal()
871 {
872 return FloatDimensionless.instantiateSI(1.0f / this.si);
873 }
874
875 }