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