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.EquivalentDoseUnit;
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 FloatEquivalentDose 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 FloatEquivalentDose extends AbstractFloatScalarRel<EquivalentDoseUnit, FloatEquivalentDose>
25  {
26      /** */
27      private static final long serialVersionUID = 20150901L;
28  
29      /** Constant with value zero. */
30      public static final FloatEquivalentDosetEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose ZERO = new FloatEquivalentDose(0.0f, EquivalentDoseUnit.SI);
31  
32      /** Constant with value one. */
33      public static final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose ONE = new FloatEquivalentDose(1.0f, EquivalentDoseUnit.SI);
34  
35      /** Constant with value NaN. */
36      @SuppressWarnings("checkstyle:constantname")
37      public static final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose NaN = new FloatEquivalentDose(Float.NaN, EquivalentDoseUnit.SI);
38  
39      /** Constant with value POSITIVE_INFINITY. */
40      public static final FloatEquivalentDose POSITIVE_INFINITY =
41              new FloatEquivalentDose(Float.POSITIVE_INFINITY, EquivalentDoseUnit.SI);
42  
43      /** Constant with value NEGATIVE_INFINITY. */
44      public static final FloatEquivalentDose NEGATIVE_INFINITY =
45              new FloatEquivalentDose(Float.NEGATIVE_INFINITY, EquivalentDoseUnit.SI);
46  
47      /** Constant with value MAX_VALUE. */
48      public static final FloatEquivalentDoseentDose.html#FloatEquivalentDose">FloatEquivalentDose POS_MAXVALUE = new FloatEquivalentDose(Float.MAX_VALUE, EquivalentDoseUnit.SI);
49  
50      /** Constant with value -MAX_VALUE. */
51      public static final FloatEquivalentDoseentDose.html#FloatEquivalentDose">FloatEquivalentDose NEG_MAXVALUE = new FloatEquivalentDose(-Float.MAX_VALUE, EquivalentDoseUnit.SI);
52  
53      /**
54       * Construct FloatEquivalentDose scalar.
55       * @param value float; the float value
56       * @param unit unit for the float value
57       */
58      public FloatEquivalentDose(final float value, final EquivalentDoseUnit unit)
59      {
60          super(value, unit);
61      }
62  
63      /**
64       * Construct FloatEquivalentDose scalar.
65       * @param value Scalar from which to construct this instance
66       */
67      public FloatEquivalentDose/FloatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose(final FloatEquivalentDose value)
68      {
69          super(value);
70      }
71  
72      /**
73       * Construct FloatEquivalentDose scalar using a double value.
74       * @param value double; the double value
75       * @param unit unit for the resulting float value
76       */
77      public FloatEquivalentDose(final double value, final EquivalentDoseUnit unit)
78      {
79          super((float) value, unit);
80      }
81  
82      /** {@inheritDoc} */
83      @Override
84      public final FloatEquivalentDose instantiateRel(final float value, final EquivalentDoseUnit unit)
85      {
86          return new FloatEquivalentDose(value, unit);
87      }
88  
89      /**
90       * Construct FloatEquivalentDose 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 FloatEquivalentDose instantiateSI(final float value)
95      {
96          return new FloatEquivalentDose(value, EquivalentDoseUnit.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 FloatEquivalentDoseEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoselentDose.html#FloatEquivalentDose">FloatEquivalentDose interpolate(final FloatEquivalentDoseEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose zero, final FloatEquivalentDose one,
107             final float ratio)
108     {
109         return new FloatEquivalentDose(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
110                 zero.getDisplayUnit());
111     }
112 
113     /**
114      * Return the maximum value of two relative scalars.
115      * @param r1 the first scalar
116      * @param r2 the second scalar
117      * @return the maximum value of two relative scalars
118      */
119     public static FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose max(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2)
120     {
121         return r1.gt(r2) ? r1 : r2;
122     }
123 
124     /**
125      * Return the maximum value of more than two relative scalars.
126      * @param r1 the first scalar
127      * @param r2 the second scalar
128      * @param rn the other scalars
129      * @return the maximum value of more than two relative scalars
130      */
131     public static FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose max(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2,
132             final FloatEquivalentDose... rn)
133     {
134         FloatEquivalentDose maxr = r1.gt(r2) ? r1 : r2;
135         for (FloatEquivalentDose r : rn)
136         {
137             if (r.gt(maxr))
138             {
139                 maxr = r;
140             }
141         }
142         return maxr;
143     }
144 
145     /**
146      * Return the minimum value of two relative scalars.
147      * @param r1 the first scalar
148      * @param r2 the second scalar
149      * @return the minimum value of two relative scalars
150      */
151     public static FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose min(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2)
152     {
153         return r1.lt(r2) ? r1 : r2;
154     }
155 
156     /**
157      * Return the minimum value of more than two relative scalars.
158      * @param r1 the first scalar
159      * @param r2 the second scalar
160      * @param rn the other scalars
161      * @return the minimum value of more than two relative scalars
162      */
163     public static FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose min(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2,
164             final FloatEquivalentDose... rn)
165     {
166         FloatEquivalentDose minr = r1.lt(r2) ? r1 : r2;
167         for (FloatEquivalentDose r : rn)
168         {
169             if (r.lt(minr))
170             {
171                 minr = r;
172             }
173         }
174         return minr;
175     }
176 
177     /**
178      * Returns a FloatEquivalentDose representation of a textual representation of a value with a unit. The String
179      * representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit.
180      * Spaces are allowed, but not required, between the value and the unit.
181      * @param text String; the textual representation to parse into a FloatEquivalentDose
182      * @return FloatEquivalentDose; the Scalar representation of the value in its unit
183      * @throws IllegalArgumentException when the text cannot be parsed
184      * @throws NullPointerException when the text argument is null
185      */
186     public static FloatEquivalentDose valueOf(final String text)
187     {
188         Throw.whenNull(text, "Error parsing FloatEquivalentDose: text to parse is null");
189         Throw.when(text.length() == 0, IllegalArgumentException.class,
190                 "Error parsing FloatEquivalentDose: empty text to parse");
191         Matcher matcher = ValueUtil.NUMBER_PATTERN.matcher(text);
192         if (matcher.find())
193         {
194             int index = matcher.end();
195             String unitString = text.substring(index).trim();
196             String valueString = text.substring(0, index).trim();
197             EquivalentDoseUnit unit = EquivalentDoseUnit.BASE.getUnitByAbbreviation(unitString);
198             if (unit != null)
199             {
200                 float f = Float.parseFloat(valueString);
201                 return new FloatEquivalentDose(f, unit);
202             }
203         }
204         throw new IllegalArgumentException("Error parsing FloatEquivalentDose from " + text);
205     }
206 
207     /**
208      * Returns a FloatEquivalentDose based on a value and the textual representation of the unit.
209      * @param value double; the value to use
210      * @param unitString String; the textual representation of the unit
211      * @return FloatEquivalentDose; the Scalar representation of the value in its unit
212      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
213      * @throws NullPointerException when the unitString argument is null
214      */
215     public static FloatEquivalentDose of(final float value, final String unitString)
216     {
217         Throw.whenNull(unitString, "Error parsing FloatEquivalentDose: unitString is null");
218         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
219                 "Error parsing FloatEquivalentDose: empty unitString");
220         EquivalentDoseUnit unit = EquivalentDoseUnit.BASE.getUnitByAbbreviation(unitString);
221         if (unit != null)
222         {
223             return new FloatEquivalentDose(value, unit);
224         }
225         throw new IllegalArgumentException("Error parsing FloatEquivalentDose with unit " + unitString);
226     }
227 
228     /**
229      * Calculate the division of FloatEquivalentDose and FloatEquivalentDose, which results in a FloatDimensionless scalar.
230      * @param v FloatEquivalentDose; scalar
231      * @return FloatDimensionless; scalar as a division of FloatEquivalentDose and FloatEquivalentDose
232      */
233     public final FloatDimensionless divide(final FloatEquivalentDose v)
234     {
235         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
236     }
237 
238     /** {@inheritDoc} */
239     @Override
240     public FloatSIScalar reciprocal()
241     {
242         return FloatScalar.divide(FloatDimensionless.ONE, this);
243     }
244 
245 }