DoubleUtils (Net2Plan API)

Object
- com.net2plan.utils.DoubleUtils

```
public class DoubleUtils
extends Object
```
Provides extra functionality for double primitives.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors
Constructor and Description

DoubleUtils()

Constructors
Constructor and Description
`DoubleUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Double[]`	`asObjectArray(double[] array)` Converts from a `double` array to a `Double` array.
`static double[]`	`asPrimitiveArray(Double[] array)` Converts from a `Double` array to a `double` array.
`static double`	`average(double[] array)` Returns the average value of an array.
`static double`	`averageNonZeros(double[] array)` Returns the average value only among non-zero values
`static double[]`	`concatenate(double[]... arrays)` Concatenates a series of arrays.
`static boolean`	`contains(double[] array, double value)` Checks if an input array contains a given value
`static boolean`	`containsAll(double[] array1, double[] array2)` Checks if an array contains all numbers from another.
`static boolean`	`containsAny(double[] array1, double[] array2)` Checks whether any element of an array is present in another.
`static double[]`	`copy(double[] array)` Returns a deep copy of the input `array`.
`static double[]`	`divide(double[] array, double value)` Divides all elements in an array by a scalar.
`static double[]`	`divide(double[] array1, double[] array2)` Divides two arrays element-to-element
`static double[]`	`divideNonSingular(double[] array1, double[] array2)` Divides two arrays element-to-element, but when numerator and denominator = 0, returns 0 instead of a singularity (NaN)
`static int[]`	`find(double[] array, double value, Constants.SearchType searchType)` Returns the position(s) where a given value can be found into an array.
`static double`	`gcd(double[] array)` Computes the greatest common divisor of a double array.
`static double[]`	`intersect(double[]... arrays)` Returns the intersection vector of a series of input arrays.
`static boolean`	`isEqualWithinAbsoluteTolerance(double pattern, double value, double tolerance)` Checks if a given value is within a tolerance margin compared to a given pattern.
`static boolean`	`isEqualWithinRelativeTolerance(double pattern, double value, double tolerance)` Checks if the relative difference between a given value and a pattern is within a tolerance margin.
`static String`	`join(double[] array, String separator)` Joins the elements in an input array using a given separator.
`static int[]`	`maxIndexes(double[] array, Constants.SearchType searchType)` Returns the position(s) in which the maximum value is found.
`static int[][]`	`maxMinIndexes(double[] array, Constants.SearchType searchType)` Returns the position(s) in which the maximum/minimum values are found.
`static double[]`	`maxMinValues(double[] array)` Returns the maximum/minimum values of an input array.
`static double`	`maxValue(double[] array)` Returns the maximum value in the input array.
`static double`	`maxValue(double[][] array)` Returns the maximum value in the input array.
`static int[]`	`minIndexes(double[] array, Constants.SearchType searchType)` Returns the position(s) in which the minimum value is found.
`static double`	`minValue(double[] array)` Returns the minimum value in the input array.
`static double[]`	`mult(double[] array, double value)` Multiplies all elements in an array by a scalar.
`static double[]`	`mult(double[] array1, double[] array2)` Multiplies two arrays element-to-element.
`static double[]`	`ones(int N)` Returns an array filled with zeros.
`static void`	`reverse(double[] array)` Reverses the order of the elements of the input array (it will be overriden).
`static double[]`	`select(double[] array, int[] indexes)` Returns a set of selected elements from an input array.
`static double[]`	`selectColumn(double[][] array, int column)` Returns a column of a bidimensional input array.
`static double[]`	`selectRow(double[][] array, int row)` Returns a row of a bidimensional input array.
`static double[]`	`setdiff(double[]... arrays)` Returns the elements contained in the first array, but not any of the others.
`static void`	`sort(double[] array, Constants.OrderingType orderingType)` Sorts the input array (it will be overriden).
`static int[]`	`sortIndexes(double[] array, Constants.OrderingType orderingType)` Sorts indexes of the `array` into ascending/descending order in a stable way.
`static double`	`std(double[] array)` Returns the standard deviation of an array.
`static double[]`	`substract(double[] array1, double[] array2)` Returns the element-wise substraction of two arrays.
`static double`	`sum(double[] array)` Returns the sum of all elements in the array.
`static double[]`	`sum(double[] array1, double[] array2)` Returns the element-wise sum of two arrays.
`static double[]`	`toArray(Collection<Double> list)` Converts a collection (`List`, `Set`...) of `Double` objects to a `double` array.
`static int[]`	`toIntArray(double[] array)` Converts a `double` array to an `int` array
`static List<Double>`	`toList(double[] array)` Converts from a `double` array to a list.
`static double[]`	`union(double[]... arrays)` Returns an array with all elements in input arrays (no repetitions).
`static double[]`	`unique(double[] array)` Returns the same values of the input `array` but with no repetitions.
`static double[]`	`zeros(int N)` Returns an array filled with zeros.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DoubleUtils
```
public DoubleUtils()
```
- Method Detail
  - concatenate
