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