View Javadoc
1   package org.djunits.value.vdouble.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.DimensionlessUnit;
6   import org.djunits.unit.LuminousFluxUnit;
7   import org.djunits.unit.LuminousIntensityUnit;
8   import org.djunits.value.vdouble.scalar.base.DoubleScalar;
9   import org.djunits.value.vdouble.scalar.base.DoubleScalarRel;
10  import org.djutils.base.NumberParser;
11  import org.djutils.exceptions.Throw;
12  
13  import jakarta.annotation.Generated;
14  
15  /**
16   * Easy access methods for the LuminousIntensity DoubleScalar, which is relative by definition.
17   * <p>
18   * Copyright (c) 2013-2024 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 = "2023-07-23T14:06:38.224104100Z")
25  public class LuminousIntensity extends DoubleScalarRel<LuminousIntensityUnit, LuminousIntensity>
26  {
27      /** */
28      private static final long serialVersionUID = 20150905L;
29  
30      /** Constant with value zero. */
31      public static final LuminousIntensity ZERO = new LuminousIntensity(0.0, LuminousIntensityUnit.SI);
32  
33      /** Constant with value one. */
34      public static final LuminousIntensity ONE = new LuminousIntensity(1.0, LuminousIntensityUnit.SI);
35  
36      /** Constant with value NaN. */
37      @SuppressWarnings("checkstyle:constantname")
38      public static final 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 LuminousIntensity POS_MAXVALUE = new LuminousIntensity(Double.MAX_VALUE, LuminousIntensityUnit.SI);
50  
51      /** Constant with value -MAX_VALUE. */
52      public static final 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 LuminousIntensity(final LuminousIntensity value)
69      {
70          super(value);
71      }
72  
73      @Override
74      public final LuminousIntensity instantiateRel(final double value, final LuminousIntensityUnit unit)
75      {
76          return new LuminousIntensity(value, unit);
77      }
78  
79      /**
80       * Construct LuminousIntensity scalar.
81       * @param value double; the double value in SI units
82       * @return LuminousIntensity; the new scalar with the SI value
83       */
84      public static final LuminousIntensity instantiateSI(final double value)
85      {
86          return new LuminousIntensity(value, LuminousIntensityUnit.SI);
87      }
88  
89      /**
90       * Interpolate between two values.
91       * @param zero LuminousIntensity; the low value
92       * @param one LuminousIntensity; the high value
93       * @param ratio double; the ratio between 0 and 1, inclusive
94       * @return LuminousIntensity; a Scalar at the ratio between
95       */
96      public static LuminousIntensity interpolate(final LuminousIntensity zero, final LuminousIntensity one, final double ratio)
97      {
98          return new LuminousIntensity(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
99                  zero.getDisplayUnit());
100     }
101 
102     /**
103      * Return the maximum value of two relative scalars.
104      * @param r1 LuminousIntensity; the first scalar
105      * @param r2 LuminousIntensity; the second scalar
106      * @return LuminousIntensity; the maximum value of two relative scalars
107      */
108     public static LuminousIntensity max(final LuminousIntensity r1, final LuminousIntensity r2)
109     {
110         return r1.gt(r2) ? r1 : r2;
111     }
112 
113     /**
114      * Return the maximum value of more than two relative scalars.
115      * @param r1 LuminousIntensity; the first scalar
116      * @param r2 LuminousIntensity; the second scalar
117      * @param rn LuminousIntensity...; the other scalars
118      * @return LuminousIntensity; the maximum value of more than two relative scalars
119      */
120     public static LuminousIntensity max(final LuminousIntensity r1, final LuminousIntensity r2, final LuminousIntensity... rn)
121     {
122         LuminousIntensity maxr = r1.gt(r2) ? r1 : r2;
123         for (LuminousIntensity r : rn)
124         {
125             if (r.gt(maxr))
126             {
127                 maxr = r;
128             }
129         }
130         return maxr;
131     }
132 
133     /**
134      * Return the minimum value of two relative scalars.
135      * @param r1 LuminousIntensity; the first scalar
136      * @param r2 LuminousIntensity; the second scalar
137      * @return LuminousIntensity; the minimum value of two relative scalars
138      */
139     public static LuminousIntensity min(final LuminousIntensity r1, final LuminousIntensity r2)
140     {
141         return r1.lt(r2) ? r1 : r2;
142     }
143 
144     /**
145      * Return the minimum value of more than two relative scalars.
146      * @param r1 LuminousIntensity; the first scalar
147      * @param r2 LuminousIntensity; the second scalar
148      * @param rn LuminousIntensity...; the other scalars
149      * @return LuminousIntensity; the minimum value of more than two relative scalars
150      */
151     public static LuminousIntensity min(final LuminousIntensity r1, final LuminousIntensity r2, final LuminousIntensity... rn)
152     {
153         LuminousIntensity minr = r1.lt(r2) ? r1 : r2;
154         for (LuminousIntensity r : rn)
155         {
156             if (r.lt(minr))
157             {
158                 minr = r;
159             }
160         }
161         return minr;
162     }
163 
164     /**
165      * Returns a LuminousIntensity representation of a textual representation of a value with a unit. The String representation
166      * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
167      * are allowed, but not required, between the value and the unit.
168      * @param text String; the textual representation to parse into a LuminousIntensity
169      * @return LuminousIntensity; the Scalar representation of the value in its unit
170      * @throws IllegalArgumentException when the text cannot be parsed
171      * @throws NullPointerException when the text argument is null
172      */
173     public static LuminousIntensity valueOf(final String text)
174     {
175         Throw.whenNull(text, "Error parsing LuminousIntensity: text to parse is null");
176         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing LuminousIntensity: empty text to parse");
177         try
178         {
179             NumberParser numberParser = new NumberParser().lenient().trailing();
180             double d = numberParser.parseDouble(text);
181             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
182             LuminousIntensityUnit unit = LuminousIntensityUnit.BASE.getUnitByAbbreviation(unitString);
183             if (unit == null)
184                 throw new IllegalArgumentException("Unit " + unitString + " not found");
185             return new LuminousIntensity(d, unit);
186         }
187         catch (Exception exception)
188         {
189             throw new IllegalArgumentException("Error parsing LuminousIntensity from " + text + " using Locale "
190                     + Locale.getDefault(Locale.Category.FORMAT), exception);
191         }
192     }
193 
194     /**
195      * Returns a LuminousIntensity based on a value and the textual representation of the unit, which can be localized.
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     @Override
236     public SIScalar reciprocal()
237     {
238         return DoubleScalar.divide(Dimensionless.ONE, this);
239     }
240 
241 }