com.hfg.math.NumUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.math;


//------------------------------------------------------------------------------

import java.util.List;

import com.hfg.util.collection.CollectionUtil;

/**
 * General numeric utility methods.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class NumUtil
{

   //**************************************************************************
   // PUBLIC FUNCTIONS
   //**************************************************************************

   //--------------------------------------------------------------------------
   /**
    Compares the absolute value of two ints. The equivalent of Integer's compareTo()
    but for int primitives.
    */
   public static int compare(int inValue1, int inValue2)
   {
      int returnValue = 0;

      if (inValue1 < inValue2)
      {
         returnValue = -1;
      }
      else if (inValue1 > inValue2)
      {
         returnValue = 1;
      }

      return returnValue;
   }

   //--------------------------------------------------------------------------
   /**
    Compares the absolute value of two ints.
    */
   public static int compareAbs(int inValue1, int inValue2)
   {
      return compare(Math.abs(inValue1), Math.abs(inValue2));
   }


   //--------------------------------------------------------------------------
   public static double sum(List inValues)
   {
      double sum = 0;

      if (CollectionUtil.hasValues(inValues))
      {
         for (Number value : inValues)
         {
            sum += value.doubleValue();
         }
      }

      return sum;
   }


   //--------------------------------------------------------------------------
   /**
    A null-safe version of min() function in Integer, Float, Double, etc.
    * @param inValue1 first number
    * @param inValue2 second number
    * @param  the type of Number object
    * @return the minimum of the first and second numbers
    */
   public static  N min(N inValue1, N inValue2)
   {
      N min = null;

      if(inValue1 != null)
      {
         if(inValue2 != null)
         {
            min = (inValue1.doubleValue() <= inValue2.doubleValue() ? inValue1 : inValue2);
         }
         else
         {
            min = inValue1;
         }
      }
      else if (inValue2 != null)
      {
         min = inValue2;
      }

      return min;
   }

   //--------------------------------------------------------------------------
   /**
    A null-safe version of max() function in Integer, Float, Double, etc.
    * @param inValue1 first number
    * @param inValue2 second number
    * @param  the type of Number object
    * @return the maximum of the first and second numbers
    */
   public static  N max(N inValue1, N inValue2)
   {
      N max = null;

      if(inValue1 != null)
      {
         if(inValue2 != null)
         {
            max = (inValue1.doubleValue() >= inValue2.doubleValue() ? inValue1 : inValue2);
         }
         else
         {
            max = inValue1;
         }
      }
      else if (inValue2 != null)
      {
         max = inValue2;
      }

      return max;
   }
}