View Javadoc
1   package org.djunits.value.vfloat.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.DimensionlessUnit;
6   import org.djunits.unit.ElectricalCapacitanceUnit;
7   import org.djunits.unit.ElectricalConductanceUnit;
8   import org.djunits.unit.ElectricalCurrentUnit;
9   import org.djunits.value.vfloat.scalar.base.FloatScalarRel;
10  import org.djutils.base.NumberParser;
11  import org.djutils.exceptions.Throw;
12  
13  import jakarta.annotation.Generated;
14  
15  /**
16   * Easy access methods for the FloatElectricalConductance FloatScalar, which is relative by definition.
17   * <p>
18   * Copyright (c) 2013-2024 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 = "2023-07-23T14:06:38.224104100Z")
25  public class FloatElectricalConductance extends FloatScalarRel<ElectricalConductanceUnit, FloatElectricalConductance>
26  {
27      /** */
28      private static final long serialVersionUID = 20150901L;
29  
30      /** Constant with value zero. */
31      public static final FloatElectricalConductance ZERO = new FloatElectricalConductance(0.0f, ElectricalConductanceUnit.SI);
32  
33      /** Constant with value one. */
34      public static final FloatElectricalConductance ONE = new FloatElectricalConductance(1.0f, ElectricalConductanceUnit.SI);
35  
36      /** Constant with value NaN. */
37      @SuppressWarnings("checkstyle:constantname")
38      public static final FloatElectricalConductance NaN =
39              new FloatElectricalConductance(Float.NaN, ElectricalConductanceUnit.SI);
40  
41      /** Constant with value POSITIVE_INFINITY. */
42      public static final FloatElectricalConductance POSITIVE_INFINITY =
43              new FloatElectricalConductance(Float.POSITIVE_INFINITY, ElectricalConductanceUnit.SI);
44  
45      /** Constant with value NEGATIVE_INFINITY. */
46      public static final FloatElectricalConductance NEGATIVE_INFINITY =
47              new FloatElectricalConductance(Float.NEGATIVE_INFINITY, ElectricalConductanceUnit.SI);
48  
49      /** Constant with value MAX_VALUE. */
50      public static final FloatElectricalConductance POS_MAXVALUE =
51              new FloatElectricalConductance(Float.MAX_VALUE, ElectricalConductanceUnit.SI);
52  
53      /** Constant with value -MAX_VALUE. */
54      public static final FloatElectricalConductance NEG_MAXVALUE =
55              new FloatElectricalConductance(-Float.MAX_VALUE, ElectricalConductanceUnit.SI);
56  
57      /**
58       * Construct FloatElectricalConductance scalar.
59       * @param value float; the float value
60       * @param unit unit for the float value
61       */
62      public FloatElectricalConductance(final float value, final ElectricalConductanceUnit unit)
63      {
64          super(value, unit);
65      }
66  
67      /**
68       * Construct FloatElectricalConductance scalar.
69       * @param value Scalar from which to construct this instance
70       */
71      public FloatElectricalConductance(final FloatElectricalConductance value)
72      {
73          super(value);
74      }
75  
76      /**
77       * Construct FloatElectricalConductance scalar using a double value.
78       * @param value double; the double value
79       * @param unit unit for the resulting float value
80       */
81      public FloatElectricalConductance(final double value, final ElectricalConductanceUnit unit)
82      {
83          super((float) value, unit);
84      }
85  
86      /** {@inheritDoc} */
87      @Override
88      public final FloatElectricalConductance instantiateRel(final float value, final ElectricalConductanceUnit unit)
89      {
90          return new FloatElectricalConductance(value, unit);
91      }
92  
93      /**
94       * Construct FloatElectricalConductance scalar.
95       * @param value float; the float value in SI units
96       * @return the new scalar with the SI value
97       */
98      public static final FloatElectricalConductance instantiateSI(final float value)
99      {
100         return new FloatElectricalConductance(value, ElectricalConductanceUnit.SI);
101     }
102 
103     /**
104      * Interpolate between two values.
105      * @param zero the low value
106      * @param one the high value
107      * @param ratio double; the ratio between 0 and 1, inclusive
108      * @return a Scalar at the ratio between
109      */
110     public static FloatElectricalConductance interpolate(final FloatElectricalConductance zero,
111             final FloatElectricalConductance one, final float ratio)
112     {
113         return new FloatElectricalConductance(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
114                 zero.getDisplayUnit());
115     }
116 
117     /**
118      * Return the maximum value of two relative scalars.
119      * @param r1 the first scalar
120      * @param r2 the second scalar
121      * @return the maximum value of two relative scalars
122      */
123     public static FloatElectricalConductance max(final FloatElectricalConductance r1, final FloatElectricalConductance r2)
124     {
125         return r1.gt(r2) ? r1 : r2;
126     }
127 
128     /**
129      * Return the maximum value of more than two relative scalars.
130      * @param r1 the first scalar
131      * @param r2 the second scalar
132      * @param rn the other scalars
133      * @return the maximum value of more than two relative scalars
134      */
135     public static FloatElectricalConductance max(final FloatElectricalConductance r1, final FloatElectricalConductance r2,
136             final FloatElectricalConductance... rn)
137     {
138         FloatElectricalConductance maxr = r1.gt(r2) ? r1 : r2;
139         for (FloatElectricalConductance r : rn)
140         {
141             if (r.gt(maxr))
142             {
143                 maxr = r;
144             }
145         }
146         return maxr;
147     }
148 
149     /**
150      * Return the minimum value of two relative scalars.
151      * @param r1 the first scalar
152      * @param r2 the second scalar
153      * @return the minimum value of two relative scalars
154      */
155     public static FloatElectricalConductance min(final FloatElectricalConductance r1, final FloatElectricalConductance r2)
156     {
157         return r1.lt(r2) ? r1 : r2;
158     }
159 
160     /**
161      * Return the minimum value of more than two relative scalars.
162      * @param r1 the first scalar
163      * @param r2 the second scalar
164      * @param rn the other scalars
165      * @return the minimum value of more than two relative scalars
166      */
167     public static FloatElectricalConductance min(final FloatElectricalConductance r1, final FloatElectricalConductance r2,
168             final FloatElectricalConductance... rn)
169     {
170         FloatElectricalConductance minr = r1.lt(r2) ? r1 : r2;
171         for (FloatElectricalConductance r : rn)
172         {
173             if (r.lt(minr))
174             {
175                 minr = r;
176             }
177         }
178         return minr;
179     }
180 
181     /**
182      * Returns a FloatElectricalConductance representation of a textual representation of a value with a unit. The String
183      * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
184      * unit. Spaces are allowed, but not required, between the value and the unit.
185      * @param text String; the textual representation to parse into a FloatElectricalConductance
186      * @return FloatElectricalConductance; the Scalar representation of the value in its unit
187      * @throws IllegalArgumentException when the text cannot be parsed
188      * @throws NullPointerException when the text argument is null
189      */
190     public static FloatElectricalConductance valueOf(final String text)
191     {
192         Throw.whenNull(text, "Error parsing FloatElectricalConductance: text to parse is null");
193         Throw.when(text.length() == 0, IllegalArgumentException.class,
194                 "Error parsing FloatElectricalConductance: empty text to parse");
195         try
196         {
197             NumberParser numberParser = new NumberParser().lenient().trailing();
198             float f = numberParser.parseFloat(text);
199             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
200             ElectricalConductanceUnit unit = ElectricalConductanceUnit.BASE.getUnitByAbbreviation(unitString);
201             if (unit == null)
202                 throw new IllegalArgumentException("Unit " + unitString + " not found");
203             return new FloatElectricalConductance(f, unit);
204         }
205         catch (Exception exception)
206         {
207             throw new IllegalArgumentException("Error parsing FloatElectricalConductance from " + text + " using Locale "
208                     + Locale.getDefault(Locale.Category.FORMAT), exception);
209         }
210     }
211 
212     /**
213      * Returns a FloatElectricalConductance based on a value and the textual representation of the unit, which can be localized.
214      * @param value double; the value to use
215      * @param unitString String; the textual representation of the unit
216      * @return FloatElectricalConductance; the Scalar representation of the value in its unit
217      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
218      * @throws NullPointerException when the unitString argument is null
219      */
220     public static FloatElectricalConductance of(final float value, final String unitString)
221     {
222         Throw.whenNull(unitString, "Error parsing FloatElectricalConductance: unitString is null");
223         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
224                 "Error parsing FloatElectricalConductance: empty unitString");
225         ElectricalConductanceUnit unit = ElectricalConductanceUnit.BASE.getUnitByAbbreviation(unitString);
226         if (unit != null)
227         {
228             return new FloatElectricalConductance(value, unit);
229         }
230         throw new IllegalArgumentException("Error parsing FloatElectricalConductance with unit " + unitString);
231     }
232 
233     /**
234      * Calculate the division of FloatElectricalConductance and FloatElectricalConductance, which results in a
235      * FloatDimensionless scalar.
236      * @param v FloatElectricalConductance; scalar
237      * @return FloatDimensionless; scalar as a division of FloatElectricalConductance and FloatElectricalConductance
238      */
239     public final FloatDimensionless divide(final FloatElectricalConductance v)
240     {
241         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
242     }
243 
244     /**
245      * Calculate the multiplication of FloatElectricalConductance and FloatElectricalResistance, which results in a
246      * FloatDimensionless scalar.
247      * @param v FloatElectricalConductance; scalar
248      * @return FloatDimensionless; scalar as a multiplication of FloatElectricalConductance and FloatElectricalResistance
249      */
250     public final FloatDimensionless times(final FloatElectricalResistance v)
251     {
252         return new FloatDimensionless(this.si * v.si, DimensionlessUnit.SI);
253     }
254 
255     /**
256      * Calculate the multiplication of FloatElectricalConductance and FloatElectricalPotential, which results in a
257      * FloatElectricalCurrent scalar.
258      * @param v FloatElectricalConductance; scalar
259      * @return FloatElectricalCurrent; scalar as a multiplication of FloatElectricalConductance and FloatElectricalPotential
260      */
261     public final FloatElectricalCurrent times(final FloatElectricalPotential v)
262     {
263         return new FloatElectricalCurrent(this.si * v.si, ElectricalCurrentUnit.SI);
264     }
265 
266     /**
267      * Calculate the multiplication of FloatElectricalConductance and FloatDuration, which results in a
268      * FloatElectricalCapacitance scalar.
269      * @param v FloatElectricalConductance; scalar
270      * @return FloatElectricalCapacitance; scalar as a multiplication of FloatElectricalConductance and FloatDuration
271      */
272     public final FloatElectricalCapacitance times(final FloatDuration v)
273     {
274         return new FloatElectricalCapacitance(this.si * v.si, ElectricalCapacitanceUnit.SI);
275     }
276 
277     /** {@inheritDoc} */
278     @Override
279     public FloatElectricalResistance reciprocal()
280     {
281         return FloatElectricalResistance.instantiateSI(1.0f / this.si);
282     }
283 
284 }