ZArrays (ZenGarden-Core 0.2.9 API)

java.lang.Object
- org.openzen.zengarden.util.ZArrays

```
public class ZArrays
extends java.lang.Object
```
Array utility functions. Contains stuff that I believe should have been in java.util.Arrays.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> java.util.Set<T>`	`asSet(T[] array)` Converts the array into a set.
`static <T> T[]`	`filter(T[] array, Predicate<T> predicate)` Creates a new array containing only the values matching the given predicate.
`static <T> T`	`first(T[] array, Predicate<T> predicate)` Returns the first value matching the given predicate, or null if none could be found.
`static <T> int`	`indexOf(T[] array, T value)` Find the first index of the given object in the array.
`static <T> T`	`last(T[] array, Predicate<T> predicate)` Returns the last value matching the given predicate, or null if none could be found.
`static <T> int`	`lastIndexOf(T[] array, T value)` Find the last index of the given object in the array.
`static <T,R> R[]`	`map(java.lang.Class<R> component, T[] array, Function<T,R> function)` Creates a new array, converting each value of the original value using the mapping function.
`static double`	`max(double[] array)` Determines the largest value in this array.
`static float`	`max(float[] array)` Determines the largest value in this array.
`static int`	`max(int[] array)` Determines the largest value in this array.
`static long`	`max(long[] array)` Determines the largest value in this array.
`static <T> T`	`max(T[] array, java.util.Comparator<T> comparator)` Returns the largest element in this array, according to the given comparator.
`static <T> double`	`maxDouble(T[] array, ToDoubleFunction<T> function)` Returns the smallest value returned by the evaluation function, for any of the elements in the given array.
`static <T> T`	`maxForDouble(T[] array, ToDoubleFunction<T> function)` Returns the element for which the given function returns the largest double value.
`static <T> T`	`maxForInt(T[] array, ToIntFunction<T> function)` Returns the element for which the given function returns the largest integer value.
`static <T> T`	`maxForLong(T[] array, ToLongFunction<T> function)` Returns the element for which the given function returns the largest long value.
`static <T> int`	`maxInt(T[] array, ToIntFunction<T> function)` Returns the largest value returned by the evaluation function, for any of the elements in the given array.
`static <T> long`	`maxLong(T[] array, ToLongFunction<T> function)` Returns the largest value returned by the evaluation function, for any of the elements in the given array.
`static double`	`min(double[] array)` Determines the smallest value in this array.
`static float`	`min(float[] array)` Determines the smallest value in this array.
`static int`	`min(int[] array)` Determines the smallest value in this array.
`static long`	`min(long[] array)` Determines the smallest value in this array.
`static <T> T`	`min(T[] array, java.util.Comparator<T> comparator)` Returns the smallest element in this array, according to the given comparator.
`static <T> double`	`minDouble(T[] array, ToDoubleFunction<T> function)` Returns the smallest value returned by the evaluation function, for any of the elements in the given array.
`static <T> T`	`minForDouble(T[] array, ToDoubleFunction<T> function)` Returns the element for which the given function returns the smallest double value.
`static <T> T`	`minForInt(T[] array, ToIntFunction<T> function)` Returns the element for which the given function returns the smallest integer value.
`static <T> T`	`minForLong(T[] array, ToLongFunction<T> function)` Returns the element for which the given function returns the smallest long value.
`static <T> int`	`minInt(T[] array, ToIntFunction<T> function)` Returns the smallest value returned by the evaluation function, for any of the elements in the given array.
`static <T> long`	`minLong(T[] array, ToLongFunction<T> function)` Returns the smallest value returned by the evaluation function, for any of the elements in the given array.
`static double`	`sum(double[] array)` Calculates the sum of all elements in this array
`static float`	`sum(float[] array)` Calculates the sum of all elements in this array
`static int`	`sum(int[] array)` Calculates the sum of all elements in this array.
`static <T> double`	`sumForDouble(T[] array, ToDoubleFunction<T> function)` Calculates the sum of a function over the given array.
`static <T> int`	`sumForInt(T[] array, ToIntFunction<T> function)` Calculates the sum of a function over the given array.

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

- Method Detail
  - indexOf
```
public static <T> int indexOf(T[] array,
                              T value)
