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.ElectricalCurrentUnit;
10  import org.djunits.unit.ElectricalPotentialUnit;
11  import org.djunits.unit.EnergyUnit;
12  import org.djunits.unit.ForceUnit;
13  import org.djunits.unit.FrequencyUnit;
14  import org.djunits.unit.PowerUnit;
15  import org.djunits.unit.SpeedUnit;
16  import org.djunits.value.util.ValueUtil;
17  import org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel;
18  
19  /**
20   * Easy access methods for the FloatPower FloatScalar, which is relative by definition.
21   * <p>
22   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
23   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
24   * </p>
25   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
26   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
27   */
28  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2019-10-18T12:12:25.568Z")
29  public class FloatPower extends AbstractFloatScalarRel<PowerUnit, FloatPower>
30  {
31      /** */
32      private static final long serialVersionUID = 20150901L;
33  
34      /** Constant with value zero. */
35      public static final FloatPoweralar/FloatPower.html#FloatPower">FloatPower ZERO = new FloatPower(0.0f, PowerUnit.SI);
36  
37      /** Constant with value one. */
38      public static final FloatPowercalar/FloatPower.html#FloatPower">FloatPower ONE = new FloatPower(1.0f, PowerUnit.SI);
39  
40      /** Constant with value NaN. */
41      @SuppressWarnings("checkstyle:constantname")
42      public static final FloatPowercalar/FloatPower.html#FloatPower">FloatPower NaN = new FloatPower(Float.NaN, PowerUnit.SI);
43  
44      /** Constant with value POSITIVE_INFINITY. */
45      public static final FloatPowerer.html#FloatPower">FloatPower POSITIVE_INFINITY = new FloatPower(Float.POSITIVE_INFINITY, PowerUnit.SI);
46  
47      /** Constant with value NEGATIVE_INFINITY. */
48      public static final FloatPowerer.html#FloatPower">FloatPower NEGATIVE_INFINITY = new FloatPower(Float.NEGATIVE_INFINITY, PowerUnit.SI);
49  
50      /** Constant with value MAX_VALUE. */
51      public static final FloatPoweratPower.html#FloatPower">FloatPower POS_MAXVALUE = new FloatPower(Float.MAX_VALUE, PowerUnit.SI);
52  
53      /** Constant with value -MAX_VALUE. */
54      public static final FloatPoweratPower.html#FloatPower">FloatPower NEG_MAXVALUE = new FloatPower(-Float.MAX_VALUE, PowerUnit.SI);
55  
56      /**
57       * Construct FloatPower scalar.
58       * @param value float; the float value
59       * @param unit unit for the float value
60       */
61      public FloatPower(final float value, final PowerUnit unit)
62      {
63          super(value, unit);
64      }
65  
66      /**
67       * Construct FloatPower scalar.
68       * @param value Scalar from which to construct this instance
69       */
70      public FloatPowerat/scalar/FloatPower.html#FloatPower">FloatPower(final FloatPower value)
71      {
72          super(value);
73      }
74  
75      /**
76       * Construct FloatPower scalar using a double value.
77       * @param value double; the double value
78       * @param unit unit for the resulting float value
79       */
80      public FloatPower(final double value, final PowerUnit unit)
81      {
82          super((float) value, unit);
83      }
84  
85      /** {@inheritDoc} */
86      @Override
87      public final FloatPower instantiateRel(final float value, final PowerUnit unit)
88      {
89          return new FloatPower(value, unit);
90      }
91  
92      /**
93       * Construct FloatPower scalar.
94       * @param value float; the float value in SI units
95       * @return the new scalar with the SI value
96       */
97      public static final FloatPower instantiateSI(final float value)
98      {
99          return new FloatPower(value, PowerUnit.SI);
100     }
101 
102     /**
103      * Interpolate between two values.
104      * @param zero the low value
105      * @param one the high value
106      * @param ratio double; the ratio between 0 and 1, inclusive
107      * @return a Scalar at the ratio between
108      */
109     public static FloatPowerlar/FloatPower.html#FloatPower">FloatPoweroatPower.html#FloatPower">FloatPower interpolate(final FloatPowerlar/FloatPower.html#FloatPower">FloatPower zero, final FloatPower one, final float ratio)
110     {
111         return new FloatPower(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
112                 zero.getDisplayUnit());
113     }
114 
115     /**
116      * Return the maximum value of two relative scalars.
117      * @param r1 the first scalar
118      * @param r2 the second scalar
119      * @return the maximum value of two relative scalars
120      */
121     public static FloatPowercalar/FloatPower.html#FloatPower">FloatPowercalar/FloatPower.html#FloatPower">FloatPower max(final FloatPowercalar/FloatPower.html#FloatPower">FloatPower r1, final FloatPower r2)
122     {
123         return (r1.gt(r2)) ? r1 : r2;
124     }
125 
126     /**
127      * Return the maximum value of more than two relative scalars.
128      * @param r1 the first scalar
129      * @param r2 the second scalar
130      * @param rn the other scalars
131      * @return the maximum value of more than two relative scalars
132      */
133     public static FloatPowercalar/FloatPower.html#FloatPower">FloatPowercalar/FloatPower.html#FloatPower">FloatPower max(final FloatPowercalar/FloatPower.html#FloatPower">FloatPower r1, final FloatPower r2, final FloatPower... rn)
134     {
135         FloatPower maxr = (r1.gt(r2)) ? r1 : r2;
136         for (FloatPower r : rn)
137         {
138             if (r.gt(maxr))
139             {
140                 maxr = r;
141             }
142         }
143         return maxr;
144     }
145 
146     /**
147      * Return the minimum value of two relative scalars.
148      * @param r1 the first scalar
149      * @param r2 the second scalar
150      * @return the minimum value of two relative scalars
151      */
152     public static FloatPowercalar/FloatPower.html#FloatPower">FloatPowercalar/FloatPower.html#FloatPower">FloatPower min(final FloatPowercalar/FloatPower.html#FloatPower">FloatPower r1, final FloatPower r2)
153     {
154         return (r1.lt(r2)) ? r1 : r2;
155     }
156 
157     /**
158      * Return the minimum value of more than two relative scalars.
159      * @param r1 the first scalar
160      * @param r2 the second scalar
161      * @param rn the other scalars
162      * @return the minimum value of more than two relative scalars
163      */
164     public static FloatPowercalar/FloatPower.html#FloatPower">FloatPowercalar/FloatPower.html#FloatPower">FloatPower min(final FloatPowercalar/FloatPower.html#FloatPower">FloatPower r1, final FloatPower r2, final FloatPower... rn)
165     {
166         FloatPower minr = (r1.lt(r2)) ? r1 : r2;
167         for (FloatPower r : rn)
168         {
169             if (r.lt(minr))
170             {
171                 minr = r;
172             }
173         }
174         return minr;
175     }
176 
177     /**
178      * Returns a FloatPower representation of a textual representation of a value with a unit. The String representation that
179      * can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are allowed, but
180      * not required, between the value and the unit.
181      * @param text String; the textual representation to parse into a FloatPower
182      * @return FloatPower; 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 FloatPower valueOf(final String text)
187     {
188         Throw.whenNull(text, "Error parsing FloatPower: text to parse is null");
189         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatPower: 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             PowerUnit unit = PowerUnit.BASE.getUnitByAbbreviation(unitString);
197             if (unit != null)
198             {
199                 float f = Float.parseFloat(valueString);
200                 return new FloatPower(f, unit);
201             }
202         }
203         throw new IllegalArgumentException("Error parsing FloatPower from " + text);
204     }
205 
206     /**
207      * Returns a FloatPower 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 FloatPower; 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 FloatPower of(final float value, final String unitString)
215     {
216         Throw.whenNull(unitString, "Error parsing FloatPower: unitString is null");
217         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FloatPower: empty unitString");
218         PowerUnit unit = PowerUnit.BASE.getUnitByAbbreviation(unitString);
219         if (unit != null)
220         {
221             return new FloatPower(value, unit);
222         }
223         throw new IllegalArgumentException("Error parsing FloatPower with unit " + unitString);
224     }
225 
226     /**
227      * Calculate the division of FloatPower and FloatPower, which results in a FloatDimensionless scalar.
228      * @param v FloatPower scalar
229      * @return FloatDimensionless scalar as a division of FloatPower and FloatPower
230      */
231     public final FloatDimensionless divide(final FloatPower v)
232     {
233         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
234     }
235 
236     /**
237      * Calculate the multiplication of FloatPower and FloatDuration, which results in a FloatEnergy scalar.
238      * @param v FloatPower scalar
239      * @return FloatEnergy scalar as a multiplication of FloatPower and FloatDuration
240      */
241     public final FloatEnergy times(final FloatDuration v)
242     {
243         return new FloatEnergy(this.si * v.si, EnergyUnit.SI);
244     }
245 
246     /**
247      * Calculate the division of FloatPower and FloatFrequency, which results in a FloatEnergy scalar.
248      * @param v FloatPower scalar
249      * @return FloatEnergy scalar as a division of FloatPower and FloatFrequency
250      */
251     public final FloatEnergy divide(final FloatFrequency v)
252     {
253         return new FloatEnergy(this.si / v.si, EnergyUnit.SI);
254     }
255 
256     /**
257      * Calculate the division of FloatPower and FloatEnergy, which results in a FloatFrequency scalar.
258      * @param v FloatPower scalar
259      * @return FloatFrequency scalar as a division of FloatPower and FloatEnergy
260      */
261     public final FloatFrequency divide(final FloatEnergy v)
262     {
263         return new FloatFrequency(this.si / v.si, FrequencyUnit.SI);
264     }
265 
266     /**
267      * Calculate the division of FloatPower and FloatSpeed, which results in a FloatForce scalar.
268      * @param v FloatPower scalar
269      * @return FloatForce scalar as a division of FloatPower and FloatSpeed
270      */
271     public final FloatForce divide(final FloatSpeed v)
272     {
273         return new FloatForce(this.si / v.si, ForceUnit.SI);
274     }
275 
276     /**
277      * Calculate the division of FloatPower and FloatForce, which results in a FloatSpeed scalar.
278      * @param v FloatPower scalar
279      * @return FloatSpeed scalar as a division of FloatPower and FloatForce
280      */
281     public final FloatSpeed divide(final FloatForce v)
282     {
283         return new FloatSpeed(this.si / v.si, SpeedUnit.SI);
284     }
285 
286     /**
287      * Calculate the division of FloatPower and FloatElectricalPotential, which results in a FloatElectricalCurrent scalar.
288      * @param v FloatPower scalar
289      * @return FloatElectricalCurrent scalar as a division of FloatPower and FloatElectricalPotential
290      */
291     public final FloatElectricalCurrent divide(final FloatElectricalPotential v)
292     {
293         return new FloatElectricalCurrent(this.si / v.si, ElectricalCurrentUnit.SI);
294     }
295 
296     /**
297      * Calculate the division of FloatPower and FloatElectricalCurrent, which results in a FloatElectricalPotential scalar.
298      * @param v FloatPower scalar
299      * @return FloatElectricalPotential scalar as a division of FloatPower and FloatElectricalCurrent
300      */
301     public final FloatElectricalPotential divide(final FloatElectricalCurrent v)
302     {
303         return new FloatElectricalPotential(this.si / v.si, ElectricalPotentialUnit.SI);
304     }
305 
306 }