```
public static double[] concatenate(double[]... arrays)
```
    Concatenates a series of arrays.
    
    Parameters:
    arrays - List of arrays
    
    Returns:
    Concatenated array
    Since:
    
    0.2.0
  - std
```
public static double std(double[] array)
```
    Returns the standard deviation of an array.
    
    Parameters:
    array - Input array
    
    Returns:
    Standard deviation
    Since:
    
    0.2.0
  - averageNonZeros
```
public static double averageNonZeros(double[] array)
```
    Returns the average value only among non-zero values
    
    Parameters:
    array - Input array
    
    Returns:
    Average value among non-zero values
    Since:
    
    0.2.0
  - average
```
public static double average(double[] array)
```
    Returns the average value of an array.
    
    Parameters:
    array - Input array
    
    Returns:
    Average value
    Since:
    
    0.2.0
  - asObjectArray
```
public static Double[] asObjectArray(double[] array)
```
    Converts from a double array to a Double array.
    
    Parameters:
    array - double array
    
    Returns:
    Equivalent Double array
    Since:
    
    0.2.0
  - asPrimitiveArray
```
public static double[] asPrimitiveArray(Double[] array)
```
    Converts from a Double array to a double array.
    
    Parameters:
    array - Double array
    
    Returns:
    Equivalent double array
    Since:
    
    0.2.0
  - contains
```
public static boolean contains(double[] array,
               double value)
```
    Checks if an input array contains a given value
    
    Parameters:
    array - Input array
    value - Value to search
    
    Returns:
    true if value is present in array, and false otherwise
    Since:
    
    0.2.0
  - containsAll
```
public static boolean containsAll(double[] array1,
                  double[] array2)
```
    Checks if an array contains all numbers from another.
    
    Parameters:
    array1 - Container array
    array2 - Array with elements to be checked
    
    Returns:
    true if value is present in array, and false otherwise
    Since:
    
    0.2.0
  - containsAny
```
public static boolean containsAny(double[] array1,
                  double[] array2)
```
    Checks whether any element of an array is present in another. It is equivalent to assert if intersection(array1, array2).length == 0.
    
    Parameters:
    array1 - Container array
    array2 - Array with elements to be checked
    
    Returns:
    true if any number in array1 is present in array2, and false otherwise
    Since:
    
    0.2.0
  - copy
```
public static double[] copy(double[] array)
```
    Returns a deep copy of the input array.
    
    Parameters:
    array - Input array
    
    Returns:
    Deep copy of array
    Since:
    
    0.2.0
  - find
```
public static int[] find(double[] array,
         double value,
         Constants.SearchType searchType)
```
    Returns the position(s) where a given value can be found into an array.
    
    Parameters:
    array - Input array
    value - Value to be searched for
    searchType - Indicates whether the first, the last, or all minimum positions are returned
    
    Returns:
    Position(s) in which the minimum value is found
    Since:
    
    0.2.0
  - gcd
```
public static double gcd(double[] array)
```
    Computes the greatest common divisor of a double array.
    
    Parameters:
    array - Input array
    
    Returns:
    The greatest common divisor. By convention, gcd(0, 0) is equal to zero and gcd([]) is equal to one
    Since:
    
    0.2.0
  - intersect
```
public static double[] intersect(double[]... arrays)
```
    Returns the intersection vector of a series of input arrays. There is no order guarantee.
    
    Parameters:
    arrays - Vector of input arrays
    
    Returns:
    Intersection vector of input arrays
    Since:
    
    0.2.0
  - isEqualWithinAbsoluteTolerance
```
public static boolean isEqualWithinAbsoluteTolerance(double pattern,
                                     double value,
                                     double tolerance)
```
    Checks if a given value is within a tolerance margin compared to a given pattern.
    
    Parameters:
    pattern - Pattern value
    value - Value to compare with pattern
    tolerance - Tolerance margin
    
    Returns:
    true if value is within the tolerance, and false otherwise
    Since:
    
    0.2.0
  - isEqualWithinRelativeTolerance
