package org.djunits.value.vfloat.scalar;
   
   import java.util.Locale;
   
   import org.djunits.unit.DimensionlessUnit;
   import org.djunits.unit.DurationUnit;
   import org.djunits.unit.EnergyUnit;
   import org.djunits.unit.ForceUnit;
   import org.djunits.unit.LengthUnit;
  import org.djunits.unit.MomentumUnit;
  import org.djunits.unit.PowerUnit;
  import org.djunits.unit.PressureUnit;
  import org.djunits.unit.SpeedUnit;
  import org.djunits.unit.VolumeUnit;
  import org.djunits.value.vfloat.scalar.base.FloatScalar;
  import org.djunits.value.vfloat.scalar.base.FloatScalarRel;
  import org.djutils.base.NumberParser;
  import org.djutils.exceptions.Throw;
  
  import jakarta.annotation.Generated;
  
  /**
   * Easy access methods for the FloatEnergy FloatScalar, which is relative by definition.
   * <p>
   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
   * </p>
   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
   */
  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
  public class FloatEnergy extends FloatScalarRel<EnergyUnit, FloatEnergy>
  {
      /** */
      private static final long serialVersionUID = 20150901L;
  
      /** Constant with value zero. */
      public static final FloatEnergy ZERO = new FloatEnergy(0.0f, EnergyUnit.SI);
  
      /** Constant with value one. */
      public static final FloatEnergy ONE = new FloatEnergy(1.0f, EnergyUnit.SI);
  
      /** Constant with value NaN. */
      @SuppressWarnings("checkstyle:constantname")
      public static final FloatEnergy NaN = new FloatEnergy(Float.NaN, EnergyUnit.SI);
  
      /** Constant with value POSITIVE_INFINITY. */
      public static final FloatEnergy POSITIVE_INFINITY = new FloatEnergy(Float.POSITIVE_INFINITY, EnergyUnit.SI);
  
      /** Constant with value NEGATIVE_INFINITY. */
      public static final FloatEnergy NEGATIVE_INFINITY = new FloatEnergy(Float.NEGATIVE_INFINITY, EnergyUnit.SI);
  
      /** Constant with value MAX_VALUE. */
      public static final FloatEnergy POS_MAXVALUE = new FloatEnergy(Float.MAX_VALUE, EnergyUnit.SI);
  
      /** Constant with value -MAX_VALUE. */
      public static final FloatEnergy NEG_MAXVALUE = new FloatEnergy(-Float.MAX_VALUE, EnergyUnit.SI);
  
      /**
       * Construct FloatEnergy scalar.
       * @param value float; the float value
       * @param unit unit for the float value
       */
      public FloatEnergy(final float value, final EnergyUnit unit)
      {
          super(value, unit);
      }
  
      /**
       * Construct FloatEnergy scalar.
       * @param value Scalar from which to construct this instance
       */
      public FloatEnergy(final FloatEnergy value)
      {
          super(value);
      }
  
      /**
       * Construct FloatEnergy scalar using a double value.
       * @param value double; the double value
       * @param unit unit for the resulting float value
       */
      public FloatEnergy(final double value, final EnergyUnit unit)
      {
          super((float) value, unit);
      }
  
      @Override
      public final FloatEnergy instantiateRel(final float value, final EnergyUnit unit)
      {
          return new FloatEnergy(value, unit);
      }
  
      /**
       * Construct FloatEnergy scalar.
       * @param value float; the float value in SI units
       * @return the new scalar with the SI value
       */
      public static final FloatEnergy instantiateSI(final float value)
     {
         return new FloatEnergy(value, EnergyUnit.SI);
     }
 
     /**
      * Interpolate between two values.
      * @param zero the low value
      * @param one the high value
      * @param ratio double; the ratio between 0 and 1, inclusive
      * @return a Scalar at the ratio between
      */
     public static FloatEnergy interpolate(final FloatEnergy zero, final FloatEnergy one, final float ratio)
     {
         return new FloatEnergy(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
                 zero.getDisplayUnit());
     }
 
     /**
      * Return the maximum value of two relative scalars.
      * @param r1 the first scalar
      * @param r2 the second scalar
      * @return the maximum value of two relative scalars
      */
     public static FloatEnergy max(final FloatEnergy r1, final FloatEnergy r2)
     {
         return r1.gt(r2) ? r1 : r2;
     }
 
     /**
      * Return the maximum value of more than two relative scalars.
      * @param r1 the first scalar
      * @param r2 the second scalar
      * @param rn the other scalars
      * @return the maximum value of more than two relative scalars
      */
     public static FloatEnergy max(final FloatEnergy r1, final FloatEnergy r2, final FloatEnergy... rn)
     {
         FloatEnergy maxr = r1.gt(r2) ? r1 : r2;
         for (FloatEnergy r : rn)
         {
             if (r.gt(maxr))
             {
                 maxr = r;
             }
         }
         return maxr;
     }
 
     /**
      * Return the minimum value of two relative scalars.
      * @param r1 the first scalar
      * @param r2 the second scalar
      * @return the minimum value of two relative scalars
      */
     public static FloatEnergy min(final FloatEnergy r1, final FloatEnergy r2)
     {
         return r1.lt(r2) ? r1 : r2;
     }
 
     /**
      * Return the minimum value of more than two relative scalars.
      * @param r1 the first scalar
      * @param r2 the second scalar
      * @param rn the other scalars
      * @return the minimum value of more than two relative scalars
      */
     public static FloatEnergy min(final FloatEnergy r1, final FloatEnergy r2, final FloatEnergy... rn)
     {
         FloatEnergy minr = r1.lt(r2) ? r1 : r2;
         for (FloatEnergy r : rn)
         {
             if (r.lt(minr))
             {
                 minr = r;
             }
         }
         return minr;
     }
 
     /**
      * Returns a FloatEnergy representation of a textual representation of a value with a unit. The String representation that
      * can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are
      * allowed, but not required, between the value and the unit.
      * @param text String; the textual representation to parse into a FloatEnergy
      * @return FloatEnergy; the Scalar representation of the value in its unit
      * @throws IllegalArgumentException when the text cannot be parsed
      * @throws NullPointerException when the text argument is null
      */
     public static FloatEnergy valueOf(final String text)
     {
         Throw.whenNull(text, "Error parsing FloatEnergy: text to parse is null");
         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FloatEnergy: empty text to parse");
         try
         {
             NumberParser numberParser = new NumberParser().lenient().trailing();
             float f = numberParser.parseFloat(text);
             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
             EnergyUnit unit = EnergyUnit.BASE.getUnitByAbbreviation(unitString);
             if (unit == null)
                 throw new IllegalArgumentException("Unit " + unitString + " not found");
             return new FloatEnergy(f, unit);
         }
         catch (Exception exception)
         {
             throw new IllegalArgumentException(
                     "Error parsing FloatEnergy from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
                     exception);
         }
     }
 
     /**
      * Returns a FloatEnergy based on a value and the textual representation of the unit, which can be localized.
      * @param value double; the value to use
      * @param unitString String; the textual representation of the unit
      * @return FloatEnergy; the Scalar representation of the value in its unit
      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
      * @throws NullPointerException when the unitString argument is null
      */
     public static FloatEnergy of(final float value, final String unitString)
     {
         Throw.whenNull(unitString, "Error parsing FloatEnergy: unitString is null");
         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FloatEnergy: empty unitString");
         EnergyUnit unit = EnergyUnit.BASE.getUnitByAbbreviation(unitString);
         if (unit != null)
         {
             return new FloatEnergy(value, unit);
         }
         throw new IllegalArgumentException("Error parsing FloatEnergy with unit " + unitString);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatEnergy, which results in a FloatDimensionless scalar.
      * @param v FloatEnergy; scalar
      * @return FloatDimensionless; scalar as a division of FloatEnergy and FloatEnergy
      */
     public final FloatDimensionless divide(final FloatEnergy v)
     {
         return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatForce, which results in a FloatLength scalar.
      * @param v FloatEnergy; scalar
      * @return FloatLength; scalar as a division of FloatEnergy and FloatForce
      */
     public final FloatLength divide(final FloatForce v)
     {
         return new FloatLength(this.si / v.si, LengthUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatLength, which results in a FloatForce scalar.
      * @param v FloatEnergy; scalar
      * @return FloatForce; scalar as a division of FloatEnergy and FloatLength
      */
     public final FloatForce divide(final FloatLength v)
     {
         return new FloatForce(this.si / v.si, ForceUnit.SI);
     }
 
     /**
      * Calculate the multiplication of FloatEnergy and FloatLinearDensity, which results in a FloatForce scalar.
      * @param v FloatEnergy; scalar
      * @return FloatForce; scalar as a multiplication of FloatEnergy and FloatLinearDensity
      */
     public final FloatForce times(final FloatLinearDensity v)
     {
         return new FloatForce(this.si * v.si, ForceUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatDuration, which results in a FloatPower scalar.
      * @param v FloatEnergy; scalar
      * @return FloatPower; scalar as a division of FloatEnergy and FloatDuration
      */
     public final FloatPower divide(final FloatDuration v)
     {
         return new FloatPower(this.si / v.si, PowerUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatPower, which results in a FloatDuration scalar.
      * @param v FloatEnergy; scalar
      * @return FloatDuration; scalar as a division of FloatEnergy and FloatPower
      */
     public final FloatDuration divide(final FloatPower v)
     {
         return new FloatDuration(this.si / v.si, DurationUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatVolume, which results in a FloatPressure scalar.
      * @param v FloatEnergy; scalar
      * @return FloatPressure; scalar as a division of FloatEnergy and FloatVolume
      */
     public final FloatPressure divide(final FloatVolume v)
     {
         return new FloatPressure(this.si / v.si, PressureUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatPressure, which results in a FloatVolume scalar.
      * @param v FloatEnergy; scalar
      * @return FloatVolume; scalar as a division of FloatEnergy and FloatPressure
      */
     public final FloatVolume divide(final FloatPressure v)
     {
         return new FloatVolume(this.si / v.si, VolumeUnit.SI);
     }
 
     /**
      * Calculate the multiplication of FloatEnergy and FloatFrequency, which results in a FloatPower scalar.
      * @param v FloatEnergy; scalar
      * @return FloatPower; scalar as a multiplication of FloatEnergy and FloatFrequency
      */
     public final FloatPower times(final FloatFrequency v)
     {
         return new FloatPower(this.si * v.si, PowerUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatSpeed, which results in a FloatMomentum scalar.
      * @param v FloatEnergy; scalar
      * @return FloatMomentum; scalar as a division of FloatEnergy and FloatSpeed
      */
     public final FloatMomentum divide(final FloatSpeed v)
     {
         return new FloatMomentum(this.si / v.si, MomentumUnit.SI);
     }
 
     /**
      * Calculate the division of FloatEnergy and FloatMomentum, which results in a FloatSpeed scalar.
      * @param v FloatEnergy; scalar
      * @return FloatSpeed; scalar as a division of FloatEnergy and FloatMomentum
      */
     public final FloatSpeed divide(final FloatMomentum v)
     {
         return new FloatSpeed(this.si / v.si, SpeedUnit.SI);
     }
 
     @Override
     public FloatSIScalar reciprocal()
     {
         return FloatScalar.divide(FloatDimensionless.ONE, this);
     }
 
 }