package org.djunits.value.vfloat.scalar;
   
   import java.util.regex.Matcher;
   
   import org.djunits.unit.DurationUnit;
   import org.djunits.unit.TimeUnit;
   import org.djunits.unit.Unit;
   
   /**
   * Easy access methods for the Time FloatScalar. Instead of:
   * 
   * <pre>
   * FloatScalar.Abs&lt;TimeUnit&gt; value = new FloatScalar.Abs&lt;TimeUnit&gt;(100.0, TimeUnit.SI);
   * </pre>
   * 
   * we can now write:
   * 
   * <pre>
   * FloatTime value = new FloatTime(100.0, TimeUnit.SI);
   * </pre>
   * 
   * The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit
   * used are compatible.
   * <p>
   * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. <br>
   * All rights reserved. <br>
   * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
   * <p>
   * $LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $,
   * initial version Sep 1, 2015 <br>
   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
   */
  public class FloatTime extends AbstractFloatScalarAbs<TimeUnit, FloatTime, DurationUnit, FloatDuration>
  {
      /** */
      private static final long serialVersionUID = 20150901L;
  
      /** constant with value zero. */
      public static final FloatTime ZERO = new FloatTime(0.0f, TimeUnit.BASE);
  
      /**
       * Construct FloatTime scalar.
       * @param value float value
       * @param unit unit for the float value
       */
      public FloatTime(final float value, final TimeUnit unit)
      {
          super(value, unit);
      }
  
      /**
       * Construct FloatTime scalar using a double value.
       * @param value double value
       * @param unit unit for the resulting float value
       */
      public FloatTime(final double value, final TimeUnit unit)
      {
          super((float) value, unit);
      }
  
      /**
       * Construct FloatTime scalar.
       * @param value Scalar from which to construct this instance
       */
      public FloatTime(final FloatTime value)
      {
          super(value);
      }
  
      /** {@inheritDoc} */
      @Override
      public final FloatTime instantiateAbs(final float value, final TimeUnit unit)
      {
          return new FloatTime(value, unit);
      }
  
      /** {@inheritDoc} */
      @Override
      public final FloatDuration instantiateRel(final float value, final DurationUnit unit)
      {
          return new FloatDuration(value, unit);
      }
  
      /**
       * Construct FloatTime scalar.
       * @param value float value in BASE units
       * @return the new scalar with the BASE value
       */
      public static final FloatTime createSI(final float value)
      {
          return new FloatTime(value, TimeUnit.BASE);
      }
  
      /**
       * Interpolate between two values.
       * @param zero the low value
       * @param one the high value
       * @param ratio the ratio between 0 and 1, inclusive
      * @return a Scalar at the ratio between
      */
     public static FloatTime interpolate(final FloatTime zero, final FloatTime one, final float ratio)
     {
         return new FloatTime(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getUnit()) * ratio, zero.getUnit());
     }
 
     /**
      * Return the maximum value of two absolute scalars.
      * @param a1 the first scalar
      * @param a2 the second scalar
      * @return the maximum value of two absolute scalars
      */
     public static FloatTime max(final FloatTime a1, final FloatTime a2)
     {
         return (a1.gt(a2)) ? a1 : a2;
     }
 
     /**
      * Return the maximum value of more than two absolute scalars.
      * @param a1 the first scalar
      * @param a2 the second scalar
      * @param an the other scalars
      * @return the maximum value of more than two absolute scalars
      */
     public static FloatTime max(final FloatTime a1, final FloatTime a2, final FloatTime... an)
     {
         FloatTime maxa = (a1.gt(a2)) ? a1 : a2;
         for (FloatTime a : an)
         {
             if (a.gt(maxa))
             {
                 maxa = a;
             }
         }
         return maxa;
     }
 
     /**
      * Return the minimum value of two absolute scalars.
      * @param a1 the first scalar
      * @param a2 the second scalar
      * @return the minimum value of two absolute scalars
      */
     public static FloatTime min(final FloatTime a1, final FloatTime a2)
     {
         return (a1.lt(a2)) ? a1 : a2;
     }
 
     /**
      * Return the minimum value of more than two absolute scalars.
      * @param a1 the first scalar
      * @param a2 the second scalar
      * @param an the other scalars
      * @return the minimum value of more than two absolute scalars
      */
     public static FloatTime min(final FloatTime a1, final FloatTime a2, final FloatTime... an)
     {
         FloatTime mina = (a1.lt(a2)) ? a1 : a2;
         for (FloatTime a : an)
         {
             if (a.lt(mina))
             {
                 mina = a;
             }
         }
         return mina;
     }
 
     /**
      * Returns a FloatTime 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 the official abbreviation of the unit. Spaces are allowed, but not
      * necessary, between the value and the unit.
      * @param text String; the textual representation to parse into a FloatTime
      * @return the String representation of the value in its unit, followed by the official abbreviation of the unit
      * @throws IllegalArgumentException when the text cannot be parsed
      */
     public static FloatTime valueOf(final String text) throws IllegalArgumentException
     {
         if (text == null || text.length() == 0)
         {
             throw new IllegalArgumentException("Error parsing FloatTime -- null or empty argument");
         }
         Matcher matcher = NUMBER_PATTERN.matcher(text);
         if (matcher.find())
         {
             int index = matcher.end();
             try
             {
                 String unitString = text.substring(index).trim();
                 String valueString = text.substring(0, index).trim();
                 for (TimeUnit unit : Unit.getUnits(TimeUnit.class))
                 {
                     if (unit.getDefaultLocaleTextualRepresentations().contains(unitString))
                     {
                         float f = Float.parseFloat(valueString);
                         return new FloatTime(f, unit);
                     }
                 }
             }
             catch (Exception exception)
             {
                 throw new IllegalArgumentException("Error parsing FloatTime from " + text, exception);
             }
         }
         throw new IllegalArgumentException("Error parsing FloatTime from " + text);
     }
 
 }