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