fr.cnes.sirius.patrius.math.optim.joptimizer.util

Class ArrayUtils

java.lang.Object

fr.cnes.sirius.patrius.math.optim.joptimizer.util.ArrayUtils

public final class ArrayUtils
extends Object

Operations on arrays, primitive arrays (like int[]) and primitive wrapper arrays (like Integer[]).

This class tries to handle null input gracefully. An exception will not be thrown for a null array input. However, an Object array that contains a null element may throw an exception. Each method documents its behavior.

Since:

4.6

Method Summary

Modifier and Type	Method and Description
static int[]	add(int[] array, int element) Copies the given array and adds the given element at the end of the new array.
static int[]	add(int[] array, int index, int element) Underlying implementation of add(array, index, element) methods.
static boolean	contains(int[] array, int valueToFind) Checks if the value is in the given array.
static int	getArrayIndex(int[] arr, int value) Finds the index of the given value in the array.
static int	getArrayMinIndex(int[] arr) Finds the index of the minimum value in the array.
static int[]	insert(int index, int[] array, int... values) Inserts elements into an array at the given index (starting from zero).
static Object	remove(Object array, int index) Removes the element at the specified position from the specified array.
static int[]	removeElements(int[] array, int... values) Removes occurrences of specified elements, in specified quantities, from the specified array.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static int[] add(int[] array,
                        int index,
                        int element)

Underlying implementation of add(array, index, element) methods. The last parameter is the class, which may not equal element.getClass for primitives.

Parameters:

array - the array to add the element to, may be null

index - the position of the new object

element - the object to add

Returns:

A new array containing the existing elements and the new element

insert

public static int[] insert(int index,
                           int[] array,
                           int... values)

Inserts elements into an array at the given index (starting from zero).

Parameters:

index - the position within array to insert the new values

array - the array to insert the values into, may be null

values - the new values to insert, may be null

Returns:

The new array.

Throws:

IndexOutOfBoundsException - if array is provided and either index < 0 or index > array.length

remove

public static Object remove(Object array,
                            int index)

Removes the element at the specified position from the specified array. All subsequent elements are shifted to the left (subtracts one from their indices).

Parameters:

array - the array to remove the element from, may not be null

index - the position of the element to be removed

Returns:

A new array containing the existing elements except the element at the specified position.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= array.length), or if the array is null.

add

public static int[] add(int[] array,
                        int element)

Copies the given array and adds the given element at the end of the new array. from https://github.com/apache/commons-lang/blob/61e82e832e31037810cec0c526ecd83fbeb62227/src/ main/java/org/apache/commons/lang3/ArrayUtils.java#L4656

Parameters:

array - the array to copy and add the element to, may be null

element - the object to add at the last index of the new array

Returns:

A new array containing the existing elements plus the new element

contains

public static boolean contains(int[] array,
                               int valueToFind)

Checks if the value is in the given array. from https://github.com/apache/commons-lang/blob/61e82e832e31037810cec0c526ecd83fbeb62227/src/ main/java/org/apache/commons/lang3/ArrayUtils.java#L4656 The method returns false if a null array is passed in.

Parameters:

array - the array to search through

valueToFind - the value to find

Returns:

true if the array contains the object

removeElements

public static int[] removeElements(int[] array,
                                   int... values)

Removes occurrences of specified elements, in specified quantities, from the specified array. All subsequent elements are shifted left.

Parameters:

array - the array to remove the element from, may be null

values - the elements to be removed

Returns:

A new array containing the existing elements except the earliest-encountered occurrences of the specified elements.

getArrayIndex

public static int getArrayIndex(int[] arr,
                                int value)

Finds the index of the given value in the array.

Parameters:

arr - array to search through for the object, may be null

value - to find

Returns:

the index of the value within the array, (-1) if not found or null array input

getArrayMinIndex

public static int getArrayMinIndex(int[] arr)

Finds the index of the minimum value in the array.

Parameters:

arr - array to search through for the object, may be null

Returns:

the index of the value within the array, (-1) if not found or null array input