```
public static boolean isEqualWithinRelativeTolerance(double pattern,
                                     double value,
                                     double tolerance)
```
    Checks if the relative difference between a given value and a pattern is within a tolerance margin.
    
    Parameters:
    pattern - Pattern value
    value - Value to compare with pattern
    tolerance - Tolerance margin
    
    Returns:
    true if value is within the tolerance, and false otherwise
    Since:
    
    0.2.0
  - join
```
public static String join(double[] array,
          String separator)
```
    Joins the elements in an input array using a given separator. It is an improved version of Arrays.toString().
    
    Parameters:
    array - Input array
    separator - Separator
    
    Returns:
    String representation of the input array
    Since:
    
    0.2.0
  - maxValue
```
public static double maxValue(double[] array)
```
    Returns the maximum value in the input array.
    
    Parameters:
    array - Input array
    
    Returns:
    Maximum value
    Since:
    
    0.2.0
  - maxIndexes
```
public static int[] maxIndexes(double[] array,
               Constants.SearchType searchType)
```
    Returns the position(s) in which the maximum value is found.
    
    Parameters:
    array - Input array
    searchType - Indicates whether the first, the last, or all maximum positions are returned
    
    Returns:
    Position(s) in which the maximum value is found
    Since:
    
    0.2.0
  - maxMinValues
```
public static double[] maxMinValues(double[] array)
```
    Returns the maximum/minimum values of an input array.
    
    Parameters:
    array - Input array
    
    Returns:
    Maximum/minimum values
    Since:
    
    0.2.0
  - maxValue
```
public static double maxValue(double[][] array)
```
    Returns the maximum value in the input array.
    
    Parameters:
    array - Input array
    
    Returns:
    Maximum value
    Since:
    
    0.2.0
  - maxMinIndexes
```
public static int[][] maxMinIndexes(double[] array,
                    Constants.SearchType searchType)
```
    Returns the position(s) in which the maximum/minimum values are found.
    
    out[0] are the maximum positions, while out[1] are the minimum positions
    
    Parameters:
    array - Input array
    searchType - Indicates whether the first, the last, or all maximum positions are returned
    
    Returns:
    Position(s) in which the maximum/minimum value are found.
    Since:
    
    0.2.0
  - minValue
```
public static double minValue(double[] array)
```
    Returns the minimum value in the input array.
    
    Parameters:
    array - Input array
    
    Returns:
    Minimum value
    Since:
    
    0.2.0
  - minIndexes
```
public static int[] minIndexes(double[] array,
               Constants.SearchType searchType)
```
    Returns the position(s) in which the minimum value is found.
    
    Parameters:
    array - Input array
    searchType - Indicates whether the first, the last, or all minimum positions are returned
    
    Returns:
    Position(s) in which the minimum value is found
    Since:
    
    0.2.0
  - ones
```
public static double[] ones(int N)
```
    Returns an array filled with zeros.
    
    Parameters:
    N - Number of elements
    
    Returns:
    A zero-array of length N
    Since:
    
    0.2.0
  - reverse
```
public static void reverse(double[] array)
```
    Reverses the order of the elements of the input array (it will be overriden).
    
    Parameters:
    array - Input array
    Since:
    
    0.2.0
  - select
```
public static double[] select(double[] array,
              int[] indexes)
```
    Returns a set of selected elements from an input array. It is not backed in the input array, thus changes in this array are not reflected in the input array.
    
    Parameters:
    array - Input array
    indexes - Position of elements to be selected.
    
    Returns:
    Set of elements in the order given by indexes
    Since:
    
    0.2.0
  - selectColumn
```
public static double[] selectColumn(double[][] array,
                    int column)
```
    Returns a column of a bidimensional input array.
    
    Parameters:
    array - Input array
    column - Column
    
    Returns:
    Column of an array
    Since:
    
    0.2.0
  - selectRow
```
public static double[] selectRow(double[][] array,
                 int row)
```
    Returns a row of a bidimensional input array.
    
    Parameters:
    array - Input array
    row - Row
    
    Returns:
    Row of an array
    Since:
    
    0.2.0
  - setdiff
```
public static double[] setdiff(double[]... arrays)
```
    Returns the elements contained in the first array, but not any of the others.
    
    Parameters:
    arrays - Input arrays
    
    Returns:
    Difference set
    Since:
    
    0.2.0
  - sort
```
public static void sort(double[] array,
        Constants.OrderingType orderingType)
```
    Sorts the input array (it will be overriden).
    
    Parameters:
    array - Input array
    orderingType - Ascending or descending
    Since:
    
    0.2.0
  - sortIndexes
