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