LongUtils (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.utils.LongUtils

```
public class LongUtils
extends Object
```
Provides extra functionality for long primitives.

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long[]`	`arrayOf(long... values)` Generates a `long[]` from comma-separated values.
`static Long[]`	`asObjectArray(long[] array)` Converts from an `long` array to an `Long` array.
`static long[]`	`asPrimitiveArray(Long[] array)` Converts from an `Long` array to an `long` array.
`static double`	`average(long[] array)` Returns the average value of an array.
`static double`	`averageNonZeros(long[] array)` Returns the average value only among non-zero values
`static long[]`	`concatenate(long[]... arrays)` Concatenates a series of arrays.
`static long[]`	`constantArray(int N, long value)` Returns an array filled with a given value.
`static <A> Map<A,Long>`	`constantMap(Set<A> identifiers, long value)` Returns a map filled with a given value.
`static boolean`	`contains(long[] array, long value)` Checks if an input array contains a given value
`static boolean`	`containsAll(long[] container, long[] array)` Checks if an array contains all numbers from another one.
`static boolean`	`containsAny(long[] container, long[] array)` Checks whether any element of an array is present in another one.
`static <A extends Number> Map<A,Long>`	`convertArray2Map(Set<A> identifiers, long[] array)` Returns a map containing the association of each identifier with its corresponding value within the array (in linear order).
`static <A extends Number,B extends Number> Map<Pair<A,B>,Long>`	`convertTable2Map(Set<A> rowIdentifiers, Set<B> columnIdentifiers, long[][] table)` Returns a map containing the association of each identifier pair with its corresponding value within the table (in linear order).
`static long[]`	`copy(long[] array)` Returns a deep copy of the input `array`.
`static long[][]`	`copy(long[][] array)` Returns a deep copy of the input `array`.
`static double[]`	`divide(long[] array, double value)` Divides all elements in an array by a scalar.
`static double[]`	`divide(long[] array1, long[] array2)` Divides two arrays element-to-element.
`static double[]`	`divideNonSingular(long[] array1, long[] array2)` Divides two arrays element-to-element, but when numerator and denominator = 0, returns 0 instead of a singularity (NaN)
`static int[]`	`find(long[] array, long value, Constants.SearchType searchType)` Returns the position(s) where a given value can be found into an array.
`static long`	`gcd(long[] array)` Computes the greatest absolute common divisor of an integer array.
`static long[]`	`intersect(long[]... arrays)` Returns the intersection vector of a series of input arrays.
`static String`	`join(long[] array, String separator)` Joins the elements in an input array using a given separator.
`static List<Long>`	`listOf(long... values)` Returns a list of the comma-separated input values.
`static int[]`	`maxIndexes(long[] array, Constants.SearchType searchType)` Returns the position(s) in which the maximum value is found.
`static int[][]`	`maxMinIndexes(long[] array, Constants.SearchType searchType)` Returns the position(s) in which the maximum/minimum values are found.
`static long[]`	`maxMinValues(long[] array)` Returns the maximum/minimum values of an input array.
`static long`	`maxValue(Collection<Long> collection)` Returns the maximum value in the input collection.
`static long`	`maxValue(long[] array)` Returns the maximum value in the input array.
`static long`	`maxValue(long[][] array)` Returns the maximum value in the input array.
`static int[]`	`minIndexes(long[] array, Constants.SearchType searchType)` Returns the position(s) in which the minimum value is found.
`static long`	`minValue(Collection<Long> collection)` Returns the minimum value in the input collection.
`static long`	`minValue(long[] array)` Returns the minimum value in the input array.
`static double[][]`	`mult(long[][] matrix, double value)` Multiplies all elements in a matrix by a scalar.
`static double[]`	`mult(long[] array, double value)` Multiplies all elements in an array by a scalar.
`static double[]`	`mult(long[] array1, long[] array2)` Multiplies two arrays element-to-element.
`static long[]`	`ones(int N)` Returns an array filled with ones.
`static void`	`reverse(long[] array)` Reverses the order of the elements of the input array (it will be overriden).
`static double`	`scalarProduct(long[] array1, long[] array2)` Scalar product of two vectors.
`static <A> double`	`scalarProduct(Map<A,Long> map1, Map<A,Long> map2)` Scalar product of two maps.
`static long[]`	`select(long[] array, int[] indexes)` Returns a set of selected elements from an input array.
`static long[]`	`selectColumn(long[][] array, int column)` Returns a column of a bidimensional input array.
`static long[]`	`selectRow(long[][] array, int row)` Returns a row of a bidimensional input array.
`static long[]`	`setdiff(long[]... arrays)` Returns the elements contained in the first array, but not any of the others.
`static Set<Long>`	`setOf(long... values)` Returns a list of the comma-separated input values.
`static void`	`sort(long[] array, Constants.OrderingType orderingType)` Sorts the input array (it will be overriden).
`static int[]`	`sortIndexes(long[] array, Constants.OrderingType orderingType)` Sorts indexes of the `array` into ascending/descending order in a stable way.
`static double`	`std(long[] array)` Returns the standard deviation of an array using the Welford's method.
`static long[]`	`substract(long[] array1, long[] array2)` Returns the element-wise substraction of two arrays.
`static double`	`sum(long[] array)` Returns the sum of all elements in the array.
`static double[]`	`sum(long[] array1, long[] array2)` Returns the element-wise sum of two arrays.
`static long[]`	`toArray(Collection<Long> list)` Converts a collection (`List`, `Set`...) of `Long` objects to a `long` array.
`static long[]`	`toArray(String[] list)` Converts an array of `String` with the values, into a `long` array.
`static double[]`	`toDoubleArray(long[] array)` Converts a `long` array to a `double` array
`static int[]`	`toIntArray(long[] array)` Converts a `long` array to an `int` array (truncation may happen).
`static List<Long>`	`toList(long[] array)` Converts from a `long` array to a list.
`static String`	`toString(long[] array)` Converts the array into an String of space separated values.
`static long[]`	`union(long[]... arrays)` Returns an array with all elements in input arrays (no repetitions).
`static Set<Long>`	`unique(Collection<Long> collection)` Returns the same values of the input `array` but with no repetitions.
`static long[]`	`unique(long[] array)` Returns the same values of the input `array` but with no repetitions.
`static long[]`	`zeros(int N)` Returns an array filled with zeros.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - arrayOf
```
public static long[] arrayOf(long... values)
```
    Generates a long[] from comma-separated values.
    
    Parameters:
    
    values - Comma-separated long values
    
    Returns:
    
    long[]
  - asObjectArray
```
public static Long[] asObjectArray(long[] array)
```
    Converts from an long array to an Long array.
    
    Parameters:
    
    array - long array
    
    Returns:
    
    Equivalent Long array
  - asPrimitiveArray
```
public static long[] asPrimitiveArray(Long[] array)
```
    Converts from an Long array to an long array.
    
    Parameters:
    
    array - Long array
    
    Returns:
    
    Equivalent long array
  - average
```
public static double average(long[] array)
```
    Returns the average value of an array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Average value
  - averageNonZeros
```
public static double averageNonZeros(long[] array)
```
    Returns the average value only among non-zero values
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Average value among non-zero values
  - concatenate
```
public static long[] concatenate(long[]... arrays)
```
    Concatenates a series of arrays.
    
    Parameters:
    
    arrays - List of arrays
    
    Returns:
    
    Concatenated array
  - constantArray
```
public static long[] constantArray(int N,
                                   long value)
```
    Returns an array filled with a given value.
    
    Parameters:
    
    N - Number of elements
    
    value - Value for all elements
    
    Returns:
    
    An array of length N with the given value
  - constantMap
```
public static <A> Map<A,Long> constantMap(Set<A> identifiers,
                                          long value)
```
    Returns a map filled with a given value.
    
    Type Parameters:
    
    A - Key type
    
    Parameters:
    
    identifiers - Set of map keys
    
    value - Value for all elements
    
    Returns:
    
    A map with the given value in each entry
  - contains
```
public static boolean contains(long[] array,
                               long 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. If array is empty, it will return false
  - containsAll
```
public static boolean containsAll(long[] container,
                                  long[] array)
```
    Checks if an array contains all numbers from another one.
    
    Parameters:
    
    container - Container array
    
    array - Array with elements to be checked
    
    Returns:
    
    true if all elements in array are present in container, and false otherwise. If container is empty, it will return false
  - containsAny
```
public static boolean containsAny(long[] container,
                                  long[] array)
```
    Checks whether any element of an array is present in another one. It is equivalent to assert if intersection(array1, array2).length == 0.
    
    Parameters:
    
    container - Container array
    
    array - Array with elements to be checked
    
    Returns:
    
    true if any element in array is present in container, and false otherwise. If container is empty, it will return false
  - convertArray2Map
```
public static <A extends Number> Map<A,Long> convertArray2Map(Set<A> identifiers,
                                                              long[] array)
```
    Returns a map containing the association of each identifier with its corresponding value within the array (in linear order). First element in the array will be associated to the first identifier in the set (in iteration order), second element in the array to the second element in the set, and so on.
    
    Type Parameters:
    
    A - Key type
    
    Parameters:
    
    identifiers - Set of identifier in ascending iterator order (duplicated and null values are not allowed)
    
    array - Input array
    
    Returns:
    
    Map
  - convertTable2Map
```
public static <A extends Number,B extends Number> Map<Pair<A,B>,Long> convertTable2Map(Set<A> rowIdentifiers,
                                                                                       Set<B> columnIdentifiers,
                                                                                       long[][] table)
```
    Returns a map containing the association of each identifier pair with its corresponding value within the table (in linear order). First element in the table will be associated to the first identifier pair (in iteration order), second element in the table to the second identifier pair, and so on.
    
    Type Parameters:
    
    A - Row key type
    
    B - Column key type
    
    Parameters:
    
    rowIdentifiers - Set of row identifiers in ascending iterator order (null values are not allowed)
    
    columnIdentifiers - Set of column identifiers in ascending iterator order (duplicated and null values are not allowed)
    
    table - Input table
    
    Returns:
    
    Map
  - copy
```
public static long[] copy(long[] array)
```
    Returns a deep copy of the input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Deep copy of array
  - copy
```
public static long[][] copy(long[][] array)
```
    Returns a deep copy of the input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Deep copy of array
  - divide
```
public static double[] divide(long[] 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
  - divide
```
public static double[] divide(long[] array1,
                              long[] array2)
```
    Divides two arrays element-to-element.
    
    Parameters:
    
    array1 - Numerator
    
    array2 - Denominator
    
    Returns:
    
    The element-wise division of the input arrays
  - divideNonSingular
```
public static double[] divideNonSingular(long[] array1,
                                         long[] 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
  - find
```
public static int[] find(long[] array,
                         long 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 occurrences are returned
    
    Returns:
    
    Position(s) in which the given value can be found
  - gcd
```
public static long gcd(long[] array)
```
    Computes the greatest absolute common divisor of an integer array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    The greatest absolute common divisor. By convention, gcd(0, 0) is equal to zero and gcd([]) is equal to one
  - intersect
```
public static long[] intersect(long[]... 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
  - join
```
public static String join(long[] 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
  - listOf
```
public static List<Long> listOf(long... values)
```
    Returns a list of the comma-separated input values.
    
    Parameters:
    
    values - Comma-separated input values
    
    Returns:
    
    List of values (iteration order equal to insertion order)
  - maxIndexes
```
public static int[] maxIndexes(long[] 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
  - maxMinIndexes
```
public static int[][] maxMinIndexes(long[] 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.
  - maxMinValues
```
public static long[] maxMinValues(long[] array)
```
    Returns the maximum/minimum values of an input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Maximum/minimum values
  - maxValue
```
public static long maxValue(Collection<Long> collection)
```
    Returns the maximum value in the input collection.
    
    Parameters:
    
    collection - Input collection
    
    Returns:
    
    Maximum value
  - maxValue
```
public static long maxValue(long[] array)
```
    Returns the maximum value in the input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Maximum value
  - maxValue
```
public static long maxValue(long[][] array)
```
    Returns the maximum value in the input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Maximum value
  - minIndexes
```
public static int[] minIndexes(long[] 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
  - minValue
```
public static long minValue(Collection<Long> collection)
```
    Returns the minimum value in the input collection.
    
    Parameters:
    
    collection - Input collection
    
    Returns:
    
    Minimum value
  - minValue
```
public static long minValue(long[] array)
```
    Returns the minimum value in the input array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Minimum value
  - mult
```
public static double[][] mult(long[][] matrix,
                              double value)
```
    Multiplies all elements in a matrix by a scalar.
    
    Parameters:
    
    matrix - Input array
    
    value - Scalar
    
    Returns:
    
    A new matrix containing the input elements multiplied by the scalar
  - mult
```
public static double[] mult(long[] 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
  - mult
```
public static double[] mult(long[] array1,
                            long[] 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
  - ones
```
public static long[] ones(int N)
```
    Returns an array filled with ones.
    
    Parameters:
    
    N - Number of elements
    
    Returns:
    
    An all-one array of length N
  - reverse
```
public static void reverse(long[] array)
```
    Reverses the order of the elements of the input array (it will be overriden).
    
    Parameters:
    
    array - Input array
  - scalarProduct
```
public static double scalarProduct(long[] array1,
                                   long[] array2)
```
    Scalar product of two vectors.
    
    Parameters:
    
    array1 - Input array 1
    
    array2 - Input array 2
    
    Returns:
    
    The scalar product of the input arrays
  - scalarProduct
```
public static <A> double scalarProduct(Map<A,Long> map1,
                                       Map<A,Long> map2)
```
    Scalar product of two maps.
    
    Type Parameters:
    
    A - Key type
    
    Parameters:
    
    map1 - Input map 1
    
    map2 - Input map 2
    
    Returns:
    
    The scalar product of the input maps
  - select
```
public static long[] select(long[] 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
  - selectColumn
```
public static long[] selectColumn(long[][] array,
                                  int column)
```
    Returns a column of a bidimensional input array.
    
    Parameters:
    
    array - Input array
    
    column - Column
    
    Returns:
    
    Column of an array
  - selectRow
```
public static long[] selectRow(long[][] array,
                               int row)
```
    Returns a row of a bidimensional input array.
    
    Parameters:
    
    array - Input array
    
    row - Row
    
    Returns:
    
    Row of an array
  - setdiff
```
public static long[] setdiff(long[]... arrays)
```
    Returns the elements contained in the first array, but not any of the others.
    
    Parameters:
    
    arrays - Input arrays
    
    Returns:
    
    Difference set
  - setOf
```
public static Set<Long> setOf(long... values)
```
    Returns a list of the comma-separated input values.
    
    Parameters:
    
    values - Comma-separated input values
    
    Returns:
    
    List of values (iteration order equal to insertion order)
  - sort
```
public static void sort(long[] array,
                        Constants.OrderingType orderingType)
```
    Sorts the input array (it will be overriden).
    
    Parameters:
    
    array - Input array
    
    orderingType - Ascending or descending
  - sortIndexes
```
public static int[] sortIndexes(long[] 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
  - std
```
public static double std(long[] array)
```
    Returns the standard deviation of an array using the Welford's method.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Standard deviation
  - substract
```
public static long[] substract(long[] array1,
                               long[] 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
  - sum
```
public static double sum(long[] array)
```
    Returns the sum of all elements in the array.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    Sum of all array elements
  - sum
```
public static double[] sum(long[] array1,
                           long[] 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
  - toArray
```
public static long[] toArray(Collection<Long> list)
```
    Converts a collection (List, Set...) of Long objects to a long array.
    
    Parameters:
    
    list - Input list
    
    Returns:
    
    long array
  - toArray
```
public static long[] toArray(String[] list)
```
    Converts an array of String with the values, into a long array. Uses Long.parseLong to parse the number, an can raise the exceptions that this method raises
    
    Parameters:
    
    list - Input list
    
    Returns:
    
    output array
  - toDoubleArray
```
public static double[] toDoubleArray(long[] array)
```
    Converts a long array to a double array
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    double array
  - toIntArray
```
public static int[] toIntArray(long[] array)
```
    Converts a long array to an int array (truncation may happen).
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    int array
  - toList
```
public static List<Long> toList(long[] array)
```
    Converts from a long array to a list.
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    A list of Long objects
  - toString
```
public static String toString(long[] array)
```
    Converts the array into an String of space separated values. If the array is empty, "" is returned
    
    Parameters:
    
    array - Input array
    
    Returns:
    
    The string representation
  - union
```
public static long[] union(long[]... 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
  - unique
```
public static Set<Long> unique(Collection<Long> collection)
```
    Returns the same values of the input array but with no repetitions. There is no order guarantee.
    
    Parameters:
    
    collection - Input array
    
    Returns:
    
    Same values as in array but with no repetitions
  - unique
```
public static long[] unique(long[] 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
  - zeros
```
public static long[] zeros(int N)
```
    Returns an array filled with zeros.
    
    Parameters:
    
    N - Number of elements
    
    Returns:
    
    An all-zero array of length N

Class LongUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

arrayOf

asObjectArray

asPrimitiveArray

average

averageNonZeros

concatenate

constantArray

constantMap

contains

containsAll

containsAny

convertArray2Map

convertTable2Map

copy

copy

divide

divide

divideNonSingular

find

gcd

intersect

join

listOf

maxIndexes

maxMinIndexes

maxMinValues

maxValue

maxValue

maxValue

minIndexes

minValue

minValue

mult

mult

mult

ones

reverse

scalarProduct

scalarProduct

select

selectColumn

selectRow

setdiff

setOf

sort

sortIndexes

std

substract

sum

sum

toArray

toArray

toDoubleArray

toIntArray

toList

toString

union

unique

unique

zeros