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