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