View Javadoc
1   package org.djunits.value.vfloat.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.AngleUnit;
6   import org.djunits.unit.AngularAccelerationUnit;
7   import org.djunits.unit.AngularVelocityUnit;
8   import org.djunits.unit.DimensionlessUnit;
9   import org.djunits.unit.DurationUnit;
10  import org.djunits.unit.FrequencyUnit;
11  import org.djunits.value.vfloat.scalar.base.FloatScalar;
12  import org.djunits.value.vfloat.scalar.base.FloatScalarRel;
13  import org.djutils.base.NumberParser;
14  import org.djutils.exceptions.Throw;
15  
16  import jakarta.annotation.Generated;
17  
18  /**
19   * Easy access methods for the FloatAngularVelocity FloatScalar, which is relative by definition.
20   * <p>
21   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
22   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
23   * </p>
24   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
25   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
26   */
27  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
28  public class FloatAngularVelocity extends FloatScalarRel<AngularVelocityUnit, FloatAngularVelocity>
29  {
30      /** */
31      private static final long serialVersionUID = 20150901L;
32  
33      /** Constant with value zero. */
34      public static final FloatAngularVelocity ZERO = new FloatAngularVelocity(0.0f, AngularVelocityUnit.SI);
35  
36      /** Constant with value one. */
37      public static final FloatAngularVelocity ONE = new FloatAngularVelocity(1.0f, AngularVelocityUnit.SI);
38  
39      /** Constant with value NaN. */
40      @SuppressWarnings("checkstyle:constantname")
41      public static final FloatAngularVelocity NaN = new FloatAngularVelocity(Float.NaN, AngularVelocityUnit.SI);
42  
43      /** Constant with value POSITIVE_INFINITY. */
44      public static final FloatAngularVelocity POSITIVE_INFINITY =
45              new FloatAngularVelocity(Float.POSITIVE_INFINITY, AngularVelocityUnit.SI);
46  
47      /** Constant with value NEGATIVE_INFINITY. */
48      public static final FloatAngularVelocity NEGATIVE_INFINITY =
49              new FloatAngularVelocity(Float.NEGATIVE_INFINITY, AngularVelocityUnit.SI);
50  
51      /** Constant with value MAX_VALUE. */
52      public static final FloatAngularVelocity POS_MAXVALUE = new FloatAngularVelocity(Float.MAX_VALUE, AngularVelocityUnit.SI);
53  
54      /** Constant with value -MAX_VALUE. */
55      public static final FloatAngularVelocity NEG_MAXVALUE = new FloatAngularVelocity(-Float.MAX_VALUE, AngularVelocityUnit.SI);
56  
57      /**
58       * Construct FloatAngularVelocity scalar.
59       * @param value float; the float value
60       * @param unit unit for the float value
61       */
62      public FloatAngularVelocity(final float value, final AngularVelocityUnit unit)
63      {
64          super(value, unit);
65      }
66  
67      /**
68       * Construct FloatAngularVelocity scalar.
69       * @param value Scalar from which to construct this instance
70       */
71      public FloatAngularVelocity(final FloatAngularVelocity value)
72      {
73          super(value);
74      }
75  
76      /**
77       * Construct FloatAngularVelocity scalar using a double value.
78       * @param value double; the double value
79       * @param unit unit for the resulting float value
80       */
81      public FloatAngularVelocity(final double value, final AngularVelocityUnit unit)
82      {
83          super((float) value, unit);
84      }
85  
86      @Override
87      public final FloatAngularVelocity instantiateRel(final float value, final AngularVelocityUnit unit)
88      {
89          return new FloatAngularVelocity(value, unit);
90      }
91  
92      /**
93       * Construct FloatAngularVelocity scalar.
94       * @param value float; the float value in SI units
95       * @return the new scalar with the SI value
96       */
97      public static final FloatAngularVelocity instantiateSI(final float value)
98      {
99          return new FloatAngularVelocity(value, AngularVelocityUnit.SI);
100     }
101 
102     /**
103      * Interpolate between two values.
104      * @param zero the low value
105      * @param one the high value
106      * @param ratio double; the ratio between 0 and 1, inclusive
107      * @return a Scalar at the ratio between
108      */
109     public static FloatAngularVelocity interpolate(final FloatAngularVelocity zero, final FloatAngularVelocity one,
110             final float ratio)
111     {
112         return new FloatAngularVelocity(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
113                 zero.getDisplayUnit());
114     }
115 
116     /**
117      * Return the maximum value of two relative scalars.
118      * @param r1 the first scalar
119      * @param r2 the second scalar
120      * @return the maximum value of two relative scalars
121      */
122     public static FloatAngularVelocity max(final FloatAngularVelocity r1, final FloatAngularVelocity r2)
123     {
124         return r1.gt(r2) ? r1 : r2;
125     }
126 
127     /**
128      * Return the maximum value of more than two relative scalars.
129      * @param r1 the first scalar
130      * @param r2 the second scalar
131      * @param rn the other scalars
132      * @return the maximum value of more than two relative scalars
133      */
134     public static FloatAngularVelocity max(final FloatAngularVelocity r1, final FloatAngularVelocity r2,
135             final FloatAngularVelocity... rn)
136     {
137         FloatAngularVelocity maxr = r1.gt(r2) ? r1 : r2;
138         for (FloatAngularVelocity r : rn)
139         {
140             if (r.gt(maxr))
141             {
142                 maxr = r;
143             }
144         }
145         return maxr;
146     }
147 
148     /**
149      * Return the minimum value of two relative scalars.
150      * @param r1 the first scalar
151      * @param r2 the second scalar
152      * @return the minimum value of two relative scalars
153      */
154     public static FloatAngularVelocity min(final FloatAngularVelocity r1, final FloatAngularVelocity r2)
155     {
156         return r1.lt(r2) ? r1 : r2;
157     }
158 
159     /**
160      * Return the minimum value of more than two relative scalars.
161      * @param r1 the first scalar
162      * @param r2 the second scalar
163      * @param rn the other scalars
164      * @return the minimum value of more than two relative scalars
165      */
166     public static FloatAngularVelocity min(final FloatAngularVelocity r1, final FloatAngularVelocity r2,
167             final FloatAngularVelocity... rn)
168     {
169         FloatAngularVelocity minr = r1.lt(r2) ? r1 : r2;
170         for (FloatAngularVelocity r : rn)
171         {
172             if (r.lt(minr))
173             {
174                 minr = r;
175             }
176         }
177         return minr;
178     }
179 
180     /**
181      * Returns a FloatAngularVelocity representation of a textual representation of a value with a unit. The String
182      * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
183      * unit. Spaces are allowed, but not required, between the value and the unit.
184      * @param text String; the textual representation to parse into a FloatAngularVelocity
185      * @return FloatAngularVelocity; the Scalar representation of the value in its unit
186      * @throws IllegalArgumentException when the text cannot be parsed
187      * @throws NullPointerException when the text argument is null
188      */
189     public static FloatAngularVelocity valueOf(final String text)
190     {
191         Throw.whenNull(text, "Error parsing FloatAngularVelocity: text to parse is null");
192         Throw.when(text.length() == 0, IllegalArgumentException.class,
193                 "Error parsing FloatAngularVelocity: empty text to parse");
194         try
195         {
196             NumberParser numberParser = new NumberParser().lenient().trailing();
197             float f = numberParser.parseFloat(text);
198             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
199             AngularVelocityUnit unit = AngularVelocityUnit.BASE.getUnitByAbbreviation(unitString);
200             if (unit == null)
201                 throw new IllegalArgumentException("Unit " + unitString + " not found");
202             return new FloatAngularVelocity(f, unit);
203         }
204         catch (Exception exception)
205         {
206             throw new IllegalArgumentException("Error parsing FloatAngularVelocity from " + text + " using Locale "
207                     + Locale.getDefault(Locale.Category.FORMAT), exception);
208         }
209     }
210 
211     /**
212      * Returns a FloatAngularVelocity based on a value and the textual representation of the unit, which can be localized.
213      * @param value double; the value to use
214      * @param unitString String; the textual representation of the unit
215      * @return FloatAngularVelocity; the Scalar representation of the value in its unit
216      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
217      * @throws NullPointerException when the unitString argument is null
218      */
219     public static FloatAngularVelocity of(final float value, final String unitString)
220     {
221         Throw.whenNull(unitString, "Error parsing FloatAngularVelocity: unitString is null");
222         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
223                 "Error parsing FloatAngularVelocity: empty unitString");
224         AngularVelocityUnit unit = AngularVelocityUnit.BASE.getUnitByAbbreviation(unitString);
225         if (unit != null)
226         {
227             return new FloatAngularVelocity(value, unit);
228         }
229         throw new IllegalArgumentException("Error parsing FloatAngularVelocity with unit " + unitString);
230     }
231 
232     /**
233      * Calculate the division of FloatAngularVelocity and FloatAngularVelocity, which results in a FloatDimensionless scalar.
234      * @param v FloatAngularVelocity; scalar
235      * @return FloatDimensionless; scalar as a division of FloatAngularVelocity and FloatAngularVelocity
236      */
237     public final FloatDimensionless divide(final FloatAngularVelocity v)
238     {
239         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
240     }
241 
242     /**
243      * Calculate the division of FloatAngularVelocity and FloatAngle, which results in a FloatFrequency scalar.
244      * @param v FloatAngularVelocity; scalar
245      * @return FloatFrequency; scalar as a division of FloatAngularVelocity and FloatAngle
246      */
247     public final FloatFrequency divide(final FloatAngle v)
248     {
249         return new FloatFrequency(this.si / v.si, FrequencyUnit.SI);
250     }
251 
252     /**
253      * Calculate the division of FloatAngularVelocity and FloatFrequency, which results in a FloatAngle scalar.
254      * @param v FloatAngularVelocity; scalar
255      * @return FloatAngle; scalar as a division of FloatAngularVelocity and FloatFrequency
256      */
257     public final FloatAngle divide(final FloatFrequency v)
258     {
259         return new FloatAngle(this.si / v.si, AngleUnit.SI);
260     }
261 
262     /**
263      * Calculate the multiplication of FloatAngularVelocity and FloatDuration, which results in a FloatAngle scalar.
264      * @param v FloatAngularVelocity; scalar
265      * @return FloatAngle; scalar as a multiplication of FloatAngularVelocity and FloatDuration
266      */
267     public final FloatAngle times(final FloatDuration v)
268     {
269         return new FloatAngle(this.si * v.si, AngleUnit.SI);
270     }
271 
272     /**
273      * Calculate the division of FloatAngularVelocity and FloatDuration, which results in a FloatAngularAcceleration scalar.
274      * @param v FloatAngularVelocity; scalar
275      * @return FloatAngularAcceleration; scalar as a division of FloatAngularVelocity and FloatDuration
276      */
277     public final FloatAngularAcceleration divide(final FloatDuration v)
278     {
279         return new FloatAngularAcceleration(this.si / v.si, AngularAccelerationUnit.SI);
280     }
281 
282     /**
283      * Calculate the division of FloatAngularVelocity and FloatAngularAcceleration, which results in a FloatDuration scalar.
284      * @param v FloatAngularVelocity; scalar
285      * @return FloatDuration; scalar as a division of FloatAngularVelocity and FloatAngularAcceleration
286      */
287     public final FloatDuration divide(final FloatAngularAcceleration v)
288     {
289         return new FloatDuration(this.si / v.si, DurationUnit.SI);
290     }
291 
292     /**
293      * Calculate the multiplication of FloatAngularVelocity and FloatFrequency, which results in a FloatAngularAcceleration
294      * scalar.
295      * @param v FloatAngularVelocity; scalar
296      * @return FloatAngularAcceleration; scalar as a multiplication of FloatAngularVelocity and FloatFrequency
297      */
298     public final FloatAngularAcceleration times(final FloatFrequency v)
299     {
300         return new FloatAngularAcceleration(this.si * v.si, AngularAccelerationUnit.SI);
301     }
302 
303     @Override
304     public FloatSIScalar reciprocal()
305     {
306         return FloatScalar.divide(FloatDimensionless.ONE, this);
307     }
308 
309 }