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.AmountOfSubstanceUnit;
9   import org.djunits.unit.CatalyticActivityUnit;
10  import org.djunits.unit.DimensionlessUnit;
11  import org.djunits.unit.FrequencyUnit;
12  import org.djunits.value.util.ValueUtil;
13  import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
14  import org.djunits.value.vdouble.scalar.base.DoubleScalar;
15  
16  /**
17   * Easy access methods for the CatalyticActivity DoubleScalar, which is relative by definition.
18   * <p>
19   * Copyright (c) 2013-2022 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 = "2022-03-14T11:14:15.180987200Z")
26  public class CatalyticActivity extends AbstractDoubleScalarRel<CatalyticActivityUnit, CatalyticActivity>
27  {
28      /** */
29      private static final long serialVersionUID = 20150905L;
30  
31      /** Constant with value zero. */
32      public static final CatalyticActivityatalyticActivity.html#CatalyticActivity">CatalyticActivity ZERO = new CatalyticActivity(0.0, CatalyticActivityUnit.SI);
33  
34      /** Constant with value one. */
35      public static final CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivity ONE = new CatalyticActivity(1.0, CatalyticActivityUnit.SI);
36  
37      /** Constant with value NaN. */
38      @SuppressWarnings("checkstyle:constantname")
39      public static final CatalyticActivityCatalyticActivity.html#CatalyticActivity">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 CatalyticActivityActivity.html#CatalyticActivity">CatalyticActivity POS_MAXVALUE = new CatalyticActivity(Double.MAX_VALUE, CatalyticActivityUnit.SI);
51  
52      /** Constant with value -MAX_VALUE. */
53      public static final CatalyticActivityActivity.html#CatalyticActivity">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 CatalyticActivitylar/CatalyticActivity.html#CatalyticActivity">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 CatalyticActivitytalyticActivity.html#CatalyticActivity">CatalyticActivitycActivity.html#CatalyticActivity">CatalyticActivity interpolate(final CatalyticActivitytalyticActivity.html#CatalyticActivity">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 CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivity max(final CatalyticActivityCatalyticActivity.html#CatalyticActivity">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 CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivity max(final CatalyticActivityCatalyticActivity.html#CatalyticActivity">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 CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivity min(final CatalyticActivityCatalyticActivity.html#CatalyticActivity">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 CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivityCatalyticActivity.html#CatalyticActivity">CatalyticActivity min(final CatalyticActivityCatalyticActivity.html#CatalyticActivity">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 the official abbreviation of the unit. Spaces are
169      * 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         Matcher matcher = ValueUtil.NUMBER_PATTERN.matcher(text);
180         if (matcher.find())
181         {
182             int index = matcher.end();
183             String unitString = text.substring(index).trim();
184             String valueString = text.substring(0, index).trim();
185             CatalyticActivityUnit unit = CatalyticActivityUnit.BASE.getUnitByAbbreviation(unitString);
186             if (unit != null)
187             {
188                 double d = Double.parseDouble(valueString);
189                 return new CatalyticActivity(d, unit);
190             }
191         }
192         throw new IllegalArgumentException("Error parsing CatalyticActivity from " + text);
193     }
194 
195     /**
196      * Returns a CatalyticActivity based on a value and the textual representation of the unit.
197      * @param value double; the value to use
198      * @param unitString String; the textual representation of the unit
199      * @return CatalyticActivity; 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 CatalyticActivity of(final double value, final String unitString)
204     {
205         Throw.whenNull(unitString, "Error parsing CatalyticActivity: unitString is null");
206         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
207                 "Error parsing CatalyticActivity: empty unitString");
208         CatalyticActivityUnit unit = CatalyticActivityUnit.BASE.getUnitByAbbreviation(unitString);
209         if (unit != null)
210         {
211             return new CatalyticActivity(value, unit);
212         }
213         throw new IllegalArgumentException("Error parsing CatalyticActivity with unit " + unitString);
214     }
215 
216     /**
217      * Calculate the division of CatalyticActivity and CatalyticActivity, which results in a Dimensionless scalar.
218      * @param v CatalyticActivity; scalar
219      * @return Dimensionless; scalar as a division of CatalyticActivity and CatalyticActivity
220      */
221     public final Dimensionless divide(final CatalyticActivity v)
222     {
223         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
224     }
225 
226     /**
227      * Calculate the multiplication of CatalyticActivity and Duration, which results in a AmountOfSubstance scalar.
228      * @param v CatalyticActivity; scalar
229      * @return AmountOfSubstance; scalar as a multiplication of CatalyticActivity and Duration
230      */
231     public final AmountOfSubstance times(final Duration v)
232     {
233         return new AmountOfSubstance(this.si * v.si, AmountOfSubstanceUnit.SI);
234     }
235 
236     /**
237      * Calculate the division of CatalyticActivity and AmountOfSubstance, which results in a Frequency scalar.
238      * @param v CatalyticActivity; scalar
239      * @return Frequency; scalar as a division of CatalyticActivity and AmountOfSubstance
240      */
241     public final Frequency divide(final AmountOfSubstance v)
242     {
243         return new Frequency(this.si / v.si, FrequencyUnit.SI);
244     }
245 
246     /**
247      * Calculate the division of CatalyticActivity and Frequency, which results in a AmountOfSubstance scalar.
248      * @param v CatalyticActivity; scalar
249      * @return AmountOfSubstance; scalar as a division of CatalyticActivity and Frequency
250      */
251     public final AmountOfSubstance divide(final Frequency v)
252     {
253         return new AmountOfSubstance(this.si / v.si, AmountOfSubstanceUnit.SI);
254     }
255 
256     /** {@inheritDoc} */
257     @Override
258     public SIScalar reciprocal()
259     {
260         return DoubleScalar.divide(Dimensionless.ONE, this);
261     }
262 
263 }