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  
13  /**
14   * Easy access methods for the FloatEquivalentDose 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 FloatEquivalentDose extends AbstractFloatScalarRel<EquivalentDoseUnit, FloatEquivalentDose>
24  {
25      /** */
26      private static final long serialVersionUID = 20150901L;
27  
28      /** Constant with value zero. */
29      public static final FloatEquivalentDosetEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose ZERO = new FloatEquivalentDose(0.0f, EquivalentDoseUnit.SI);
30  
31      /** Constant with value one. */
32      public static final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose ONE = new FloatEquivalentDose(1.0f, EquivalentDoseUnit.SI);
33  
34      /** Constant with value NaN. */
35      @SuppressWarnings("checkstyle:constantname")
36      public static final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose NaN = new FloatEquivalentDose(Float.NaN, EquivalentDoseUnit.SI);
37  
38      /** Constant with value POSITIVE_INFINITY. */
39      public static final FloatEquivalentDose POSITIVE_INFINITY =
40              new FloatEquivalentDose(Float.POSITIVE_INFINITY, EquivalentDoseUnit.SI);
41  
42      /** Constant with value NEGATIVE_INFINITY. */
43      public static final FloatEquivalentDose NEGATIVE_INFINITY =
44              new FloatEquivalentDose(Float.NEGATIVE_INFINITY, EquivalentDoseUnit.SI);
45  
46      /** Constant with value MAX_VALUE. */
47      public static final FloatEquivalentDoseentDose.html#FloatEquivalentDose">FloatEquivalentDose POS_MAXVALUE = new FloatEquivalentDose(Float.MAX_VALUE, EquivalentDoseUnit.SI);
48  
49      /** Constant with value -MAX_VALUE. */
50      public static final FloatEquivalentDoseentDose.html#FloatEquivalentDose">FloatEquivalentDose NEG_MAXVALUE = new FloatEquivalentDose(-Float.MAX_VALUE, EquivalentDoseUnit.SI);
51  
52      /**
53       * Construct FloatEquivalentDose scalar.
54       * @param value float; the float value
55       * @param unit unit for the float value
56       */
57      public FloatEquivalentDose(final float value, final EquivalentDoseUnit unit)
58      {
59          super(value, unit);
60      }
61  
62      /**
63       * Construct FloatEquivalentDose scalar.
64       * @param value Scalar from which to construct this instance
65       */
66      public FloatEquivalentDose/FloatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose(final FloatEquivalentDose value)
67      {
68          super(value);
69      }
70  
71      /**
72       * Construct FloatEquivalentDose scalar using a double value.
73       * @param value double; the double value
74       * @param unit unit for the resulting float value
75       */
76      public FloatEquivalentDose(final double value, final EquivalentDoseUnit unit)
77      {
78          super((float) value, unit);
79      }
80  
81      /** {@inheritDoc} */
82      @Override
83      public final FloatEquivalentDose instantiateRel(final float value, final EquivalentDoseUnit unit)
84      {
85          return new FloatEquivalentDose(value, unit);
86      }
87  
88      /**
89       * Construct FloatEquivalentDose 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 FloatEquivalentDose instantiateSI(final float value)
94      {
95          return new FloatEquivalentDose(value, EquivalentDoseUnit.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 FloatEquivalentDoseEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoselentDose.html#FloatEquivalentDose">FloatEquivalentDose interpolate(final FloatEquivalentDoseEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose zero, final FloatEquivalentDose one,
106             final float ratio)
107     {
108         return new FloatEquivalentDose(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 FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose max(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose 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 FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose max(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2,
131             final FloatEquivalentDose... rn)
132     {
133         FloatEquivalentDose maxr = (r1.gt(r2)) ? r1 : r2;
134         for (FloatEquivalentDose 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 FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose min(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose 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 FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose min(final FloatEquivalentDoseatEquivalentDose.html#FloatEquivalentDose">FloatEquivalentDose r1, final FloatEquivalentDose r2,
163             final FloatEquivalentDose... rn)
164     {
165         FloatEquivalentDose minr = (r1.lt(r2)) ? r1 : r2;
166         for (FloatEquivalentDose r : rn)
167         {
168             if (r.lt(minr))
169             {
170                 minr = r;
171             }
172         }
173         return minr;
174     }
175 
176     /**
177      * Returns a FloatEquivalentDose representation of a textual representation of a value with a unit. The String
178      * representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit.
179      * Spaces are allowed, but not required, between the value and the unit.
180      * @param text String; the textual representation to parse into a FloatEquivalentDose
181      * @return FloatEquivalentDose; 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 FloatEquivalentDose valueOf(final String text)
186     {
187         Throw.whenNull(text, "Error parsing FloatEquivalentDose: text to parse is null");
188         Throw.when(text.length() == 0, IllegalArgumentException.class,
189                 "Error parsing FloatEquivalentDose: empty text to parse");
190         Matcher matcher = ValueUtil.NUMBER_PATTERN.matcher(text);
191         if (matcher.find())
192         {
193             int index = matcher.end();
194             String unitString = text.substring(index).trim();
195             String valueString = text.substring(0, index).trim();
196             EquivalentDoseUnit unit = EquivalentDoseUnit.BASE.getUnitByAbbreviation(unitString);
197             if (unit != null)
198             {
199                 float f = Float.parseFloat(valueString);
200                 return new FloatEquivalentDose(f, unit);
201             }
202         }
203         throw new IllegalArgumentException("Error parsing FloatEquivalentDose from " + text);
204     }
205 
206     /**
207      * Returns a FloatEquivalentDose based on a value and the textual representation of the unit.
208      * @param value double; the value to use
209      * @param unitString String; the textual representation of the unit
210      * @return FloatEquivalentDose; the Scalar representation of the value in its unit
211      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
212      * @throws NullPointerException when the unitString argument is null
213      */
214     public static FloatEquivalentDose of(final float value, final String unitString)
215     {
216         Throw.whenNull(unitString, "Error parsing FloatEquivalentDose: unitString is null");
217         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
218                 "Error parsing FloatEquivalentDose: empty unitString");
219         EquivalentDoseUnit unit = EquivalentDoseUnit.BASE.getUnitByAbbreviation(unitString);
220         if (unit != null)
221         {
222             return new FloatEquivalentDose(value, unit);
223         }
224         throw new IllegalArgumentException("Error parsing FloatEquivalentDose with unit " + unitString);
225     }
226 
227     /**
228      * Calculate the division of FloatEquivalentDose and FloatEquivalentDose, which results in a FloatDimensionless scalar.
229      * @param v FloatEquivalentDose scalar
230      * @return FloatDimensionless scalar as a division of FloatEquivalentDose and FloatEquivalentDose
231      */
232     public final FloatDimensionless divide(final FloatEquivalentDose v)
233     {
234         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
235     }
236 
237 }