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