public final class IntArray extends Object implements Matrix, org.joda.beans.ImmutableBean, Serializable
int values.
This provides functionality similar to List but for int[].
In mathematical terms, this is a vector, or one-dimensional matrix.
| Modifier and Type | Method and Description |
|---|---|
IntArray |
combine(IntArray other,
IntBinaryOperator operator)
Returns an instance where each element is formed by some combination of the matching
values in this array and the other array.
|
int |
combineReduce(IntArray other,
IntTernaryOperator operator)
Combines this array and the other array returning a reduced value.
|
IntArray |
concat(int... arrayToConcat)
Returns an array that combines this array and the specified array.
|
IntArray |
concat(IntArray arrayToConcat)
Returns an array that combines this array and the specified array.
|
boolean |
contains(int value)
Checks if this array contains the specified value.
|
void |
copyInto(int[] destination,
int offset)
Copies this array into the specified array.
|
static IntArray |
copyOf(Collection<Integer> collection)
Obtains an instance from a collection of
Integer. |
static IntArray |
copyOf(int[] array)
Obtains an instance from an array of
int. |
static IntArray |
copyOf(int[] array,
int fromIndex)
Obtains an instance by copying part of an array.
|
static IntArray |
copyOf(int[] array,
int fromIndexInclusive,
int toIndexExclusive)
Obtains an instance by copying part of an array.
|
int |
dimensions()
Gets the number of dimensions of this array.
|
IntArray |
dividedBy(int divisor)
Returns an instance with each value divided by the specified divisor.
|
IntArray |
dividedBy(IntArray other)
Returns an instance where each element is calculated by dividing values in this array by values in the other array.
|
boolean |
equals(Object obj) |
static IntArray |
filled(int size)
Obtains an instance with all entries equal to the zero.
|
static IntArray |
filled(int size,
int value)
Obtains an instance with all entries equal to the same value.
|
void |
forEach(IntIntConsumer action)
Applies an action to each value in the array.
|
int |
get(int index)
Gets the value at the specified index in this array.
|
int |
hashCode() |
int |
indexOf(int value)
Find the index of the first occurrence of the specified value.
|
boolean |
isEmpty()
Checks if this array is empty.
|
int |
lastIndexOf(int value)
Find the index of the first occurrence of the specified value.
|
IntArray |
map(IntUnaryOperator operator)
Returns an instance with an operation applied to each value in the array.
|
IntArray |
mapWithIndex(IntBinaryOperator function)
Returns an instance with an operation applied to each indexed value in the array.
|
int |
max()
Returns the minimum value held in the array.
|
org.joda.beans.MetaBean |
metaBean() |
int |
min()
Returns the minimum value held in the array.
|
IntArray |
minus(int amount)
Returns an instance with the specified amount subtracted from each value.
|
IntArray |
minus(IntArray other)
Returns an instance where each element is equal to the difference between the
matching values in this array and the other array.
|
IntArray |
multipliedBy(int factor)
Returns an instance with each value multiplied by the specified factor.
|
IntArray |
multipliedBy(IntArray other)
Returns an instance where each element is equal to the product of the
matching values in this array and the other array.
|
static IntArray |
of()
Obtains an empty immutable array.
|
static IntArray |
of(int value)
Obtains an immutable array with a single value.
|
static IntArray |
of(int value1,
int value2)
Obtains an immutable array with two values.
|
static IntArray |
of(int value1,
int value2,
int value3)
Obtains an immutable array with three values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4)
Obtains an immutable array with four values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4,
int value5)
Obtains an immutable array with five values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4,
int value5,
int value6)
Obtains an immutable array with six values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4,
int value5,
int value6,
int value7)
Obtains an immutable array with seven values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4,
int value5,
int value6,
int value7,
int value8)
Obtains an immutable array with eight values.
|
static IntArray |
of(int value1,
int value2,
int value3,
int value4,
int value5,
int value6,
int value7,
int value8,
int... otherValues)
Obtains an immutable array with more than eight values.
|
static IntArray |
of(int size,
IntUnaryOperator valueFunction)
Obtains an instance with entries filled using a function.
|
static IntArray |
of(IntStream stream)
Obtains an instance with entries filled from a stream.
|
static IntArray |
ofUnsafe(int[] array)
Obtains an instance by wrapping an array.
|
IntArray |
plus(int amount)
Returns an instance with the specified amount added to each value.
|
IntArray |
plus(IntArray other)
Returns an instance where each element is the sum of the matching values
in this array and the other array.
|
int |
reduce(int identity,
IntBinaryOperator operator)
Reduces this array returning a single value.
|
int |
size()
Gets the size of this array.
|
IntArray |
sorted()
Returns a sorted copy of this array.
|
IntStream |
stream()
Returns a stream over the array values.
|
IntArray |
subArray(int fromIndexInclusive)
Returns an array holding the values from the specified index onwards.
|
IntArray |
subArray(int fromIndexInclusive,
int toIndexExclusive)
Returns an array holding the values between the specified from and to indices.
|
int |
sum()
Returns the sum of all the values in the array.
|
int[] |
toArray()
Converts this instance to an independent
int[]. |
int[] |
toArrayUnsafe()
Returns the underlying array.
|
List<Integer> |
toList()
Returns a list equivalent to this array.
|
String |
toString() |
IntArray |
with(int index,
int newValue)
Returns an instance with the value at the specified index changed.
|
public static final IntArray EMPTY
public static IntArray of()
public static IntArray of(int value)
value - the single valuepublic static IntArray of(int value1, int value2)
value1 - the first valuevalue2 - the second valuepublic static IntArray of(int value1, int value2, int value3)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuepublic static IntArray of(int value1, int value2, int value3, int value4)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuepublic static IntArray of(int value1, int value2, int value3, int value4, int value5)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuevalue5 - the fifth valuepublic static IntArray of(int value1, int value2, int value3, int value4, int value5, int value6)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuevalue5 - the fifth valuevalue6 - the sixth valuepublic static IntArray of(int value1, int value2, int value3, int value4, int value5, int value6, int value7)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuevalue5 - the fifth valuevalue6 - the sixth valuevalue7 - the seventh valuepublic static IntArray of(int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuevalue5 - the fifth valuevalue6 - the sixth valuevalue7 - the seventh valuevalue8 - the eighth valuepublic static IntArray of(int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8, int... otherValues)
value1 - the first valuevalue2 - the second valuevalue3 - the third valuevalue4 - the fourth valuevalue5 - the fifth valuevalue6 - the sixth valuevalue7 - the seventh valuevalue8 - the eighth valueotherValues - the other valuespublic static IntArray of(int size, IntUnaryOperator valueFunction)
The function is passed the array index and returns the value for that index.
size - the number of elementsvalueFunction - the function used to populate the valuepublic static IntArray of(IntStream stream)
The stream is converted to an array using IntStream.toArray().
stream - the stream of elementspublic static IntArray ofUnsafe(int[] array)
This method is inherently unsafe as it relies on good behavior by callers. Callers must never make any changes to the passed in array after calling this method. Doing so would violate the immutability of this class.
array - the array to assignpublic static IntArray copyOf(Collection<Integer> collection)
Integer.
The order of the values in the returned array is the order in which elements are returned from the iterator of the collection.
collection - the collection to initialize frompublic static IntArray copyOf(int[] array)
int.
The input array is copied and not mutated.
array - the array to copy, clonedpublic static IntArray copyOf(int[] array, int fromIndex)
The input array is copied and not mutated.
array - the array to copyfromIndex - the offset from the start of the arrayIndexOutOfBoundsException - if the index is invalidpublic static IntArray copyOf(int[] array, int fromIndexInclusive, int toIndexExclusive)
The input array is copied and not mutated.
array - the array to copyfromIndexInclusive - the start index of the input array to copy fromtoIndexExclusive - the end index of the input array to copy toIndexOutOfBoundsException - if the index is invalidpublic static IntArray filled(int size)
size - the number of elementspublic static IntArray filled(int size, int value)
size - the number of elementsvalue - the value of all the elementspublic int dimensions()
dimensions in interface Matrixpublic int size()
public boolean isEmpty()
public int get(int index)
index - the zero-based index to retrieveIndexOutOfBoundsException - if the index is invalidpublic boolean contains(int value)
value - the value to findpublic int indexOf(int value)
value - the value to findpublic int lastIndexOf(int value)
value - the value to findpublic void copyInto(int[] destination,
int offset)
The specified array must be at least as large as this array. If it is larger, then the remainder of the array will be untouched.
destination - the array to copy intooffset - the offset in the destination array to start fromIndexOutOfBoundsException - if the destination array is not large enough
or the offset is negativepublic IntArray subArray(int fromIndexInclusive)
fromIndexInclusive - the start index of the array to copy fromIndexOutOfBoundsException - if the index is invalidpublic IntArray subArray(int fromIndexInclusive, int toIndexExclusive)
fromIndexInclusive - the start index of the array to copy fromtoIndexExclusive - the end index of the array to copy toIndexOutOfBoundsException - if the index is invalidpublic int[] toArray()
int[].public int[] toArrayUnsafe()
This method is inherently unsafe as it relies on good behavior by callers. Callers must never make any changes to the array returned by this method. Doing so would violate the immutability of this class.
public List<Integer> toList()
public IntStream stream()
public void forEach(IntIntConsumer action)
This is used to perform an action on the contents of this array. The action receives both the index and the value. For example, the action could print out the array.
base.forEach((index, value) -> System.out.println(index + ": " + value));
This instance is immutable and unaffected by this method.
action - the action to be appliedpublic IntArray with(int index, int newValue)
This instance is immutable and unaffected by this method.
index - the zero-based index to setnewValue - the new value to storeIndexOutOfBoundsException - if the index is invalidpublic IntArray plus(int amount)
This is used to add to the contents of this array, returning a new array.
This is a special case of map(IntUnaryOperator).
This instance is immutable and unaffected by this method.
amount - the amount to add, may be negativepublic IntArray minus(int amount)
This is used to subtract from the contents of this array, returning a new array.
This is a special case of map(IntUnaryOperator).
This instance is immutable and unaffected by this method.
amount - the amount to subtract, may be negativepublic IntArray multipliedBy(int factor)
This is used to multiply the contents of this array, returning a new array.
This is a special case of map(IntUnaryOperator).
This instance is immutable and unaffected by this method.
factor - the multiplicative factorpublic IntArray dividedBy(int divisor)
This is used to divide the contents of this array, returning a new array.
This is a special case of map(IntUnaryOperator).
This instance is immutable and unaffected by this method.
divisor - the value by which the array values are dividedpublic IntArray map(IntUnaryOperator operator)
This is used to perform an operation on the contents of this array, returning a new array. The operator only receives the value. For example, the operator could multiply and add each element.
result = base.map(value -> value * 3 + 4);
This instance is immutable and unaffected by this method.
operator - the operator to be appliedpublic IntArray mapWithIndex(IntBinaryOperator function)
This is used to perform an operation on the contents of this array, returning a new array. The function receives both the index and the value. For example, the operator could multiply the value by the index.
result = base.mapWithIndex((index, value) -> index * value);
This instance is immutable and unaffected by this method.
function - the function to be appliedpublic IntArray plus(IntArray other)
This is used to add two arrays, returning a new array.
Element n in the resulting array is equal to element n in this array
plus element n in the other array.
The arrays must be of the same size.
This is a special case of combine(IntArray, IntBinaryOperator).
This instance is immutable and unaffected by this method.
other - the other arrayIllegalArgumentException - if the arrays have different sizespublic IntArray minus(IntArray other)
This is used to subtract the second array from the first, returning a new array.
Element n in the resulting array is equal to element n in this array
minus element n in the other array.
The arrays must be of the same size.
This is a special case of combine(IntArray, IntBinaryOperator).
This instance is immutable and unaffected by this method.
other - the other arrayIllegalArgumentException - if the arrays have different sizespublic IntArray multipliedBy(IntArray other)
This is used to multiply each value in this array by the corresponding value in the other array, returning a new array.
Element n in the resulting array is equal to element n in this array
multiplied by element n in the other array.
The arrays must be of the same size.
This is a special case of combine(IntArray, IntBinaryOperator).
This instance is immutable and unaffected by this method.
other - the other arrayIllegalArgumentException - if the arrays have different sizespublic IntArray dividedBy(IntArray other)
This is used to divide each value in this array by the corresponding value in the other array, returning a new array.
Element n in the resulting array is equal to element n in this array
divided by element n in the other array.
The arrays must be of the same size.
This is a special case of combine(IntArray, IntBinaryOperator).
This instance is immutable and unaffected by this method.
other - the other arrayIllegalArgumentException - if the arrays have different sizespublic IntArray combine(IntArray other, IntBinaryOperator operator)
This is used to combine two arrays, returning a new array.
Element n in the resulting array is equal to the result of the operator
when applied to element n in this array and element n in the other array.
The arrays must be of the same size.
This instance is immutable and unaffected by this method.
other - the other arrayoperator - the operator used to combine each pair of valuesIllegalArgumentException - if the arrays have different sizespublic int combineReduce(IntArray other, IntTernaryOperator operator)
This is used to combine two arrays, returning a single reduced value. The operator is called once for each element in the arrays. The arrays must be of the same size.
The first argument to the operator is the running total of the reduction, starting from zero. The second argument to the operator is the element from this array. The third argument to the operator is the element from the other array.
This instance is immutable and unaffected by this method.
other - the other arrayoperator - the operator used to combine each pair of values with the current totalIllegalArgumentException - if the arrays have different sizespublic IntArray concat(int... arrayToConcat)
The result will have a length equal to this.size() + arrayToConcat.length.
This instance is immutable and unaffected by this method.
arrayToConcat - the array to add to the end of this arrayIndexOutOfBoundsException - if the index is invalidpublic IntArray concat(IntArray arrayToConcat)
The result will have a length equal to this.size() + newArray.length.
This instance is immutable and unaffected by this method.
arrayToConcat - the new array to add to the end of this arrayIndexOutOfBoundsException - if the index is invalidpublic IntArray sorted()
This uses Arrays.sort(int[]).
This instance is immutable and unaffected by this method.
public int min()
If the array is empty, then an exception is thrown. If the array contains NaN, then the result is NaN.
IllegalStateException - if the array is emptypublic int max()
If the array is empty, then an exception is thrown. If the array contains NaN, then the result is NaN.
IllegalStateException - if the array is emptypublic int sum()
This is a special case of reduce(int, IntBinaryOperator).
public int reduce(int identity,
IntBinaryOperator operator)
This is used to reduce the values in this array to a single value. The operator is called once for each element in the arrays. The first argument to the operator is the running total of the reduction, starting from zero. The second argument to the operator is the element.
This instance is immutable and unaffected by this method.
identity - the identity value to start fromoperator - the operator used to combine the value with the current totalpublic org.joda.beans.MetaBean metaBean()
metaBean in interface org.joda.beans.BeanCopyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.