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.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 CatalyticActivity 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 CatalyticActivity extends DoubleScalarRel<CatalyticActivityUnit, CatalyticActivity>
27  {
28      /** */
29      private static final long serialVersionUID = 20150905L;
30  
31      /** Constant with value zero. */
32      public static final CatalyticActivity ZERO = new CatalyticActivity(0.0, CatalyticActivityUnit.SI);
33  
34      /** Constant with value one. */
35      public static final CatalyticActivity ONE = new CatalyticActivity(1.0, CatalyticActivityUnit.SI);
36  
37      /** Constant with value NaN. */
38      @SuppressWarnings("checkstyle:constantname")
39      public static final CatalyticActivity NaN = new CatalyticActivity(Double.NaN, CatalyticActivityUnit.SI);
40  
41      /** Constant with value POSITIVE_INFINITY. */
42      public static final CatalyticActivity POSITIVE_INFINITY =
43              new CatalyticActivity(Double.POSITIVE_INFINITY, CatalyticActivityUnit.SI);
44  
45      /** Constant with value NEGATIVE_INFINITY. */
46      public static final CatalyticActivity NEGATIVE_INFINITY =
47              new CatalyticActivity(Double.NEGATIVE_INFINITY, CatalyticActivityUnit.SI);
48  
49      /** Constant with value MAX_VALUE. */
50      public static final CatalyticActivity POS_MAXVALUE = new CatalyticActivity(Double.MAX_VALUE, CatalyticActivityUnit.SI);
51  
52      /** Constant with value -MAX_VALUE. */
53      public static final CatalyticActivity NEG_MAXVALUE = new CatalyticActivity(-Double.MAX_VALUE, CatalyticActivityUnit.SI);
54  
55      /**
56       * Construct CatalyticActivity scalar.
57       * @param value double; the double value
58       * @param unit CatalyticActivityUnit; unit for the double value
59       */
60      public CatalyticActivity(final double value, final CatalyticActivityUnit unit)
61      {
62          super(value, unit);
63      }
64  
65      /**
66       * Construct CatalyticActivity scalar.
67       * @param value CatalyticActivity; Scalar from which to construct this instance
68       */
69      public CatalyticActivity(final CatalyticActivity value)
70      {
71          super(value);
72      }
73  
74      /** {@inheritDoc} */
75      @Override
76      public final CatalyticActivity instantiateRel(final double value, final CatalyticActivityUnit unit)
77      {
78          return new CatalyticActivity(value, unit);
79      }
80  
81      /**
82       * Construct CatalyticActivity scalar.
83       * @param value double; the double value in SI units
84       * @return CatalyticActivity; the new scalar with the SI value
85       */
86      public static final CatalyticActivity instantiateSI(final double value)
87      {
88          return new CatalyticActivity(value, CatalyticActivityUnit.SI);
89      }
90  
91      /**
92       * Interpolate between two values.
93       * @param zero CatalyticActivity; the low value
94       * @param one CatalyticActivity; the high value
95       * @param ratio double; the ratio between 0 and 1, inclusive
96       * @return CatalyticActivity; a Scalar at the ratio between
97       */
98      public static CatalyticActivity interpolate(final CatalyticActivity zero, final CatalyticActivity one, final double ratio)
99      {
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 CatalyticActivity; the first scalar
107      * @param r2 CatalyticActivity; the second scalar
108      * @return CatalyticActivity; 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 CatalyticActivity; the first scalar
118      * @param r2 CatalyticActivity; the second scalar
119      * @param rn CatalyticActivity...; the other scalars
120      * @return CatalyticActivity; 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 CatalyticActivity; the first scalar
138      * @param r2 CatalyticActivity; the second scalar
139      * @return CatalyticActivity; 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 CatalyticActivity; the first scalar
149      * @param r2 CatalyticActivity; the second scalar
150      * @param rn CatalyticActivity...; the other scalars
151      * @return CatalyticActivity; 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 String; the textual representation to parse into a CatalyticActivity
171      * @return CatalyticActivity; 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             if (unit == null)
186                 throw new IllegalArgumentException("Unit " + unitString + " not found");
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 double; the value to use
199      * @param unitString String; the textual representation of the unit
200      * @return CatalyticActivity; 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         if (unit != null)
211         {
212             return new CatalyticActivity(value, unit);
213         }
214         throw new IllegalArgumentException("Error parsing CatalyticActivity with unit " + unitString);
215     }
216 
217     /**
218      * Calculate the division of CatalyticActivity and CatalyticActivity, which results in a Dimensionless scalar.
219      * @param v CatalyticActivity; scalar
220      * @return Dimensionless; scalar as a division of CatalyticActivity and CatalyticActivity
221      */
222     public final Dimensionless divide(final CatalyticActivity v)
223     {
224         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
225     }
226 
227     /**
228      * Calculate the multiplication of CatalyticActivity and Duration, which results in a AmountOfSubstance scalar.
229      * @param v CatalyticActivity; scalar
230      * @return AmountOfSubstance; scalar as a multiplication of CatalyticActivity and Duration
231      */
232     public final AmountOfSubstance times(final Duration v)
233     {
234         return new AmountOfSubstance(this.si * v.si, AmountOfSubstanceUnit.SI);
235     }
236 
237     /**
238      * Calculate the division of CatalyticActivity and AmountOfSubstance, which results in a Frequency scalar.
239      * @param v CatalyticActivity; scalar
240      * @return Frequency; scalar as a division of CatalyticActivity and AmountOfSubstance
241      */
242     public final Frequency divide(final AmountOfSubstance v)
243     {
244         return new Frequency(this.si / v.si, FrequencyUnit.SI);
245     }
246 
247     /**
248      * Calculate the division of CatalyticActivity and Frequency, which results in a AmountOfSubstance scalar.
249      * @param v CatalyticActivity; scalar
250      * @return AmountOfSubstance; scalar as a division of CatalyticActivity and Frequency
251      */
252     public final AmountOfSubstance divide(final Frequency v)
253     {
254         return new AmountOfSubstance(this.si / v.si, AmountOfSubstanceUnit.SI);
255     }
256 
257     /** {@inheritDoc} */
258     @Override
259     public SIScalar reciprocal()
260     {
261         return DoubleScalar.divide(Dimensionless.ONE, this);
262     }
263 
264 }