View Javadoc
1   package org.djunits.value.vfloat.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.DimensionlessUnit;
9   import org.djunits.unit.RadioActivityUnit;
10  import org.djunits.value.util.ValueUtil;
11  import org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel;
12  import org.djunits.value.vfloat.scalar.base.FloatScalar;
13  
14  /**
15   * Easy access methods for the FloatRadioActivity FloatScalar, which is relative by definition.
16   * <p>
17   * Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
18   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
19   * </p>
20   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
21   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
22   */
23  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2022-03-14T11:14:15.180987200Z")
24  public class FloatRadioActivity extends AbstractFloatScalarRel<RadioActivityUnit, FloatRadioActivity>
25  {
26      /** */
27      private static final long serialVersionUID = 20150901L;
28  
29      /** Constant with value zero. */
30      public static final FloatRadioActivityatRadioActivity.html#FloatRadioActivity">FloatRadioActivity ZERO = new FloatRadioActivity(0.0f, RadioActivityUnit.SI);
31  
32      /** Constant with value one. */
33      public static final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity ONE = new FloatRadioActivity(1.0f, RadioActivityUnit.SI);
34  
35      /** Constant with value NaN. */
36      @SuppressWarnings("checkstyle:constantname")
37      public static final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity NaN = new FloatRadioActivity(Float.NaN, RadioActivityUnit.SI);
38  
39      /** Constant with value POSITIVE_INFINITY. */
40      public static final FloatRadioActivity POSITIVE_INFINITY =
41              new FloatRadioActivity(Float.POSITIVE_INFINITY, RadioActivityUnit.SI);
42  
43      /** Constant with value NEGATIVE_INFINITY. */
44      public static final FloatRadioActivity NEGATIVE_INFINITY =
45              new FloatRadioActivity(Float.NEGATIVE_INFINITY, RadioActivityUnit.SI);
46  
47      /** Constant with value MAX_VALUE. */
48      public static final FloatRadioActivityctivity.html#FloatRadioActivity">FloatRadioActivity POS_MAXVALUE = new FloatRadioActivity(Float.MAX_VALUE, RadioActivityUnit.SI);
49  
50      /** Constant with value -MAX_VALUE. */
51      public static final FloatRadioActivityctivity.html#FloatRadioActivity">FloatRadioActivity NEG_MAXVALUE = new FloatRadioActivity(-Float.MAX_VALUE, RadioActivityUnit.SI);
52  
53      /**
54       * Construct FloatRadioActivity scalar.
55       * @param value float; the float value
56       * @param unit unit for the float value
57       */
58      public FloatRadioActivity(final float value, final RadioActivityUnit unit)
59      {
60          super(value, unit);
61      }
62  
63      /**
64       * Construct FloatRadioActivity scalar.
65       * @param value Scalar from which to construct this instance
66       */
67      public FloatRadioActivityr/FloatRadioActivity.html#FloatRadioActivity">FloatRadioActivity(final FloatRadioActivity value)
68      {
69          super(value);
70      }
71  
72      /**
73       * Construct FloatRadioActivity scalar using a double value.
74       * @param value double; the double value
75       * @param unit unit for the resulting float value
76       */
77      public FloatRadioActivity(final double value, final RadioActivityUnit unit)
78      {
79          super((float) value, unit);
80      }
81  
82      /** {@inheritDoc} */
83      @Override
84      public final FloatRadioActivity instantiateRel(final float value, final RadioActivityUnit unit)
85      {
86          return new FloatRadioActivity(value, unit);
87      }
88  
89      /**
90       * Construct FloatRadioActivity scalar.
91       * @param value float; the float value in SI units
92       * @return the new scalar with the SI value
93       */
94      public static final FloatRadioActivity instantiateSI(final float value)
95      {
96          return new FloatRadioActivity(value, RadioActivityUnit.SI);
97      }
98  
99      /**
100      * Interpolate between two values.
101      * @param zero the low value
102      * @param one the high value
103      * @param ratio double; the ratio between 0 and 1, inclusive
104      * @return a Scalar at the ratio between
105      */
106     public static FloatRadioActivitytRadioActivity.html#FloatRadioActivity">FloatRadioActivityActivity.html#FloatRadioActivity">FloatRadioActivity interpolate(final FloatRadioActivitytRadioActivity.html#FloatRadioActivity">FloatRadioActivity zero, final FloatRadioActivity one, final float ratio)
107     {
108         return new FloatRadioActivity(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
109                 zero.getDisplayUnit());
110     }
111 
112     /**
113      * Return the maximum value of two relative scalars.
114      * @param r1 the first scalar
115      * @param r2 the second scalar
116      * @return the maximum value of two relative scalars
117      */
118     public static FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity max(final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity r1, final FloatRadioActivity r2)
119     {
120         return r1.gt(r2) ? r1 : r2;
121     }
122 
123     /**
124      * Return the maximum value of more than two relative scalars.
125      * @param r1 the first scalar
126      * @param r2 the second scalar
127      * @param rn the other scalars
128      * @return the maximum value of more than two relative scalars
129      */
130     public static FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity max(final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity r1, final FloatRadioActivity r2,
131             final FloatRadioActivity... rn)
132     {
133         FloatRadioActivity maxr = r1.gt(r2) ? r1 : r2;
134         for (FloatRadioActivity r : rn)
135         {
136             if (r.gt(maxr))
137             {
138                 maxr = r;
139             }
140         }
141         return maxr;
142     }
143 
144     /**
145      * Return the minimum value of two relative scalars.
146      * @param r1 the first scalar
147      * @param r2 the second scalar
148      * @return the minimum value of two relative scalars
149      */
150     public static FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity min(final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity r1, final FloatRadioActivity r2)
151     {
152         return r1.lt(r2) ? r1 : r2;
153     }
154 
155     /**
156      * Return the minimum value of more than two relative scalars.
157      * @param r1 the first scalar
158      * @param r2 the second scalar
159      * @param rn the other scalars
160      * @return the minimum value of more than two relative scalars
161      */
162     public static FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity min(final FloatRadioActivityoatRadioActivity.html#FloatRadioActivity">FloatRadioActivity r1, final FloatRadioActivity r2,
163             final FloatRadioActivity... rn)
164     {
165         FloatRadioActivity minr = r1.lt(r2) ? r1 : r2;
166         for (FloatRadioActivity r : rn)
167         {
168             if (r.lt(minr))
169             {
170                 minr = r;
171             }
172         }
173         return minr;
174     }
175 
176     /**
177      * Returns a FloatRadioActivity representation of a textual representation of a value with a unit. The String representation
178      * that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are
179      * allowed, but not required, between the value and the unit.
180      * @param text String; the textual representation to parse into a FloatRadioActivity
181      * @return FloatRadioActivity; the Scalar representation of the value in its unit
182      * @throws IllegalArgumentException when the text cannot be parsed
183      * @throws NullPointerException when the text argument is null
184      */
185     public static FloatRadioActivity valueOf(final String text)
186     {
187         Throw.whenNull(text, "Error parsing FloatRadioActivity: text to parse is null");
188         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatRadioActivity: empty text to parse");
189         Matcher matcher = ValueUtil.NUMBER_PATTERN.matcher(text);
190         if (matcher.find())
191         {
192             int index = matcher.end();
193             String unitString = text.substring(index).trim();
194             String valueString = text.substring(0, index).trim();
195             RadioActivityUnit unit = RadioActivityUnit.BASE.getUnitByAbbreviation(unitString);
196             if (unit != null)
197             {
198                 float f = Float.parseFloat(valueString);
199                 return new FloatRadioActivity(f, unit);
200             }
201         }
202         throw new IllegalArgumentException("Error parsing FloatRadioActivity from " + text);
203     }
204 
205     /**
206      * Returns a FloatRadioActivity based on a value and the textual representation of the unit.
207      * @param value double; the value to use
208      * @param unitString String; the textual representation of the unit
209      * @return FloatRadioActivity; the Scalar representation of the value in its unit
210      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
211      * @throws NullPointerException when the unitString argument is null
212      */
213     public static FloatRadioActivity of(final float value, final String unitString)
214     {
215         Throw.whenNull(unitString, "Error parsing FloatRadioActivity: unitString is null");
216         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
217                 "Error parsing FloatRadioActivity: empty unitString");
218         RadioActivityUnit unit = RadioActivityUnit.BASE.getUnitByAbbreviation(unitString);
219         if (unit != null)
220         {
221             return new FloatRadioActivity(value, unit);
222         }
223         throw new IllegalArgumentException("Error parsing FloatRadioActivity with unit " + unitString);
224     }
225 
226     /**
227      * Calculate the division of FloatRadioActivity and FloatRadioActivity, which results in a FloatDimensionless scalar.
228      * @param v FloatRadioActivity; scalar
229      * @return FloatDimensionless; scalar as a division of FloatRadioActivity and FloatRadioActivity
230      */
231     public final FloatDimensionless divide(final FloatRadioActivity v)
232     {
233         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
234     }
235 
236     /** {@inheritDoc} */
237     @Override
238     public FloatSIScalar reciprocal()
239     {
240         return FloatScalar.divide(FloatDimensionless.ONE, this);
241     }
242 
243 }