View Javadoc
1   package org.djunits.value.vdouble.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.AmountOfSubstanceUnit;
6   import org.djunits.unit.CatalyticActivityUnit;
7   import org.djunits.unit.DimensionlessUnit;
8   import org.djunits.unit.DurationUnit;
9   import org.djunits.value.vdouble.scalar.base.DoubleScalar;
10  import org.djunits.value.vdouble.scalar.base.DoubleScalarRel;
11  import org.djutils.base.NumberParser;
12  import org.djutils.exceptions.Throw;
13  
14  import jakarta.annotation.Generated;
15  
16  /**
17   * Easy access methods for the AmountOfSubstance DoubleScalar, which is relative by definition.
18   * <p>
19   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
20   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
21   * </p>
22   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
23   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
24   */
25  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
26  public class AmountOfSubstance extends DoubleScalarRel<AmountOfSubstanceUnit, AmountOfSubstance>
27  {
28      /** */
29      private static final long serialVersionUID = 20150905L;
30  
31      /** Constant with value zero. */
32      public static final AmountOfSubstance ZERO = new AmountOfSubstance(0.0, AmountOfSubstanceUnit.SI);
33  
34      /** Constant with value one. */
35      public static final AmountOfSubstance ONE = new AmountOfSubstance(1.0, AmountOfSubstanceUnit.SI);
36  
37      /** Constant with value NaN. */
38      @SuppressWarnings("checkstyle:constantname")
39      public static final AmountOfSubstance NaN = new AmountOfSubstance(Double.NaN, AmountOfSubstanceUnit.SI);
40  
41      /** Constant with value POSITIVE_INFINITY. */
42      public static final AmountOfSubstance POSITIVE_INFINITY =
43              new AmountOfSubstance(Double.POSITIVE_INFINITY, AmountOfSubstanceUnit.SI);
44  
45      /** Constant with value NEGATIVE_INFINITY. */
46      public static final AmountOfSubstance NEGATIVE_INFINITY =
47              new AmountOfSubstance(Double.NEGATIVE_INFINITY, AmountOfSubstanceUnit.SI);
48  
49      /** Constant with value MAX_VALUE. */
50      public static final AmountOfSubstance POS_MAXVALUE = new AmountOfSubstance(Double.MAX_VALUE, AmountOfSubstanceUnit.SI);
51  
52      /** Constant with value -MAX_VALUE. */
53      public static final AmountOfSubstance NEG_MAXVALUE = new AmountOfSubstance(-Double.MAX_VALUE, AmountOfSubstanceUnit.SI);
54  
55      /**
56       * Construct AmountOfSubstance scalar.
57       * @param value double; the double value
58       * @param unit AmountOfSubstanceUnit; unit for the double value
59       */
60      public AmountOfSubstance(final double value, final AmountOfSubstanceUnit unit)
61      {
62          super(value, unit);
63      }
64  
65      /**
66       * Construct AmountOfSubstance scalar.
67       * @param value AmountOfSubstance; Scalar from which to construct this instance
68       */
69      public AmountOfSubstance(final AmountOfSubstance value)
70      {
71          super(value);
72      }
73  
74      @Override
75      public final AmountOfSubstance instantiateRel(final double value, final AmountOfSubstanceUnit unit)
76      {
77          return new AmountOfSubstance(value, unit);
78      }
79  
80      /**
81       * Construct AmountOfSubstance scalar.
82       * @param value double; the double value in SI units
83       * @return AmountOfSubstance; the new scalar with the SI value
84       */
85      public static final AmountOfSubstance instantiateSI(final double value)
86      {
87          return new AmountOfSubstance(value, AmountOfSubstanceUnit.SI);
88      }
89  
90      /**
91       * Interpolate between two values.
92       * @param zero AmountOfSubstance; the low value
93       * @param one AmountOfSubstance; the high value
94       * @param ratio double; the ratio between 0 and 1, inclusive
95       * @return AmountOfSubstance; a Scalar at the ratio between
96       */
97      public static AmountOfSubstance interpolate(final AmountOfSubstance zero, final AmountOfSubstance one, final double ratio)
98      {
99          return new AmountOfSubstance(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 AmountOfSubstance; the first scalar
106      * @param r2 AmountOfSubstance; the second scalar
107      * @return AmountOfSubstance; the maximum value of two relative scalars
108      */
109     public static AmountOfSubstance max(final AmountOfSubstance r1, final AmountOfSubstance 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 AmountOfSubstance; the first scalar
117      * @param r2 AmountOfSubstance; the second scalar
118      * @param rn AmountOfSubstance...; the other scalars
119      * @return AmountOfSubstance; the maximum value of more than two relative scalars
120      */
121     public static AmountOfSubstance max(final AmountOfSubstance r1, final AmountOfSubstance r2, final AmountOfSubstance... rn)
122     {
123         AmountOfSubstance maxr = r1.gt(r2) ? r1 : r2;
124         for (AmountOfSubstance 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 AmountOfSubstance; the first scalar
137      * @param r2 AmountOfSubstance; the second scalar
138      * @return AmountOfSubstance; the minimum value of two relative scalars
139      */
140     public static AmountOfSubstance min(final AmountOfSubstance r1, final AmountOfSubstance 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 AmountOfSubstance; the first scalar
148      * @param r2 AmountOfSubstance; the second scalar
149      * @param rn AmountOfSubstance...; the other scalars
150      * @return AmountOfSubstance; the minimum value of more than two relative scalars
151      */
152     public static AmountOfSubstance min(final AmountOfSubstance r1, final AmountOfSubstance r2, final AmountOfSubstance... rn)
153     {
154         AmountOfSubstance minr = r1.lt(r2) ? r1 : r2;
155         for (AmountOfSubstance r : rn)
156         {
157             if (r.lt(minr))
158             {
159                 minr = r;
160             }
161         }
162         return minr;
163     }
164 
165     /**
166      * Returns a AmountOfSubstance 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 a localized or English abbreviation of the unit. Spaces
168      * are allowed, but not required, between the value and the unit.
169      * @param text String; the textual representation to parse into a AmountOfSubstance
170      * @return AmountOfSubstance; 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 AmountOfSubstance valueOf(final String text)
175     {
176         Throw.whenNull(text, "Error parsing AmountOfSubstance: text to parse is null");
177         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing AmountOfSubstance: empty text to parse");
178         try
179         {
180             NumberParser numberParser = new NumberParser().lenient().trailing();
181             double d = numberParser.parseDouble(text);
182             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
183             AmountOfSubstanceUnit unit = AmountOfSubstanceUnit.BASE.getUnitByAbbreviation(unitString);
184             if (unit == null)
185                 throw new IllegalArgumentException("Unit " + unitString + " not found");
186             return new AmountOfSubstance(d, unit);
187         }
188         catch (Exception exception)
189         {
190             throw new IllegalArgumentException("Error parsing AmountOfSubstance from " + text + " using Locale "
191                     + Locale.getDefault(Locale.Category.FORMAT), exception);
192         }
193     }
194 
195     /**
196      * Returns a AmountOfSubstance based on a value and the textual representation of the unit, which can be localized.
197      * @param value double; the value to use
198      * @param unitString String; the textual representation of the unit
199      * @return AmountOfSubstance; the Scalar representation of the value in its unit
200      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
201      * @throws NullPointerException when the unitString argument is null
202      */
203     public static AmountOfSubstance of(final double value, final String unitString)
204     {
205         Throw.whenNull(unitString, "Error parsing AmountOfSubstance: unitString is null");
206         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
207                 "Error parsing AmountOfSubstance: empty unitString");
208         AmountOfSubstanceUnit unit = AmountOfSubstanceUnit.BASE.getUnitByAbbreviation(unitString);
209         if (unit != null)
210         {
211             return new AmountOfSubstance(value, unit);
212         }
213         throw new IllegalArgumentException("Error parsing AmountOfSubstance with unit " + unitString);
214     }
215 
216     /**
217      * Calculate the division of AmountOfSubstance and AmountOfSubstance, which results in a Dimensionless scalar.
218      * @param v AmountOfSubstance; scalar
219      * @return Dimensionless; scalar as a division of AmountOfSubstance and AmountOfSubstance
220      */
221     public final Dimensionless divide(final AmountOfSubstance v)
222     {
223         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
224     }
225 
226     /**
227      * Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.
228      * @param v AmountOfSubstance; scalar
229      * @return Duration; scalar as a division of AmountOfSubstance and CatalyticActivity
230      */
231     public final Duration divide(final CatalyticActivity v)
232     {
233         return new Duration(this.si / v.si, DurationUnit.SI);
234     }
235 
236     /**
237      * Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.
238      * @param v AmountOfSubstance; scalar
239      * @return CatalyticActivity; scalar as a division of AmountOfSubstance and Duration
240      */
241     public final CatalyticActivity divide(final Duration v)
242     {
243         return new CatalyticActivity(this.si / v.si, CatalyticActivityUnit.SI);
244     }
245 
246     @Override
247     public SIScalar reciprocal()
248     {
249         return DoubleScalar.divide(Dimensionless.ONE, this);
250     }
251 
252 }