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