```
public static int[] sortIndexes(double[] array,
                Constants.OrderingType orderingType)
```
    Sorts indexes of the array into ascending/descending order in a stable way. Stable means that index order doesn't change if values are the same.
    
    Parameters:
    array - Array to be sorted
    orderingType - Ascending or descending
    
    Returns:
    Sorted indexes
    Since:
    
    0.2.0
  - toArray
```
public static double[] toArray(Collection<Double> list)
```
    Converts a collection (List, Set...) of Double objects to a double array.
    
    Parameters:
    list - Input list
    
    Returns:
    int array
    Since:
    
    0.2.0
  - toList
```
public static List<Double> toList(double[] array)
```
    Converts from a double array to a list.
    
    Parameters:
    array - Input array
    
    Returns:
    A list of Double objects
    Since:
    
    0.2.0
  - union
```
public static double[] union(double[]... arrays)
```
    Returns an array with all elements in input arrays (no repetitions). There is no order guarantee.
    
    Parameters:
    arrays - Input arrays
    
    Returns:
    A new array with all elements in input arrays
    Since:
    
    0.2.0
  - unique
```
public static double[] unique(double[] array)
```
    Returns the same values of the input array but with no repetitions. There is no order guarantee.
    
    Parameters:
    array - Input array
    
    Returns:
    Same values as in array but with no repetitions
    Since:
    
    0.2.0
  - zeros
```
public static double[] zeros(int N)
```
    Returns an array filled with zeros.
    
    Parameters:
    N - Number of elements
    
    Returns:
    A zero-array of length N
    Since:
    
    0.2.0
  - toIntArray
```
public static int[] toIntArray(double[] array)
```
    Converts a double array to an int array
    
    Parameters:
    array - Input array
    
    Returns:
    int array
    Since:
    
    0.2.0
  - sum
```
public static double sum(double[] array)
```
    Returns the sum of all elements in the array.
    
    Parameters:
    array - Input array
    
    Returns:
    Sum of all array elements
    Since:
    
    0.2.0
  - sum
```
public static double[] sum(double[] array1,
           double[] array2)
```
    Returns the element-wise sum of two arrays.
    
    Parameters:
    array1 - Input array 1
    array2 - Input array 2
    
    Returns:
    A new array with the element-wise sum
    Since:
    
    0.2.0
  - mult
```
public static double[] mult(double[] array,
            double value)
```
    Multiplies all elements in an array by a scalar.
    
    Parameters:
    array - Input array
    value - Scalar
    
    Returns:
    A new array containing the input elements multiplied by the scalar
    Since:
    
    0.2.0
  - mult
```
public static double[] mult(double[] array1,
            double[] array2)
```
    Multiplies two arrays element-to-element.
    
    Parameters:
    array1 - Input array 1
    array2 - Input array 2
    
    Returns:
    The element-wise multiplication of the input arrays
    Since:
    
    0.2.0
  - substract
```
public static double[] substract(double[] array1,
                 double[] array2)
```
    Returns the element-wise substraction of two arrays.
    
    Parameters:
    array1 - Input array 1
    array2 - Input array 2
    
    Returns:
    A new array with the element-wise subtraction
    Since:
    
    0.2.0
  - divide
```
public static double[] divide(double[] array1,
              double[] array2)
```
    Divides two arrays element-to-element
    
    Parameters:
    array1 - Numerator
    array2 - Denominator
    
    Returns:
    The element-wise division of the input arrays
    Since:
    
    0.2.0
  - divide
```
public static double[] divide(double[] array,
              double value)
```
    Divides all elements in an array by a scalar.
    
    Parameters:
    array - Input array
    value - Scalar
    
    Returns:
    A new array containing the input elements divided by the scalar
    Since:
    
    0.2.0
  - divideNonSingular
```
public static double[] divideNonSingular(double[] array1,
                         double[] array2)
```
    Divides two arrays element-to-element, but when numerator and denominator = 0, returns 0 instead of a singularity (NaN)
    
    Parameters:
    array1 - Numerator
    array2 - Denominator
    
    Returns:
    The element-wise division of the input arrays
    Since:
    
    0.2.0

Class DoubleUtils

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

DoubleUtils

Method Detail

concatenate

std

averageNonZeros

average

asObjectArray

asPrimitiveArray

contains

containsAll

containsAny

copy

find

gcd

intersect

isEqualWithinAbsoluteTolerance

isEqualWithinRelativeTolerance

join

maxValue

maxIndexes

maxMinValues

maxValue

maxMinIndexes

minValue

minIndexes

ones

reverse

select

selectColumn

selectRow

setdiff

sort

sortIndexes

toArray

toList

union

unique

zeros

toIntArray

sum

sum

mult

mult

substract

divide

divide

divideNonSingular