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      @Override
87      public final FloatElectricalConductance instantiateRel(final float value, final ElectricalConductanceUnit unit)
88      {
89          return new FloatElectricalConductance(value, unit);
90      }
91  
92      /**
93       * Construct FloatElectricalConductance 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 FloatElectricalConductance instantiateSI(final float value)
98      {
99          return new FloatElectricalConductance(value, ElectricalConductanceUnit.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 FloatElectricalConductance interpolate(final FloatElectricalConductance zero,
110             final FloatElectricalConductance one, final float ratio)
111     {
112         return new FloatElectricalConductance(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
113                 zero.getDisplayUnit());
114     }
115 
116     /**
117      * Return the maximum value of two relative scalars.
118      * @param r1 the first scalar
119      * @param r2 the second scalar
120      * @return the maximum value of two relative scalars
121      */
122     public static FloatElectricalConductance max(final FloatElectricalConductance r1, final FloatElectricalConductance r2)
123     {
124         return r1.gt(r2) ? r1 : r2;
125     }
126 
127     /**
128      * Return the maximum value of more than two relative scalars.
129      * @param r1 the first scalar
130      * @param r2 the second scalar
131      * @param rn the other scalars
132      * @return the maximum value of more than two relative scalars
133      */
134     public static FloatElectricalConductance max(final FloatElectricalConductance r1, final FloatElectricalConductance r2,
135             final FloatElectricalConductance... rn)
136     {
137         FloatElectricalConductance maxr = r1.gt(r2) ? r1 : r2;
138         for (FloatElectricalConductance r : rn)
139         {
140             if (r.gt(maxr))
141             {
142                 maxr = r;
143             }
144         }
145         return maxr;
146     }
147 
148     /**
149      * Return the minimum value of two relative scalars.
150      * @param r1 the first scalar
151      * @param r2 the second scalar
152      * @return the minimum value of two relative scalars
153      */
154     public static FloatElectricalConductance min(final FloatElectricalConductance r1, final FloatElectricalConductance r2)
155     {
156         return r1.lt(r2) ? r1 : r2;
157     }
158 
159     /**
160      * Return the minimum value of more than two relative scalars.
161      * @param r1 the first scalar
162      * @param r2 the second scalar
163      * @param rn the other scalars
164      * @return the minimum value of more than two relative scalars
165      */
166     public static FloatElectricalConductance min(final FloatElectricalConductance r1, final FloatElectricalConductance r2,
167             final FloatElectricalConductance... rn)
168     {
169         FloatElectricalConductance minr = r1.lt(r2) ? r1 : r2;
170         for (FloatElectricalConductance r : rn)
171         {
172             if (r.lt(minr))
173             {
174                 minr = r;
175             }
176         }
177         return minr;
178     }
179 
180     /**
181      * Returns a FloatElectricalConductance representation of a textual representation of a value with a unit. The String
182      * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
183      * unit. Spaces are allowed, but not required, between the value and the unit.
184      * @param text String; the textual representation to parse into a FloatElectricalConductance
185      * @return FloatElectricalConductance; the Scalar representation of the value in its unit
186      * @throws IllegalArgumentException when the text cannot be parsed
187      * @throws NullPointerException when the text argument is null
188      */
189     public static FloatElectricalConductance valueOf(final String text)
190     {
191         Throw.whenNull(text, "Error parsing FloatElectricalConductance: text to parse is null");
192         Throw.when(text.length() == 0, IllegalArgumentException.class,
193                 "Error parsing FloatElectricalConductance: empty text to parse");
194         try
195         {
196             NumberParser numberParser = new NumberParser().lenient().trailing();
197             float f = numberParser.parseFloat(text);
198             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
199             ElectricalConductanceUnit unit = ElectricalConductanceUnit.BASE.getUnitByAbbreviation(unitString);
200             if (unit == null)
201                 throw new IllegalArgumentException("Unit " + unitString + " not found");
202             return new FloatElectricalConductance(f, unit);
203         }
204         catch (Exception exception)
205         {
206             throw new IllegalArgumentException("Error parsing FloatElectricalConductance from " + text + " using Locale "
207                     + Locale.getDefault(Locale.Category.FORMAT), exception);
208         }
209     }
210 
211     /**
212      * Returns a FloatElectricalConductance based on a value and the textual representation of the unit, which can be localized.
213      * @param value double; the value to use
214      * @param unitString String; the textual representation of the unit
215      * @return FloatElectricalConductance; the Scalar representation of the value in its unit
216      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
217      * @throws NullPointerException when the unitString argument is null
218      */
219     public static FloatElectricalConductance of(final float value, final String unitString)
220     {
221         Throw.whenNull(unitString, "Error parsing FloatElectricalConductance: unitString is null");
222         Throw.when(unitString.length() == 0, IllegalArgumentException.class,
223                 "Error parsing FloatElectricalConductance: empty unitString");
224         ElectricalConductanceUnit unit = ElectricalConductanceUnit.BASE.getUnitByAbbreviation(unitString);
225         if (unit != null)
226         {
227             return new FloatElectricalConductance(value, unit);
228         }
229         throw new IllegalArgumentException("Error parsing FloatElectricalConductance with unit " + unitString);
230     }
231 
232     /**
233      * Calculate the division of FloatElectricalConductance and FloatElectricalConductance, which results in a
234      * FloatDimensionless scalar.
235      * @param v FloatElectricalConductance; scalar
236      * @return FloatDimensionless; scalar as a division of FloatElectricalConductance and FloatElectricalConductance
237      */
238     public final FloatDimensionless divide(final FloatElectricalConductance v)
239     {
240         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
241     }
242 
243     /**
244      * Calculate the multiplication of FloatElectricalConductance and FloatElectricalResistance, which results in a
245      * FloatDimensionless scalar.
246      * @param v FloatElectricalConductance; scalar
247      * @return FloatDimensionless; scalar as a multiplication of FloatElectricalConductance and FloatElectricalResistance
248      */
249     public final FloatDimensionless times(final FloatElectricalResistance v)
250     {
251         return new FloatDimensionless(this.si * v.si, DimensionlessUnit.SI);
252     }
253 
254     /**
255      * Calculate the multiplication of FloatElectricalConductance and FloatElectricalPotential, which results in a
256      * FloatElectricalCurrent scalar.
257      * @param v FloatElectricalConductance; scalar
258      * @return FloatElectricalCurrent; scalar as a multiplication of FloatElectricalConductance and FloatElectricalPotential
259      */
260     public final FloatElectricalCurrent times(final FloatElectricalPotential v)
261     {
262         return new FloatElectricalCurrent(this.si * v.si, ElectricalCurrentUnit.SI);
263     }
264 
265     /**
266      * Calculate the multiplication of FloatElectricalConductance and FloatDuration, which results in a
267      * FloatElectricalCapacitance scalar.
268      * @param v FloatElectricalConductance; scalar
269      * @return FloatElectricalCapacitance; scalar as a multiplication of FloatElectricalConductance and FloatDuration
270      */
271     public final FloatElectricalCapacitance times(final FloatDuration v)
272     {
273         return new FloatElectricalCapacitance(this.si * v.si, ElectricalCapacitanceUnit.SI);
274     }
275 
276     @Override
277     public FloatElectricalResistance reciprocal()
278     {
279         return FloatElectricalResistance.instantiateSI(1.0f / this.si);
280     }
281 
282 }