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