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