View Javadoc
1   package org.djunits.value.vfloat.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.AngleUnit;
6   import org.djunits.unit.DirectionUnit;
7   import org.djunits.value.vfloat.scalar.base.FloatScalarAbs;
8   import org.djutils.base.NumberParser;
9   import org.djutils.exceptions.Throw;
10  
11  import jakarta.annotation.Generated;
12  
13  /**
14   * Easy access methods for the FloatDirection FloatScalar.
15   * <p>
16   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. <br>
17   * All rights reserved. <br>
18   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
19   * </p>
20   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
21   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
22   */
23  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
24  public class FloatDirection extends FloatScalarAbs<DirectionUnit, FloatDirection, AngleUnit, FloatAngle>
25  {
26      /** */
27      private static final long serialVersionUID = 20150901L;
28  
29      /** Constant with value zero. */
30      public static final FloatDirection ZERO = new FloatDirection(0.0f, DirectionUnit.DEFAULT);
31  
32      /**
33       * Construct FloatDirection scalar.
34       * @param value float; the float value
35       * @param unit DirectionUnit; unit for the float value
36       */
37      public FloatDirection(final float value, final DirectionUnit unit)
38      {
39          super(value, unit);
40      }
41  
42      /**
43       * Construct FloatDirection scalar using a double value.
44       * @param value double; the double value
45       * @param unit DirectionUnit; unit for the resulting float value
46       */
47      public FloatDirection(final double value, final DirectionUnit unit)
48      {
49          super((float) value, unit);
50      }
51  
52      /**
53       * Construct FloatDirection scalar.
54       * @param value FloatDirection; Scalar from which to construct this instance
55       */
56      public FloatDirection(final FloatDirection value)
57      {
58          super(value);
59      }
60  
61      @Override
62      public final FloatDirection instantiateAbs(final float value, final DirectionUnit unit)
63      {
64          return new FloatDirection(value, unit);
65      }
66  
67      @Override
68      public final FloatAngle instantiateRel(final float value, final AngleUnit unit)
69      {
70          return new FloatAngle(value, unit);
71      }
72  
73      /**
74       * Construct FloatDirection scalar.
75       * @param value float; the float value in BASE units
76       * @return FloatDirection; the new scalar with the BASE value
77       */
78      public static final FloatDirection instantiateSI(final float value)
79      {
80          return new FloatDirection(value, DirectionUnit.DEFAULT);
81      }
82  
83      /**
84       * Interpolate between two values.
85       * @param zero FloatDirection; the low value
86       * @param one FloatDirection; the high value
87       * @param ratio float; the ratio between 0 and 1, inclusive
88       * @return FloatDirection; a Scalar at the ratio between
89       */
90      public static FloatDirection interpolate(final FloatDirection zero, final FloatDirection one, final float ratio)
91      {
92          return new FloatDirection(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
93                  zero.getDisplayUnit());
94      }
95  
96      /**
97       * Return the maximum value of two absolute scalars.
98       * @param a1 FloatDirection; the first scalar
99       * @param a2 FloatDirection; the second scalar
100      * @return FloatDirection; the maximum value of two absolute scalars
101      */
102     public static FloatDirection max(final FloatDirection a1, final FloatDirection a2)
103     {
104         return a1.gt(a2) ? a1 : a2;
105     }
106 
107     /**
108      * Return the maximum value of more than two absolute scalars.
109      * @param a1 FloatDirection; the first scalar
110      * @param a2 FloatDirection; the second scalar
111      * @param an FloatDirection...; the other scalars
112      * @return FloatDirection; the maximum value of more than two absolute scalars
113      */
114     public static FloatDirection max(final FloatDirection a1, final FloatDirection a2, final FloatDirection... an)
115     {
116         FloatDirection maxa = a1.gt(a2) ? a1 : a2;
117         for (FloatDirection a : an)
118         {
119             if (a.gt(maxa))
120             {
121                 maxa = a;
122             }
123         }
124         return maxa;
125     }
126 
127     /**
128      * Return the minimum value of two absolute scalars.
129      * @param a1 FloatDirection; the first scalar
130      * @param a2 FloatDirection; the second scalar
131      * @return FloatDirection; the minimum value of two absolute scalars
132      */
133     public static FloatDirection min(final FloatDirection a1, final FloatDirection a2)
134     {
135         return a1.lt(a2) ? a1 : a2;
136     }
137 
138     /**
139      * Return the minimum value of more than two absolute scalars.
140      * @param a1 FloatDirection; the first scalar
141      * @param a2 FloatDirection; the second scalar
142      * @param an FloatDirection...; the other scalars
143      * @return FloatDirection; the minimum value of more than two absolute scalars
144      */
145     public static FloatDirection min(final FloatDirection a1, final FloatDirection a2, final FloatDirection... an)
146     {
147         FloatDirection mina = a1.lt(a2) ? a1 : a2;
148         for (FloatDirection a : an)
149         {
150             if (a.lt(mina))
151             {
152                 mina = a;
153             }
154         }
155         return mina;
156     }
157 
158     /**
159      * Returns a FloatDirection representation of a textual representation of a value with a unit. The String representation
160      * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
161      * are allowed, but not required, between the value and the unit.
162      * @param text String; the textual representation to parse into a FloatDirection
163      * @return FloatDirection; the Scalar representation of the value in its unit
164      * @throws IllegalArgumentException when the text cannot be parsed
165      * @throws NullPointerException when the text argument is null
166      */
167     public static FloatDirection valueOf(final String text)
168     {
169         Throw.whenNull(text, "Error parsing FloatDirection: text to parse is null");
170         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatDirection: empty text to parse");
171         try
172         {
173             NumberParser numberParser = new NumberParser().lenient().trailing();
174             float f = numberParser.parseFloat(text);
175             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
176             DirectionUnit unit = DirectionUnit.BASE.getUnitByAbbreviation(unitString);
177             if (unit == null)
178                 throw new IllegalArgumentException("Unit " + unitString + " not found");
179             return new FloatDirection(f, unit);
180         }
181         catch (Exception exception)
182         {
183             throw new IllegalArgumentException(
184                     "Error parsing FloatDirection from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
185                     exception);
186         }
187     }
188 
189     /**
190      * Returns a FloatDirection based on a value and the textual representation of the unit, which can be localized.
191      * @param value double; the value to use
192      * @param unitString String; the textual representation of the unit
193      * @return FloatDirection; the Scalar representation of the value in its unit
194      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
195      * @throws NullPointerException when the unitString argument is null
196      */
197     public static FloatDirection of(final float value, final String unitString)
198     {
199         Throw.whenNull(unitString, "Error parsing FloatDirection: unitString is null");
200         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FloatDirection: empty unitString");
201         DirectionUnit unit = DirectionUnit.BASE.getUnitByAbbreviation(unitString);
202         if (unit != null)
203         {
204             return new FloatDirection(value, unit);
205         }
206         throw new IllegalArgumentException("Error parsing FloatDirection with unit " + unitString);
207     }
208 
209 }