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.AbstractFloatScalarAbs;
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-2023 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-04-30T13:59:27.633664900Z")
24  public class FloatDirection extends AbstractFloatScalarAbs<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      /** {@inheritDoc} */
62      @Override
63      public final FloatDirection instantiateAbs(final float value, final DirectionUnit unit)
64      {
65          return new FloatDirection(value, unit);
66      }
67  
68      /** {@inheritDoc} */
69      @Override
70      public final FloatAngle instantiateRel(final float value, final AngleUnit unit)
71      {
72          return new FloatAngle(value, unit);
73      }
74  
75      /**
76       * Construct FloatDirection scalar.
77       * @param value float; the float value in BASE units
78       * @return FloatDirection; the new scalar with the BASE value
79       */
80      public static final FloatDirection instantiateSI(final float value)
81      {
82          return new FloatDirection(value, DirectionUnit.DEFAULT);
83      }
84  
85      /**
86       * Interpolate between two values.
87       * @param zero FloatDirection; the low value
88       * @param one FloatDirection; the high value
89       * @param ratio float; the ratio between 0 and 1, inclusive
90       * @return FloatDirection; a Scalar at the ratio between
91       */
92      public static FloatDirection interpolate(final FloatDirection zero, final FloatDirection one, final float ratio)
93      {
94          return new FloatDirection(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
95                  zero.getDisplayUnit());
96      }
97  
98      /**
99       * Return the maximum value of two absolute scalars.
100      * @param a1 FloatDirection; the first scalar
101      * @param a2 FloatDirection; the second scalar
102      * @return FloatDirection; the maximum value of two absolute scalars
103      */
104     public static FloatDirection max(final FloatDirection a1, final FloatDirection a2)
105     {
106         return a1.gt(a2) ? a1 : a2;
107     }
108 
109     /**
110      * Return the maximum value of more than two absolute scalars.
111      * @param a1 FloatDirection; the first scalar
112      * @param a2 FloatDirection; the second scalar
113      * @param an FloatDirection...; the other scalars
114      * @return FloatDirection; the maximum value of more than two absolute scalars
115      */
116     public static FloatDirection max(final FloatDirection a1, final FloatDirection a2, final FloatDirection... an)
117     {
118         FloatDirection maxa = a1.gt(a2) ? a1 : a2;
119         for (FloatDirection a : an)
120         {
121             if (a.gt(maxa))
122             {
123                 maxa = a;
124             }
125         }
126         return maxa;
127     }
128 
129     /**
130      * Return the minimum value of two absolute scalars.
131      * @param a1 FloatDirection; the first scalar
132      * @param a2 FloatDirection; the second scalar
133      * @return FloatDirection; the minimum value of two absolute scalars
134      */
135     public static FloatDirection min(final FloatDirection a1, final FloatDirection a2)
136     {
137         return a1.lt(a2) ? a1 : a2;
138     }
139 
140     /**
141      * Return the minimum value of more than two absolute scalars.
142      * @param a1 FloatDirection; the first scalar
143      * @param a2 FloatDirection; the second scalar
144      * @param an FloatDirection...; the other scalars
145      * @return FloatDirection; the minimum value of more than two absolute scalars
146      */
147     public static FloatDirection min(final FloatDirection a1, final FloatDirection a2, final FloatDirection... an)
148     {
149         FloatDirection mina = a1.lt(a2) ? a1 : a2;
150         for (FloatDirection a : an)
151         {
152             if (a.lt(mina))
153             {
154                 mina = a;
155             }
156         }
157         return mina;
158     }
159 
160     /**
161      * Returns a FloatDirection representation of a textual representation of a value with a unit. The String representation
162      * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
163      * are allowed, but not required, between the value and the unit.
164      * @param text String; the textual representation to parse into a FloatDirection
165      * @return FloatDirection; the Scalar representation of the value in its unit
166      * @throws IllegalArgumentException when the text cannot be parsed
167      * @throws NullPointerException when the text argument is null
168      */
169     public static FloatDirection valueOf(final String text)
170     {
171         Throw.whenNull(text, "Error parsing FloatDirection: text to parse is null");
172         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatDirection: empty text to parse");
173         try
174         {
175             NumberParser numberParser = new NumberParser().lenient().trailing();
176             float f = numberParser.parseFloat(text);
177             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
178             DirectionUnit unit = DirectionUnit.BASE.getUnitByAbbreviation(unitString);
179             if (unit == null)
180                 throw new IllegalArgumentException("Unit " + unitString + " not found");
181             return new FloatDirection(f, unit);
182         }
183         catch (Exception exception)
184         {
185             throw new IllegalArgumentException(
186                     "Error parsing FloatDirection from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
187                     exception);
188         }
189     }
190 
191     /**
192      * Returns a FloatDirection based on a value and the textual representation of the unit, which can be localized.
193      * @param value double; the value to use
194      * @param unitString String; the textual representation of the unit
195      * @return FloatDirection; the Scalar representation of the value in its unit
196      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
197      * @throws NullPointerException when the unitString argument is null
198      */
199     public static FloatDirection of(final float value, final String unitString)
200     {
201         Throw.whenNull(unitString, "Error parsing FloatDirection: unitString is null");
202         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FloatDirection: empty unitString");
203         DirectionUnit unit = DirectionUnit.BASE.getUnitByAbbreviation(unitString);
204         if (unit != null)
205         {
206             return new FloatDirection(value, unit);
207         }
208         throw new IllegalArgumentException("Error parsing FloatDirection with unit " + unitString);
209     }
210 
211 }