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.LuminousFluxUnit;
10  import org.djunits.unit.SolidAngleUnit;
11  import org.djunits.value.util.ValueUtil;
12  import org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel;
13  import org.djunits.value.vfloat.scalar.base.FloatScalar;
14  
15  /**
16   * Easy access methods for the FloatSolidAngle FloatScalar, which is relative by definition.
17   * <p>
18   * Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
19   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
20   * </p>
21   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
22   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
23   */
24  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2022-03-14T11:14:15.180987200Z")
25  public class FloatSolidAngle extends AbstractFloatScalarRel<SolidAngleUnit, FloatSolidAngle>
26  {
27      /** */
28      private static final long serialVersionUID = 20150901L;
29  
30      /** Constant with value zero. */
31      public static final FloatSolidAngleFloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle ZERO = new FloatSolidAngle(0.0f, SolidAngleUnit.SI);
32  
33      /** Constant with value one. */
34      public static final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle ONE = new FloatSolidAngle(1.0f, SolidAngleUnit.SI);
35  
36      /** Constant with value NaN. */
37      @SuppressWarnings("checkstyle:constantname")
38      public static final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle NaN = new FloatSolidAngle(Float.NaN, SolidAngleUnit.SI);
39  
40      /** Constant with value POSITIVE_INFINITY. */
41      public static final FloatSolidAnglele.html#FloatSolidAngle">FloatSolidAngle POSITIVE_INFINITY = new FloatSolidAngle(Float.POSITIVE_INFINITY, SolidAngleUnit.SI);
42  
43      /** Constant with value NEGATIVE_INFINITY. */
44      public static final FloatSolidAnglele.html#FloatSolidAngle">FloatSolidAngle NEGATIVE_INFINITY = new FloatSolidAngle(Float.NEGATIVE_INFINITY, SolidAngleUnit.SI);
45  
46      /** Constant with value MAX_VALUE. */
47      public static final FloatSolidAngleidAngle.html#FloatSolidAngle">FloatSolidAngle POS_MAXVALUE = new FloatSolidAngle(Float.MAX_VALUE, SolidAngleUnit.SI);
48  
49      /** Constant with value -MAX_VALUE. */
50      public static final FloatSolidAngleidAngle.html#FloatSolidAngle">FloatSolidAngle NEG_MAXVALUE = new FloatSolidAngle(-Float.MAX_VALUE, SolidAngleUnit.SI);
51  
52      /**
53       * Construct FloatSolidAngle scalar.
54       * @param value float; the float value
55       * @param unit unit for the float value
56       */
57      public FloatSolidAngle(final float value, final SolidAngleUnit unit)
58      {
59          super(value, unit);
60      }
61  
62      /**
63       * Construct FloatSolidAngle scalar.
64       * @param value Scalar from which to construct this instance
65       */
66      public FloatSolidAnglealar/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle(final FloatSolidAngle value)
67      {
68          super(value);
69      }
70  
71      /**
72       * Construct FloatSolidAngle scalar using a double value.
73       * @param value double; the double value
74       * @param unit unit for the resulting float value
75       */
76      public FloatSolidAngle(final double value, final SolidAngleUnit unit)
77      {
78          super((float) value, unit);
79      }
80  
81      /** {@inheritDoc} */
82      @Override
83      public final FloatSolidAngle instantiateRel(final float value, final SolidAngleUnit unit)
84      {
85          return new FloatSolidAngle(value, unit);
86      }
87  
88      /**
89       * Construct FloatSolidAngle scalar.
90       * @param value float; the float value in SI units
91       * @return the new scalar with the SI value
92       */
93      public static final FloatSolidAngle instantiateSI(final float value)
94      {
95          return new FloatSolidAngle(value, SolidAngleUnit.SI);
96      }
97  
98      /**
99       * Interpolate between two values.
100      * @param zero the low value
101      * @param one the high value
102      * @param ratio double; the ratio between 0 and 1, inclusive
103      * @return a Scalar at the ratio between
104      */
105     public static FloatSolidAngleloatSolidAngle.html#FloatSolidAngle">FloatSolidAnglelidAngle.html#FloatSolidAngle">FloatSolidAngle interpolate(final FloatSolidAngleloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle zero, final FloatSolidAngle one, final float ratio)
106     {
107         return new FloatSolidAngle(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
108                 zero.getDisplayUnit());
109     }
110 
111     /**
112      * Return the maximum value of two relative scalars.
113      * @param r1 the first scalar
114      * @param r2 the second scalar
115      * @return the maximum value of two relative scalars
116      */
117     public static FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle max(final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle r1, final FloatSolidAngle r2)
118     {
119         return r1.gt(r2) ? r1 : r2;
120     }
121 
122     /**
123      * Return the maximum value of more than two relative scalars.
124      * @param r1 the first scalar
125      * @param r2 the second scalar
126      * @param rn the other scalars
127      * @return the maximum value of more than two relative scalars
128      */
129     public static FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle max(final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle r1, final FloatSolidAngle r2, final FloatSolidAngle... rn)
130     {
131         FloatSolidAngle maxr = r1.gt(r2) ? r1 : r2;
132         for (FloatSolidAngle r : rn)
133         {
134             if (r.gt(maxr))
135             {
136                 maxr = r;
137             }
138         }
139         return maxr;
140     }
141 
142     /**
143      * Return the minimum value of two relative scalars.
144      * @param r1 the first scalar
145      * @param r2 the second scalar
146      * @return the minimum value of two relative scalars
147      */
148     public static FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle min(final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle r1, final FloatSolidAngle r2)
149     {
150         return r1.lt(r2) ? r1 : r2;
151     }
152 
153     /**
154      * Return the minimum value of more than two relative scalars.
155      * @param r1 the first scalar
156      * @param r2 the second scalar
157      * @param rn the other scalars
158      * @return the minimum value of more than two relative scalars
159      */
160     public static FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle min(final FloatSolidAngle/FloatSolidAngle.html#FloatSolidAngle">FloatSolidAngle r1, final FloatSolidAngle r2, final FloatSolidAngle... rn)
161     {
162         FloatSolidAngle minr = r1.lt(r2) ? r1 : r2;
163         for (FloatSolidAngle r : rn)
164         {
165             if (r.lt(minr))
166             {
167                 minr = r;
168             }
169         }
170         return minr;
171     }
172 
173     /**
174      * Returns a FloatSolidAngle representation of a textual representation of a value with a unit. The String representation
175      * that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are
176      * allowed, but not required, between the value and the unit.
177      * @param text String; the textual representation to parse into a FloatSolidAngle
178      * @return FloatSolidAngle; the Scalar representation of the value in its unit
179      * @throws IllegalArgumentException when the text cannot be parsed
180      * @throws NullPointerException when the text argument is null
181      */
182     public static FloatSolidAngle valueOf(final String text)
183     {
184         Throw.whenNull(text, "Error parsing FloatSolidAngle: text to parse is null");
185         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatSolidAngle: empty text to parse");
186         Matcher matcher = ValueUtil.NUMBER_PATTERN.matcher(text);
187         if (matcher.find())
188         {
189             int index = matcher.end();
190             String unitString = text.substring(index).trim();
191             String valueString = text.substring(0, index).trim();
192             SolidAngleUnit unit = SolidAngleUnit.BASE.getUnitByAbbreviation(unitString);
193             if (unit != null)
194             {
195                 float f = Float.parseFloat(valueString);
196                 return new FloatSolidAngle(f, unit);
197             }
198         }
199         throw new IllegalArgumentException("Error parsing FloatSolidAngle from " + text);
200     }
201 
202     /**
203      * Returns a FloatSolidAngle based on a value and the textual representation of the unit.
204      * @param value double; the value to use
205      * @param unitString String; the textual representation of the unit
206      * @return FloatSolidAngle; the Scalar representation of the value in its unit
207      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
208      * @throws NullPointerException when the unitString argument is null
209      */
210     public static FloatSolidAngle of(final float value, final String unitString)
211     {
212         Throw.whenNull(unitString, "Error parsing FloatSolidAngle: unitString is null");
213         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FloatSolidAngle: empty unitString");
214         SolidAngleUnit unit = SolidAngleUnit.BASE.getUnitByAbbreviation(unitString);
215         if (unit != null)
216         {
217             return new FloatSolidAngle(value, unit);
218         }
219         throw new IllegalArgumentException("Error parsing FloatSolidAngle with unit " + unitString);
220     }
221 
222     /**
223      * Calculate the division of FloatSolidAngle and FloatSolidAngle, which results in a FloatDimensionless scalar.
224      * @param v FloatSolidAngle; scalar
225      * @return FloatDimensionless; scalar as a division of FloatSolidAngle and FloatSolidAngle
226      */
227     public final FloatDimensionless divide(final FloatSolidAngle v)
228     {
229         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
230     }
231 
232     /**
233      * Calculate the multiplication of FloatSolidAngle and FloatLuminousIntensity, which results in a FloatLuminousFlux scalar.
234      * @param v FloatSolidAngle; scalar
235      * @return FloatLuminousFlux; scalar as a multiplication of FloatSolidAngle and FloatLuminousIntensity
236      */
237     public final FloatLuminousFlux times(final FloatLuminousIntensity v)
238     {
239         return new FloatLuminousFlux(this.si * v.si, LuminousFluxUnit.SI);
240     }
241 
242     /** {@inheritDoc} */
243     @Override
244     public FloatSIScalar reciprocal()
245     {
246         return FloatScalar.divide(FloatDimensionless.ONE, this);
247     }
248 
249 }