Package com.illumon.iris.libs.primitives

Class DoublePrimitives

java.lang.Object
com.illumon.iris.libs.primitives.DoublePrimitives
public class DoublePrimitives extends Object
A set of commonly used functions that can be applied to Double types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DoublePrimitives()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static DbDoubleArray
    array(double[] values)
    Converts a primitive array to a DB array.
    static double[]
    concat(double[]... values)
    Returns the concatenation of multiple arrays into a single array.
    static double[]
    concat(DbDoubleArray... values)
    Returns the concatenation of multiple arrays into a single array.
    static int
    count(double[] values)
    Counts the number of non-null values.
    static int
    count(DbDoubleArray values)
    Counts the number of non-null values.
    static int
    count(Double[] values)
    Counts the number of non-null values.
    static long
    countDistinct(double[] values)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(double[] values, boolean countNull)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(DbDoubleArray values)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(DbDoubleArray values, boolean countNull)
    Counts the number of distinct elements in the array.
    static double[]
    distinct(double[] values)
    Returns an array containing only the distinct values from the input.
    static double[]
    distinct(double[] values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static DbDoubleArray
    distinct(DbDoubleArray values)
    Returns an array containing only the distinct values from the input.
    static DbDoubleArray
    distinct(DbDoubleArray values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static double[]
    enlist(double... values)
    Returns a list containing its arguments.
    static double
    first(double[] values)
    Returns the first value from an array.
    static double
    first(DbDoubleArray values)
    Returns the first value from an array.
    static double[]
    forwardFill(double[] values)
     
    static boolean
    in(double testedValues, double... possibleValues)
    Checks if a value is within a discrete set of possible values.
    static boolean
    inRange(double testedValue, double lowInclusiveValue, double highInclusiveValue)
    Checks if a value is within a range.
    static boolean
    isNull(double value)
    Determines if a value is null.
    static double
    last(double[] values)
    Returns the last value from an array.
    static double
    last(DbDoubleArray values)
    Returns the last value from an array.
    static double
    nth(int index, double[] values)
    Returns the nth value from an array.
    static double
    nth(int index, DbDoubleArray values)
    Returns the nth value from an array.
    static double[]
    nullToValue(double[] values, double defaultValue)
    Replaces null values with a default value.
    static double
    nullToValue(double value, double defaultValue)
    Replaces null values with a default value.
    static double[]
    nullToValue(DbDoubleArray values, double defaultValue)
    Replaces null values with a default value.
    static double[]
    repeat(double value, int size)
    Returns an array with a value repeated.
    static double[]
    reverse(double... values)
    Returns an array with the values reversed.
    static double[]
    reverse(DbDoubleArray values)
    Returns an array with the values reversed.
    static double[]
    unbox(Double... values)
    Unboxes a array of values.
    static double
    uniqueValue(DbDoubleArray arr, boolean countNull)
    Get the single unique value in the array, or null if there are none, or there are more than 1 distinct values.
    static double[]
    vec(DbDoubleArray values)
    Converts a DB array to a primitive array.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DoublePrimitives

      public DoublePrimitives()

  • Method Details

    • unbox

      public static double[] unbox(Double... values)
      Unboxes a array of values.
      Parameters:
      values - values.
      Returns:
      unboxed array of values.

    • isNull

      public static boolean isNull(double value)
      Determines if a value is null.
      Parameters:
      value - value.
      Returns:
      true if the value is null, and false otherwise.

    • nullToValue

      public static double nullToValue(double value, double defaultValue)
      Replaces null values with a default value.
      Parameters:
      value - value.
      defaultValue - default value to return for null values.
      Returns:
      value, if value is not null, and defaultValue if value is null.

    • nullToValue

      public static double[] nullToValue(double[] values, double defaultValue)
      Replaces null values with a default value.
      Parameters:
      values - values.
      defaultValue - default value to return for null values.
      Returns:
      values with nulls replaced by defaultValue.

    • nullToValue

      public static double[] nullToValue(DbDoubleArray values, double defaultValue)
      Replaces null values with a default value.
      Parameters:
      values - values.
      defaultValue - default value to return for null values.
      Returns:
      values with nulls replaced by defaultValue.

    • count

      public static int count(Double[] values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • count

      public static int count(double[] values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • count

      public static int count(DbDoubleArray values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • last

      public static double last(DbDoubleArray values)
      Returns the last value from an array.
      Parameters:
      values - values.
      Returns:
      last value from the array.

    • last

      public static double last(double[] values)
      Returns the last value from an array.
      Parameters:
      values - values.
      Returns:
      last value from the array.

    • first

      public static double first(DbDoubleArray values)
      Returns the first value from an array.
      Parameters:
      values - values.
      Returns:
      first value from the array.

    • first

      public static double first(double[] values)
      Returns the first value from an array.
      Parameters:
      values - values.
      Returns:
      first value from the array.

    • nth

      public static double nth(int index, DbDoubleArray values)
      Returns the nth value from an array.
      Parameters:
      index - index of the value to return.
      values - values.
      Returns:
      nth value from the array or null, if the index is outside of the array's index range.

    • nth

      public static double nth(int index, double[] values)
      Returns the nth value from an array.
      Parameters:
      index - index of the value to return.
      values - values.
      Returns:
      nth value from the array or null, if the index is outside of the array's index range.

    • vec

      public static double[] vec(DbDoubleArray values)
      Converts a DB array to a primitive array.
      Parameters:
      values - DB array
      Returns:
      primitive array.

    • array

      public static DbDoubleArray array(double[] values)
      Converts a primitive array to a DB array.
      Parameters:
      values - primitive array
      Returns:
      DB array.

    • inRange

      public static boolean inRange(double testedValue, double lowInclusiveValue, double highInclusiveValue)
      Checks if a value is within a range.
      Parameters:
      testedValue - tested value.
      lowInclusiveValue - lower inclusive bound of the range.
      highInclusiveValue - upper inclusive bound of the range.
      Returns:
      true if the tested value is within the range, and false if the tested value is not in the range or is null.

    • in

      public static boolean in(double testedValues, double... possibleValues)
      Checks if a value is within a discrete set of possible values.
      Parameters:
      testedValues - tested value.
      possibleValues - possible values.
      Returns:
      true if the tested value is contained in the possible values, and false otherwise.

    • countDistinct

      public static long countDistinct(double[] values)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      Returns:
      number of distinct non-null values.

    • countDistinct

      public static long countDistinct(DbDoubleArray values)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      Returns:
      number of distinct non-null values.

    • countDistinct

      public static long countDistinct(double[] values, boolean countNull)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      countNull - true to count null values, and false to exclude null values.
      Returns:
      number of distinct values.

    • countDistinct

      public static long countDistinct(DbDoubleArray values, boolean countNull)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      countNull - true to count null values, and false to exclude null values.
      Returns:
      number of distinct values.

    • uniqueValue

      public static double uniqueValue(DbDoubleArray arr, boolean countNull)
      Get the single unique value in the array, or null if there are none, or there are more than 1 distinct values.
      Parameters:
      arr - the array
      countNull - if nulls should count as values
      Returns:
      the single unique value in the array, or null.

    • distinct

      public static double[] distinct(double[] values)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      Returns:
      unsorted array containing only distinct non-null items from arr.

    • distinct

      public static DbDoubleArray distinct(DbDoubleArray values)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      Returns:
      unsorted array containing only distinct non-null items from arr.

    • distinct

      public static double[] distinct(double[] values, boolean includeNull, boolean sort)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      includeNull - true to include null values, and false to exclude null values.
      sort - true to sort the resultant array
      Returns:
      array containing only distinct items from arr.

    • distinct

      public static DbDoubleArray distinct(DbDoubleArray values, boolean includeNull, boolean sort)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      includeNull - true to include null values, and false to exclude null values.
      sort - true to sort the resultant array
      Returns:
      array containing only distinct items from arr.

    • repeat

      public static double[] repeat(double value, int size)
      Returns an array with a value repeated.
      Parameters:
      value - value.
      size - number of times to repeat the value.
      Returns:
      array of repeated values. If size is less than zero, an empty array is returned.

    • enlist

      public static double[] enlist(double... values)
      Returns a list containing its arguments.
      Parameters:
      values - values.
      Returns:
      list containing values.

    • concat

      public static double[] concat(double[]... values)
      Returns the concatenation of multiple arrays into a single array.
      Parameters:
      values - values.
      Returns:
      concatenation of multiple arrays into a single array.

    • concat

      public static double[] concat(DbDoubleArray... values)
      Returns the concatenation of multiple arrays into a single array.
      Parameters:
      values - values.
      Returns:
      concatenation of multiple arrays into a single array.

    • reverse

      public static double[] reverse(double... values)
      Returns an array with the values reversed.
      Parameters:
      values - values.
      Returns:
      array with the values reversed.

    • reverse

      public static double[] reverse(DbDoubleArray values)
      Returns an array with the values reversed.
      Parameters:
      values - values.
      Returns:
      array with the values reversed.

    • forwardFill

      public static double[] forwardFill(double[] values)