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.FrequencyUnit;
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 CatalyticActivity DoubleScalar, which is relative by definition.
17   * <p>
18   * Copyright (c) 2013-2025 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 = "2025-09-06T15:16:28.380798Z")
25  public class CatalyticActivity extends DoubleScalarRel<CatalyticActivityUnit, CatalyticActivity>
26  {
27      /** */
28      private static final long serialVersionUID = 20150905L;
29  
30      /** Constant with value zero. */
31      public static final CatalyticActivity ZERO = new CatalyticActivity(0.0, CatalyticActivityUnit.SI);
32  
33      /** Constant with value one. */
34      public static final CatalyticActivity ONE = new CatalyticActivity(1.0, CatalyticActivityUnit.SI);
35  
36      /** Constant with value NaN. */
37      @SuppressWarnings("checkstyle:constantname")
38      public static final CatalyticActivity NaN = new CatalyticActivity(Double.NaN, CatalyticActivityUnit.SI);
39  
40      /** Constant with value POSITIVE_INFINITY. */
41      public static final CatalyticActivity POSITIVE_INFINITY =
42              new CatalyticActivity(Double.POSITIVE_INFINITY, CatalyticActivityUnit.SI);
43  
44      /** Constant with value NEGATIVE_INFINITY. */
45      public static final CatalyticActivity NEGATIVE_INFINITY =
46              new CatalyticActivity(Double.NEGATIVE_INFINITY, CatalyticActivityUnit.SI);
47  
48      /** Constant with value MAX_VALUE. */
49      public static final CatalyticActivity POS_MAXVALUE = new CatalyticActivity(Double.MAX_VALUE, CatalyticActivityUnit.SI);
50  
51      /** Constant with value -MAX_VALUE. */
52      public static final CatalyticActivity NEG_MAXVALUE = new CatalyticActivity(-Double.MAX_VALUE, CatalyticActivityUnit.SI);
53  
54      /**
55       * Construct CatalyticActivity scalar with a unit.
56       * @param value the double value, expressed in the given unit
57       * @param unit unit for the double value
58       */
59      public CatalyticActivity(final double value, final CatalyticActivityUnit unit)
60      {
61          super(value, unit);
62      }
63  
64      /**
65       * Construct CatalyticActivity scalar.
66       * @param value Scalar from which to construct this instance
67       */
68      public CatalyticActivity(final CatalyticActivity value)
69      {
70          super(value);
71      }
72  
73      @Override
74      public final CatalyticActivity instantiateRel(final double value, final CatalyticActivityUnit unit)
75      {
76          return new CatalyticActivity(value, unit);
77      }
78  
79      /**
80       * Construct CatalyticActivity scalar based on an SI value.
81       * @param value the double value in SI units
82       * @return the new scalar with the SI value
83       */
84      public static final CatalyticActivity ofSI(final double value)
85      {
86          return new CatalyticActivity(value, CatalyticActivityUnit.SI);
87      }
88  
89      /**
90       * Interpolate between two values. Note that the first value does not have to be smaller than the second.
91       * @param zero the value at a ratio of zero
92       * @param one the value at a ratio of one
93       * @param ratio the ratio between 0 and 1, inclusive
94       * @return a CatalyticActivity at the given ratio between 0 and 1
95       */
96      public static CatalyticActivity interpolate(final CatalyticActivity zero, final CatalyticActivity one, final double ratio)
97      {
98          Throw.when(ratio < 0.0 || ratio > 1.0, IllegalArgumentException.class,
99                  "ratio for interpolation should be between 0 and 1, but is %f", ratio);
100         return new CatalyticActivity(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
101                 zero.getDisplayUnit());
102     }
103 
104     /**
105      * Return the maximum value of two relative scalars.
106      * @param r1 the first scalar
107      * @param r2 the second scalar
108      * @return the maximum value of two relative scalars
109      */
110     public static CatalyticActivity max(final CatalyticActivity r1, final CatalyticActivity r2)
111     {
112         return r1.gt(r2) ? r1 : r2;
113     }
114 
115     /**
116      * Return the maximum value of more than two relative scalars.
117      * @param r1 the first scalar
118      * @param r2 the second scalar
119      * @param rn the other scalars
120      * @return the maximum value of more than two relative scalars
121      */
122     public static CatalyticActivity max(final CatalyticActivity r1, final CatalyticActivity r2, final CatalyticActivity... rn)
123     {
124         CatalyticActivity maxr = r1.gt(r2) ? r1 : r2;
125         for (CatalyticActivity r : rn)
126         {
127             if (r.gt(maxr))
128             {
129                 maxr = r;
130             }
131         }
132         return maxr;
133     }
134 
135     /**
136      * Return the minimum value of two relative scalars.
137      * @param r1 the first scalar
138      * @param r2 the second scalar
139      * @return the minimum value of two relative scalars
140      */
141     public static CatalyticActivity min(final CatalyticActivity r1, final CatalyticActivity r2)
142     {
143         return r1.lt(r2) ? r1 : r2;
144     }
145 
146     /**
147      * Return the minimum value of more than two relative scalars.
148      * @param r1 the first scalar
149      * @param r2 the second scalar
150      * @param rn the other scalars
151      * @return the minimum value of more than two relative scalars
152      */
153     public static CatalyticActivity min(final CatalyticActivity r1, final CatalyticActivity r2, final CatalyticActivity... rn)
154     {
155         CatalyticActivity minr = r1.lt(r2) ? r1 : r2;
156         for (CatalyticActivity r : rn)
157         {
158             if (r.lt(minr))
159             {
160                 minr = r;
161             }
162         }
163         return minr;
164     }
165 
166     /**
167      * Returns a CatalyticActivity representation of a textual representation of a value with a unit. The String representation
168      * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
169      * are allowed, but not required, between the value and the unit.
170      * @param text the textual representation to parse into a CatalyticActivity
171      * @return the Scalar representation of the value in its unit
172      * @throws IllegalArgumentException when the text cannot be parsed
173      * @throws NullPointerException when the text argument is null
174      */
175     public static CatalyticActivity valueOf(final String text)
176     {
177         Throw.whenNull(text, "Error parsing CatalyticActivity: text to parse is null");
178         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing CatalyticActivity: empty text to parse");
179         try
180         {
181             NumberParser numberParser = new NumberParser().lenient().trailing();
182             double d = numberParser.parseDouble(text);
183             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
184             CatalyticActivityUnit unit = CatalyticActivityUnit.BASE.getUnitByAbbreviation(unitString);
185             Throw.when(unit == null, IllegalArgumentException.class, "Unit %s not found for quantity CatalyticActivity",
186                     unitString);
187             return new CatalyticActivity(d, unit);
188         }
189         catch (Exception exception)
190         {
191             throw new IllegalArgumentException("Error parsing CatalyticActivity from " + text + " using Locale "
192                     + Locale.getDefault(Locale.Category.FORMAT), exception);
193         }
194     }
195 
196     /**
197      * Returns a CatalyticActivity based on a value and the textual representation of the unit, which can be localized.
198      * @param value the value to use
199      * @param unitString the textual representation of the unit
200      * @return the Scalar representation of the value in its unit
201      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
202      * @throws NullPointerException when the unitString argument is null
203      */
204     public static CatalyticActivity of(final double value, final String unitString)
205     {
206         Throw.whenNull(unitString, "Error parsing CatalyticActivity: unitString is null");
207         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
208                 "Error parsing CatalyticActivity: empty unitString");
209         CatalyticActivityUnit unit = CatalyticActivityUnit.BASE.getUnitByAbbreviation(unitString);
210         Throw.when(unit == null, IllegalArgumentException.class, "Error parsing CatalyticActivity with unit %s", unitString);
211         return new CatalyticActivity(value, unit);
212     }
213 
214     /**
215      * Calculate the division of CatalyticActivity and CatalyticActivity, which results in a Dimensionless scalar.
216      * @param v scalar
217      * @return scalar as a division of CatalyticActivity and CatalyticActivity
218      */
219     public final Dimensionless divide(final CatalyticActivity v)
220     {
221         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
222     }
223 
224     /**
225      * Calculate the multiplication of CatalyticActivity and Duration, which results in a AmountOfSubstance scalar.
226      * @param v scalar
227      * @return scalar as a multiplication of CatalyticActivity and Duration
228      */
229     public final AmountOfSubstance times(final Duration v)
230     {
231         return new AmountOfSubstance(this.si * v.si, AmountOfSubstanceUnit.SI);
232     }
233 
234     /**
235      * Calculate the division of CatalyticActivity and AmountOfSubstance, which results in a Frequency scalar.
236      * @param v scalar
237      * @return scalar as a division of CatalyticActivity and AmountOfSubstance
238      */
239     public final Frequency divide(final AmountOfSubstance v)
240     {
241         return new Frequency(this.si / v.si, FrequencyUnit.SI);
242     }
243 
244     /**
245      * Calculate the division of CatalyticActivity and Frequency, which results in a AmountOfSubstance scalar.
246      * @param v scalar
247      * @return scalar as a division of CatalyticActivity and Frequency
248      */
249     public final AmountOfSubstance divide(final Frequency v)
250     {
251         return new AmountOfSubstance(this.si / v.si, AmountOfSubstanceUnit.SI);
252     }
253 
254     @Override
255     public SIScalar reciprocal()
256     {
257         return SIScalar.divide(Dimensionless.ONE, this);
258     }
259 
260     /**
261      * Multiply two scalars that result in a scalar of type CatalyticActivity.
262      * @param scalar1 the first scalar
263      * @param scalar2 the second scalar
264      * @return the multiplication of both scalars as an instance of CatalyticActivity
265      */
266     public static CatalyticActivity multiply(final DoubleScalarRel<?, ?> scalar1, final DoubleScalarRel<?, ?> scalar2)
267     {
268         Throw.whenNull(scalar1, "scalar1 cannot be null");
269         Throw.whenNull(scalar2, "scalar2 cannot be null");
270         Throw.when(
271                 !scalar1.getDisplayUnit().getQuantity().getSiDimensions()
272                         .plus(scalar2.getDisplayUnit().getQuantity().getSiDimensions())
273                         .equals(CatalyticActivityUnit.BASE.getSiDimensions()),
274                 IllegalArgumentException.class, "Multiplying %s by %s does not result in instance of type CatalyticActivity",
275                 scalar1.toDisplayString(), scalar2.toDisplayString());
276         return new CatalyticActivity(scalar1.si * scalar2.si, CatalyticActivityUnit.SI);
277     }
278 
279     /**
280      * Divide two scalars that result in a scalar of type CatalyticActivity.
281      * @param scalar1 the first scalar
282      * @param scalar2 the second scalar
283      * @return the division of scalar1 by scalar2 as an instance of CatalyticActivity
284      */
285     public static CatalyticActivity divide(final DoubleScalarRel<?, ?> scalar1, final DoubleScalarRel<?, ?> scalar2)
286     {
287         Throw.whenNull(scalar1, "scalar1 cannot be null");
288         Throw.whenNull(scalar2, "scalar2 cannot be null");
289         Throw.when(
290                 !scalar1.getDisplayUnit().getQuantity().getSiDimensions()
291                         .minus(scalar2.getDisplayUnit().getQuantity().getSiDimensions())
292                         .equals(CatalyticActivityUnit.BASE.getSiDimensions()),
293                 IllegalArgumentException.class, "Dividing %s by %s does not result in an instance of type CatalyticActivity",
294                 scalar1.toDisplayString(), scalar2.toDisplayString());
295         return new CatalyticActivity(scalar1.si / scalar2.si, CatalyticActivityUnit.SI);
296     }
297 
298 }