```
    Find the first index of the given object in the array.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    array - haystack
    
    value - needle
    
    Returns:
    
    first index of the needle, or -1 if not found
  - lastIndexOf
```
public static <T> int lastIndexOf(T[] array,
                                  T value)
```
    Find the last index of the given object in the array.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    array - haystack
    
    value - needle
    
    Returns:
    
    last index of the needle, or -1 if not found
  - sum
```
public static int sum(int[] array)
```
    Calculates the sum of all elements in this array.
    
    Parameters:
    
    array - array to sum
    
    Returns:
    
    sum of elements
  - sum
```
public static float sum(float[] array)
```
    Calculates the sum of all elements in this array
    
    Parameters:
    
    array - array to sum
    
    Returns:
    
    sum of elements
  - sum
```
public static double sum(double[] array)
```
    Calculates the sum of all elements in this array
    
    Parameters:
    
    array - array to sum
    
    Returns:
    
    sum of elements
  - sumForInt
```
public static <T> int sumForInt(T[] array,
                                ToIntFunction<T> function)
```
    Calculates the sum of a function over the given array.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    array - array
    
    function - calculation function
    
    Returns:
    
    sum
  - sumForDouble
```
public static <T> double sumForDouble(T[] array,
                                      ToDoubleFunction<T> function)
```
    Calculates the sum of a function over the given array.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    array - array
    
    function - calculation function
    
    Returns:
    
    sum
  - asSet
```
public static <T> java.util.Set<T> asSet(T[] array)
```
    Converts the array into a set.
    
    Type Parameters:
    
    T - object type
    
    Parameters:
    
    array - array to be converted
    
    Returns:
    
    set with all elements from the array
  - map
```
public static <T,R> R[] map(java.lang.Class<R> component,
                            T[] array,
                            Function<T,R> function)
```
    Creates a new array, converting each value of the original value using the mapping function.
    
    Type Parameters:
    
    T - original component type
    
    R - resulting component type
    
    Parameters:
    
    component - component class
    
    array - original array
    
    function - mapping function
    
    Returns:
    
    mapped array
  - filter
```
public static <T> T[] filter(T[] array,
                             Predicate<T> predicate)
```
    Creates a new array containing only the values matching the given predicate.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - original array
    
    predicate - predicate
    
    Returns:
    
    filtered array
  - first
```
public static <T> T first(T[] array,
                          Predicate<T> predicate)
```
    Returns the first value matching the given predicate, or null if none could be found.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to look in
    
    predicate - predicate
    
    Returns:
    
    first matching value, or null
  - last
```
public static <T> T last(T[] array,
                         Predicate<T> predicate)
```
    Returns the last value matching the given predicate, or null if none could be found.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to look in
    
    predicate - predicate
    
    Returns:
    
    last matching value, or null
  - min
```
public static int min(int[] array)
```
    Determines the smallest value in this array. Returns Integer.MAX_VALUE if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    minimum value, or Integer.MAX_VALUE for an empty array
  - min
```
public static long min(long[] array)
```
    Determines the smallest value in this array. Returns Long.MAX_VALUE if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    minimum value, or Long.MAX_VALUE for an empty array
  - min
```
public static float min(float[] array)
```
    Determines the smallest value in this array. Returns Float.POSITIVE_INFINITY if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    minimum value, or Float.POSITIVE_INFINITY for an empty array
  - min
```
public static double min(double[] array)
```
    Determines the smallest value in this array. Returns Double.POSITIVE_INFINITY if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    minimum value, or Double.POSITIVE_INFINITY for an empty array
  - min
```
public static <T> T min(T[] array,
                        java.util.Comparator<T> comparator)
```
    Returns the smallest element in this array, according to the given comparator. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    comparator - comparator
    
    Returns:
    
    smallest element
  - minForInt
```
public static <T> T minForInt(T[] array,
                              ToIntFunction<T> function)
