Class DoubleArray
- java.lang.Object
-
- com.opengamma.strata.collect.array.DoubleArray
-
- All Implemented Interfaces:
Matrix
,Serializable
,org.joda.beans.Bean
,org.joda.beans.ImmutableBean
public final class DoubleArray extends Object implements Matrix, org.joda.beans.ImmutableBean, Serializable
An immutable array ofdouble
values.This provides functionality similar to
List
but fordouble[]
.In mathematical terms, this is a vector, or one-dimensional matrix.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static DoubleArray
EMPTY
An empty array.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DoubleArray
combine(DoubleArray other, DoubleBinaryOperator operator)
Returns an instance where each element is formed by some combination of the matching values in this array and the other array.double
combineReduce(DoubleArray other, DoubleTernaryOperator operator)
Combines this array and the other array returning a reduced value.DoubleArray
concat(double... arrayToConcat)
Returns an array that combines this array and the specified array.DoubleArray
concat(DoubleArray arrayToConcat)
Returns an array that combines this array and the specified array.boolean
contains(double value)
Checks if this array contains the specified value.void
copyInto(double[] destination, int offset)
Copies this array into the specified array.static DoubleArray
copyOf(double[] array)
Obtains an instance from an array ofdouble
.static DoubleArray
copyOf(double[] array, int fromIndex)
Obtains an instance by copying part of an array.static DoubleArray
copyOf(double[] array, int fromIndexInclusive, int toIndexExclusive)
Obtains an instance by copying part of an array.static DoubleArray
copyOf(Collection<Double> collection)
Obtains an instance from a collection ofDouble
.int
dimensions()
Gets the number of dimensions of this array.DoubleArray
dividedBy(double divisor)
Returns an instance with each value divided by the specified divisor.DoubleArray
dividedBy(DoubleArray 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)
boolean
equalWithTolerance(DoubleArray other, double tolerance)
Checks if this array equals another within the specified tolerance.boolean
equalZeroWithTolerance(double tolerance)
Checks if this array equals zero within the specified tolerance.static DoubleArray
filled(int size)
Obtains an instance with all entries equal to the zero.static DoubleArray
filled(int size, double value)
Obtains an instance with all entries equal to the same value.void
forEach(IntDoubleConsumer action)
Applies an action to each value in the array.double
get(int index)
Gets the value at the specified index in this array.int
hashCode()
int
indexOf(double value)
Find the index of the first occurrence of the specified value.boolean
isEmpty()
Checks if this array is empty.int
lastIndexOf(double value)
Find the index of the first occurrence of the specified value.DoubleArray
map(DoubleUnaryOperator operator)
Returns an instance with an operation applied to each value in the array.DoubleArray
mapWithIndex(IntDoubleToDoubleFunction function)
Returns an instance with an operation applied to each indexed value in the array.double
max()
Returns the minimum value held in the array.org.joda.beans.MetaBean
metaBean()
double
min()
Returns the minimum value held in the array.DoubleArray
minus(double amount)
Returns an instance with the specified amount subtracted from each value.DoubleArray
minus(DoubleArray other)
Returns an instance where each element is equal to the difference between the matching values in this array and the other array.DoubleArray
multipliedBy(double factor)
Returns an instance with each value multiplied by the specified factor.DoubleArray
multipliedBy(DoubleArray other)
Returns an instance where each element is equal to the product of the matching values in this array and the other array.static DoubleArray
of()
Obtains an empty immutable array.static DoubleArray
of(double value)
Obtains an immutable array with a single value.static DoubleArray
of(double value1, double value2)
Obtains an immutable array with two values.static DoubleArray
of(double value1, double value2, double value3)
Obtains an immutable array with three values.static DoubleArray
of(double value1, double value2, double value3, double value4)
Obtains an immutable array with four values.static DoubleArray
of(double value1, double value2, double value3, double value4, double value5)
Obtains an immutable array with five values.static DoubleArray
of(double value1, double value2, double value3, double value4, double value5, double value6)
Obtains an immutable array with six values.static DoubleArray
of(double value1, double value2, double value3, double value4, double value5, double value6, double value7)
Obtains an immutable array with seven values.static DoubleArray
of(double value1, double value2, double value3, double value4, double value5, double value6, double value7, double value8)
Obtains an immutable array with eight values.static DoubleArray
of(double value1, double value2, double value3, double value4, double value5, double value6, double value7, double value8, double... otherValues)
Obtains an immutable array with more than eight values.static DoubleArray
of(int size, IntToDoubleFunction valueFunction)
Obtains an instance with entries filled using a function.static DoubleArray
of(DoubleStream stream)
Obtains an instance with entries filled from a stream.static DoubleArray
ofUnsafe(double[] array)
Obtains an instance by wrapping an array.DoubleArray
plus(double amount)
Returns an instance with the specified amount added to each value.DoubleArray
plus(DoubleArray other)
Returns an instance where each element is the sum of the matching values in this array and the other array.double
reduce(double identity, DoubleBinaryOperator operator)
Reduces this array returning a single value.int
size()
Gets the size of this array.DoubleArray
sorted()
Returns a sorted copy of this array.DoubleStream
stream()
Returns a stream over the array values.DoubleArray
subArray(int fromIndexInclusive)
Returns an array holding the values from the specified index onwards.DoubleArray
subArray(int fromIndexInclusive, int toIndexExclusive)
Returns an array holding the values between the specified from and to indices.double
sum()
Returns the sum of all the values in the array.double[]
toArray()
Converts this instance to an independentdouble[]
.double[]
toArrayUnsafe()
Returns the underlying array.List<Double>
toList()
Returns a list equivalent to this array.String
toString()
DoubleArray
with(int index, double newValue)
Returns an instance with the value at the specified index changed.
-
-
-
Field Detail
-
EMPTY
public static final DoubleArray EMPTY
An empty array.
-
-
Method Detail
-
of
public static DoubleArray of()
Obtains an empty immutable array.- Returns:
- the empty immutable array
-
of
public static DoubleArray of(double value)
Obtains an immutable array with a single value.- Parameters:
value
- the single value- Returns:
- an array containing the specified value
-
of
public static DoubleArray of(double value1, double value2)
Obtains an immutable array with two values.- Parameters:
value1
- the first valuevalue2
- the second value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3)
Obtains an immutable array with three values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4)
Obtains an immutable array with four values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third valuevalue4
- the fourth value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4, double value5)
Obtains an immutable array with five values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third valuevalue4
- the fourth valuevalue5
- the fifth value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4, double value5, double value6)
Obtains an immutable array with six values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third valuevalue4
- the fourth valuevalue5
- the fifth valuevalue6
- the sixth value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4, double value5, double value6, double value7)
Obtains an immutable array with seven values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third valuevalue4
- the fourth valuevalue5
- the fifth valuevalue6
- the sixth valuevalue7
- the seventh value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4, double value5, double value6, double value7, double value8)
Obtains an immutable array with eight values.- Parameters:
value1
- the first valuevalue2
- the second valuevalue3
- the third valuevalue4
- the fourth valuevalue5
- the fifth valuevalue6
- the sixth valuevalue7
- the seventh valuevalue8
- the eighth value- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(double value1, double value2, double value3, double value4, double value5, double value6, double value7, double value8, double... otherValues)
Obtains an immutable array with more than eight values.- Parameters:
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 values- Returns:
- an array containing the specified values
-
of
public static DoubleArray of(int size, IntToDoubleFunction valueFunction)
Obtains an instance with entries filled using a function.The function is passed the array index and returns the value for that index.
- Parameters:
size
- the number of elementsvalueFunction
- the function used to populate the value- Returns:
- an array initialized using the function
-
of
public static DoubleArray of(DoubleStream stream)
Obtains an instance with entries filled from a stream.The stream is converted to an array using
DoubleStream.toArray()
.- Parameters:
stream
- the stream of elements- Returns:
- an array initialized using the stream
-
ofUnsafe
public static DoubleArray ofUnsafe(double[] array)
Obtains an instance by wrapping an 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.
- Parameters:
array
- the array to assign- Returns:
- an array instance wrapping the specified array
-
copyOf
public static DoubleArray copyOf(Collection<Double> collection)
Obtains an instance from a collection ofDouble
.The order of the values in the returned array is the order in which elements are returned from the iterator of the collection.
- Parameters:
collection
- the collection to initialize from- Returns:
- an array containing the values from the collection in iteration order
-
copyOf
public static DoubleArray copyOf(double[] array)
Obtains an instance from an array ofdouble
.The input array is copied and not mutated.
- Parameters:
array
- the array to copy, cloned- Returns:
- an array containing the specified values
-
copyOf
public static DoubleArray copyOf(double[] array, int fromIndex)
Obtains an instance by copying part of an array.The input array is copied and not mutated.
- Parameters:
array
- the array to copyfromIndex
- the offset from the start of the array- Returns:
- an array containing the specified values
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
copyOf
public static DoubleArray copyOf(double[] array, int fromIndexInclusive, int toIndexExclusive)
Obtains an instance by copying part of an array.The input array is copied and not mutated.
- Parameters:
array
- the array to copyfromIndexInclusive
- the start index of the input array to copy fromtoIndexExclusive
- the end index of the input array to copy to- Returns:
- an array containing the specified values
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
filled
public static DoubleArray filled(int size)
Obtains an instance with all entries equal to the zero.- Parameters:
size
- the number of elements- Returns:
- an array filled with zeroes
-
filled
public static DoubleArray filled(int size, double value)
Obtains an instance with all entries equal to the same value.- Parameters:
size
- the number of elementsvalue
- the value of all the elements- Returns:
- an array filled with the specified value
-
dimensions
public int dimensions()
Gets the number of dimensions of this array.- Specified by:
dimensions
in interfaceMatrix
- Returns:
- one
-
size
public int size()
Gets the size of this array.
-
isEmpty
public boolean isEmpty()
Checks if this array is empty.- Returns:
- true if empty
-
get
public double get(int index)
Gets the value at the specified index in this array.- Parameters:
index
- the zero-based index to retrieve- Returns:
- the value at the index
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
contains
public boolean contains(double value)
Checks if this array contains the specified value.The value is checked using
Double.doubleToLongBits
in order to matchequals
. This also allow this method to be used to find any occurrences of NaN.- Parameters:
value
- the value to find- Returns:
- true if the value is contained in this array
-
indexOf
public int indexOf(double value)
Find the index of the first occurrence of the specified value.The value is checked using
Double.doubleToLongBits
in order to matchequals
. This also allow this method to be used to find any occurrences of NaN.- Parameters:
value
- the value to find- Returns:
- the index of the value, -1 if not found
-
lastIndexOf
public int lastIndexOf(double value)
Find the index of the first occurrence of the specified value.The value is checked using
Double.doubleToLongBits
in order to matchequals
. This also allow this method to be used to find any occurrences of NaN.- Parameters:
value
- the value to find- Returns:
- the index of the value, -1 if not found
-
copyInto
public void copyInto(double[] destination, int offset)
Copies this array into the specified array.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.
- Parameters:
destination
- the array to copy intooffset
- the offset in the destination array to start from- Throws:
IndexOutOfBoundsException
- if the destination array is not large enough or the offset is negative
-
subArray
public DoubleArray subArray(int fromIndexInclusive)
Returns an array holding the values from the specified index onwards.- Parameters:
fromIndexInclusive
- the start index of the array to copy from- Returns:
- an array instance with the specified bounds
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
subArray
public DoubleArray subArray(int fromIndexInclusive, int toIndexExclusive)
Returns an array holding the values between the specified from and to indices.- Parameters:
fromIndexInclusive
- the start index of the array to copy fromtoIndexExclusive
- the end index of the array to copy to- Returns:
- an array instance with the specified bounds
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
toArray
public double[] toArray()
Converts this instance to an independentdouble[]
.- Returns:
- a copy of the underlying array
-
toArrayUnsafe
public double[] toArrayUnsafe()
Returns the underlying array.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.
- Returns:
- the raw array
-
toList
public List<Double> toList()
Returns a list equivalent to this array.- Returns:
- a list wrapping this array
-
stream
public DoubleStream stream()
Returns a stream over the array values.- Returns:
- a stream over the values in the array
-
forEach
public void forEach(IntDoubleConsumer action)
Applies an action to each value in the array.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.
- Parameters:
action
- the action to be applied
-
with
public DoubleArray with(int index, double newValue)
Returns an instance with the value at the specified index changed.This instance is immutable and unaffected by this method.
- Parameters:
index
- the zero-based index to setnewValue
- the new value to store- Returns:
- a copy of this array with the value at the index changed
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
plus
public DoubleArray plus(double amount)
Returns an instance with the specified amount added to each value.This is used to add to the contents of this array, returning a new array.
This is a special case of
map(DoubleUnaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
amount
- the amount to add, may be negative- Returns:
- a copy of this array with the amount added to each value
-
minus
public DoubleArray minus(double amount)
Returns an instance with the specified amount subtracted from each value.This is used to subtract from the contents of this array, returning a new array.
This is a special case of
map(DoubleUnaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
amount
- the amount to subtract, may be negative- Returns:
- a copy of this array with the amount subtracted from each value
-
multipliedBy
public DoubleArray multipliedBy(double factor)
Returns an instance with each value multiplied by the specified factor.This is used to multiply the contents of this array, returning a new array.
This is a special case of
map(DoubleUnaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
factor
- the multiplicative factor- Returns:
- a copy of this array with the each value multiplied by the factor
-
dividedBy
public DoubleArray dividedBy(double divisor)
Returns an instance with each value divided by the specified divisor.This is used to divide the contents of this array, returning a new array.
This is a special case of
map(DoubleUnaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
divisor
- the value by which the array values are divided- Returns:
- a copy of this array with the each value divided by the divisor
-
map
public DoubleArray map(DoubleUnaryOperator operator)
Returns an instance with an operation applied to each value in the array.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 take the inverse of each element.
result = base.map(value -> 1 / value);
This instance is immutable and unaffected by this method.
- Parameters:
operator
- the operator to be applied- Returns:
- a copy of this array with the operator applied to the original values
-
mapWithIndex
public DoubleArray mapWithIndex(IntDoubleToDoubleFunction function)
Returns an instance with an operation applied to each indexed value in the array.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.
- Parameters:
function
- the function to be applied- Returns:
- a copy of this array with the operator applied to the original values
-
plus
public DoubleArray plus(DoubleArray other)
Returns an instance where each element is the sum of the matching values in this array and the other array.This is used to add two arrays, returning a new array. Element
n
in the resulting array is equal to elementn
in this array plus elementn
in the other array. The arrays must be of the same size.This is a special case of
combine(DoubleArray, DoubleBinaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
other
- the other array- Returns:
- a copy of this array with matching elements added
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
minus
public DoubleArray minus(DoubleArray other)
Returns an instance where each element is equal to the difference between the matching values in this array and the other array.This is used to subtract the second array from the first, returning a new array. Element
n
in the resulting array is equal to elementn
in this array minus elementn
in the other array. The arrays must be of the same size.This is a special case of
combine(DoubleArray, DoubleBinaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
other
- the other array- Returns:
- a copy of this array with matching elements subtracted
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
multipliedBy
public DoubleArray multipliedBy(DoubleArray other)
Returns an instance where each element is equal to the product of the matching values in this array and the other array.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 elementn
in this array multiplied by elementn
in the other array. The arrays must be of the same size.This is a special case of
combine(DoubleArray, DoubleBinaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
other
- the other array- Returns:
- a copy of this array with matching elements multiplied
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
dividedBy
public DoubleArray dividedBy(DoubleArray other)
Returns an instance where each element is calculated by dividing values in this array by values in the other array.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 elementn
in this array divided by elementn
in the other array. The arrays must be of the same size.This is a special case of
combine(DoubleArray, DoubleBinaryOperator)
. This instance is immutable and unaffected by this method.- Parameters:
other
- the other array- Returns:
- a copy of this array with matching elements divided
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
combine
public DoubleArray combine(DoubleArray other, DoubleBinaryOperator operator)
Returns an instance where each element is formed by some combination of the matching values in this array and the other array.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 elementn
in this array and elementn
in the other array. The arrays must be of the same size.This instance is immutable and unaffected by this method.
- Parameters:
other
- the other arrayoperator
- the operator used to combine each pair of values- Returns:
- a copy of this array combined with the specified array
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
combineReduce
public double combineReduce(DoubleArray other, DoubleTernaryOperator operator)
Combines this array and the other array returning a reduced value.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.
- Parameters:
other
- the other arrayoperator
- the operator used to combine each pair of values with the current total- Returns:
- the result of the reduction
- Throws:
IllegalArgumentException
- if the arrays have different sizes
-
concat
public DoubleArray concat(double... arrayToConcat)
Returns an array that combines this array and the specified array.The result will have a length equal to
this.size() + arrayToConcat.length
.This instance is immutable and unaffected by this method.
- Parameters:
arrayToConcat
- the array to add to the end of this array- Returns:
- a copy of this array with the specified array added at the end
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
concat
public DoubleArray concat(DoubleArray arrayToConcat)
Returns an array that combines this array and the specified array.The result will have a length equal to
this.size() + newArray.length
.This instance is immutable and unaffected by this method.
- Parameters:
arrayToConcat
- the new array to add to the end of this array- Returns:
- a copy of this array with the specified array added at the end
- Throws:
IndexOutOfBoundsException
- if the index is invalid
-
sorted
public DoubleArray sorted()
Returns a sorted copy of this array.This uses
Arrays.sort(double[])
.This instance is immutable and unaffected by this method.
- Returns:
- a sorted copy of this array
-
min
public double min()
Returns the minimum value held in the array.If the array is empty, then an exception is thrown. If the array contains NaN, then the result is NaN.
- Returns:
- the minimum value
- Throws:
IllegalStateException
- if the array is empty
-
max
public double max()
Returns the minimum value held in the array.If the array is empty, then an exception is thrown. If the array contains NaN, then the result is NaN.
- Returns:
- the maximum value
- Throws:
IllegalStateException
- if the array is empty
-
sum
public double sum()
Returns the sum of all the values in the array.This is a special case of
reduce(double, DoubleBinaryOperator)
.- Returns:
- the total of all the values
-
reduce
public double reduce(double identity, DoubleBinaryOperator operator)
Reduces this array returning a single value.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.
- Parameters:
identity
- the identity value to start fromoperator
- the operator used to combine the value with the current total- Returns:
- the result of the reduction
-
metaBean
public org.joda.beans.MetaBean metaBean()
- Specified by:
metaBean
in interfaceorg.joda.beans.Bean
-
equalWithTolerance
public boolean equalWithTolerance(DoubleArray other, double tolerance)
Checks if this array equals another within the specified tolerance.This returns true if the two instances have
double
values that are equal within the specified tolerance.- Parameters:
other
- the other arraytolerance
- the tolerance- Returns:
- true if equal up to the tolerance
-
equalZeroWithTolerance
public boolean equalZeroWithTolerance(double tolerance)
Checks if this array equals zero within the specified tolerance.This returns true if all the
double
values equal zero within the specified tolerance.- Parameters:
tolerance
- the tolerance- Returns:
- true if equal up to the tolerance
-
-