```
    Returns the element for which the given function returns the smallest integer value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the smallest value
  - minForLong
```
public static <T> T minForLong(T[] array,
                               ToLongFunction<T> function)
```
    Returns the element for which the given function returns the smallest long value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the smallest value
  - minForDouble
```
public static <T> T minForDouble(T[] array,
                                 ToDoubleFunction<T> function)
```
    Returns the element for which the given function returns the smallest double value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the smallest value
  - minInt
```
public static <T> int minInt(T[] array,
                             ToIntFunction<T> function)
```
    Returns the smallest value returned by the evaluation function, for any of the elements in the given array. Returns Integer.MAX_VALUE for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    smallest evaluated value
  - minLong
```
public static <T> long minLong(T[] array,
                               ToLongFunction<T> function)
```
    Returns the smallest value returned by the evaluation function, for any of the elements in the given array. Returns Long.MAX_VALUE for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    smallest evaluated value
  - minDouble
```
public static <T> double minDouble(T[] array,
                                   ToDoubleFunction<T> function)
```
    Returns the smallest value returned by the evaluation function, for any of the elements in the given array. Returns Double.POSITIVE_INFINITY for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    smallest evaluated value
  - max
```
public static int max(int[] array)
```
    Determines the largest value in this array. Returns Integer.MIN_VALUE if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    maximum value, or Integer.MIN_VALUE for an empty array
  - max
```
public static long max(long[] array)
```
    Determines the largest value in this array. Returns Long.MIN_VALUE if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    maximum value, or Long.MIN_VALUE for an empty array
  - max
```
public static float max(float[] array)
```
    Determines the largest value in this array. Returns Float.NEGATIVE_INFINITY if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    maximum value, or Float.NEGATIVE_INFINITY for an empty array
  - max
```
public static double max(double[] array)
```
    Determines the largest value in this array. Returns Double.NEGATIVE_INFINITY if the array is empty.
    
    Parameters:
    
    array - array to read
    
    Returns:
    
    maximum value, or Double.NEGATIVE_INFINITY for an empty array
  - max
```
public static <T> T max(T[] array,
                        java.util.Comparator<T> comparator)
```
    Returns the largest element in this array, according to the given comparator. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    comparator - comparator
    
    Returns:
    
    largest element
  - maxForInt
```
public static <T> T maxForInt(T[] array,
                              ToIntFunction<T> function)
```
    Returns the element for which the given function returns the largest integer value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the largest value
  - maxForLong
```
public static <T> T maxForLong(T[] array,
                               ToLongFunction<T> function)
```
    Returns the element for which the given function returns the largest long value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the largest value
  - maxForDouble
```
public static <T> T maxForDouble(T[] array,
                                 ToDoubleFunction<T> function)
```
    Returns the element for which the given function returns the largest double value. Returns null for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    element for the largest value
  - maxInt
```
public static <T> int maxInt(T[] array,
                             ToIntFunction<T> function)
```
    Returns the largest value returned by the evaluation function, for any of the elements in the given array. Returns Integer.MIN_VALUE for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    largest evaluated value
  - maxLong
```
public static <T> long maxLong(T[] array,
                               ToLongFunction<T> function)
```
    Returns the largest value returned by the evaluation function, for any of the elements in the given array. Returns Long.MIN_VALUE for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    largest evaluated value
  - maxDouble
```
public static <T> double maxDouble(T[] array,
                                   ToDoubleFunction<T> function)
```
    Returns the smallest value returned by the evaluation function, for any of the elements in the given array. Returns Double.NEGATIVE_INFINITY for an empty array.
    
    Type Parameters:
    
    T - component type
    
    Parameters:
    
    array - array to evaluate
    
    function - evaluation function
    
    Returns:
    
    largest evaluated value

Class ZArrays

Method Summary

Methods inherited from class java.lang.Object

Method Detail

indexOf

lastIndexOf

sum

sum

sum

sumForInt

sumForDouble

asSet

map

filter

first

last

min

min

min

min

min

minForInt

minForLong

minForDouble

minInt

minLong

minDouble

max

max

max

max

max

maxForInt

maxForLong

maxForDouble

maxInt

maxLong

maxDouble