ParallelArray (org.codehaus.gpars)

groovyx.gpars.extra166y.ParallelArray

All Implemented Interfaces and Traits:

java.lang.Iterable
```
public class ParallelArray
extends OUPap
```
An array supporting parallel operations.
A ParallelArray maintains a java.util.concurrent.ForkJoinPool and an array in order to provide parallel aggregate operations. The main operations are to apply some procedure to each element, to map each element to a new element, to replace each element, to select a subset of elements based on matching a predicate or ranges of indices, and to reduce all elements into a single value such as a sum.
A ParallelArray is constructed by allocating, using, or copying an array, using one of the static factory methods create, createEmpty, createUsingHandoff and createFromCopy. Upon construction, the encapsulated array managed by the ParallelArray must not be shared between threads without external synchronization. In particular, as is the case with any array, access by another thread of an element of a ParallelArray while another operation is in progress has undefined effects.
The ForkJoinPool used to construct a ParallelArray can be shared safely by other threads (and used in other ParallelArrays). To avoid the overhead associated with creating multiple executors, it is often a good idea to use the defaultExecutor() across all ParallelArrays. However, you might choose to use different ones for the sake of controlling processor usage, isolating faults, and/or ensuring progress.
A ParallelArray is not a List. It relies on random access across array elements to support efficient parallel operations. However, a ParallelArray can be viewed and manipulated as a List, via method ParallelArray.asList. The asList view allows incremental insertion and modification of elements while setting up a ParallelArray, generally before using it for parallel operations. Similarly, the list view may be useful when accessing the results of computations in sequential contexts. A ParallelArray may also be created using the elements of any other Collection, by constructing from the array returned by the Collection's toArray method. The effects of mutative asList operations may also be achieved directly using method setLimit along with element-by-element access methods get and set.
While ParallelArrays can be based on any kind of an object array, including "boxed" types such as Long, parallel operations on scalar "unboxed" type are likely to be substantially more efficient. For this reason, classes ParallelLongArray and ParallelDoubleArray are also supplied, and designed to smoothly interoperate with ParallelArrays. You should also use a ParallelLongArray for processing other integral scalar data (int, short, etc). And similarly use a ParallelDoubleArray for float data. (Further specializations for these other types would add clutter without significantly improving performance beyond that of the Long and Double versions.)
Most usages of ParallelArray involve sets of operations prefixed with range bounds, filters, and mappings (including mappings that combine elements from other ParallelArrays), using withBounds, withFilter, and withMapping, respectively. For example, aParallelArray.withFilter(aPredicate).all() creates a new ParallelArray containing only those elements matching the predicate. And for ParallelLongArrays a, b, and c, a.withMapping(CommonOps.longAdder(),b).withMapping(CommonOps.longAdder(),c).min() returns the minimum value of a[i]+b[i]+c[i] for all i. As illustrated below, a mapping often represents accessing some field or invoking some method of an element. These versions are typically more efficient than performing selections, then mappings, then other operations in multiple (parallel) steps. The basic ideas and usages of filtering and mapping are similar to those in database query systems such as SQL, but take a more restrictive form. Series of filter and mapping prefixes may each be cascaded, but all filter prefixes must precede all mapping prefixes, to ensure efficient execution in a single parallel step. In cases of combined mapping expressions, this rule is only dynamically enforced. For example, pa.withMapping(op, pb.withFilter(f)) will compile but throw an exception upon execution because the filter precedes the mapping.
While series of filters and mappings are allowed, it is usually more efficient to combine them into single filters or mappings when possible. For example pa.withMapping(addOne).withMapping(addOne) is generally less efficient than pa.withMapping(addTwo). Methods withIndexedFilter and withIndexedMapping may be useful when combining such expressions.
This class includes some reductions, such as min, that are commonly useful for most element types, as well as a combined version, summary, that computes all of them in a single parallel step, which is normally more efficient than computing each in turn.
The methods in this class are designed to perform efficiently with both large and small pools, even with single-thread pools on uniprocessors. However, there is some overhead in parallelizing operations, so short computations on small arrays might not execute faster than sequential versions, and might even be slower.
Sample usages. The main difference between programming with plain arrays and programming with aggregates is that you must separately define each of the component functions on elements. For example, the following returns the maximum Grade Point Average across all senior students, given a (fictional) Student class:
```
 import static Ops.*;
 class StudentStatistics {
   ParallelArray<Student> students = ...
   // ...
   public double getMaxSeniorGpa() {
     return students.withFilter(isSenior).withMapping(gpaField).max();
   }

   // helpers:
   static final class IsSenior implements Predicate<Student> {
     public boolean op(Student s) { return s.credits > 90; }
   }
   static final IsSenior isSenior = new IsSenior();
   static final class GpaField implements ObjectToDouble<Student> {
     public double op(Student s) { return s.gpa; }
   }
   static final GpaField gpaField = new GpaField();
 }
 
```

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`ParallelArray.AsList`
`class`	`ParallelArray.ListIter`
`static class`	`ParallelArray.ParallelArrayIterator`
`static interface`	`ParallelArray.SummaryStatistics`	Summary statistics for a possibly bounded, filtered, and/or mapped ParallelArray.

Field Summary

Fields
Modifiers	Name	Description
`ParallelArray.AsList`	`listView`	Lazily constructed list view

Constructor Summary

Constructors
Constructor and description
`protected ParallelArray (java.util.concurrent.ForkJoinPool executor, T[] array, int limit)` Constructor for use by subclasses to create a new ParallelArray using the given executor, and initially using the supplied array, with effective size bound by the given limit.
`ParallelArray (java.util.concurrent.ForkJoinPool executor, T[] array)` Trusted internal version of protected constructor.

Methods Summary

Methods
Type	Name and description
`ParallelArray<T>`	`addAll(T[] other)` Equivalent to `asList().addAll` but specialized for array arguments and likely to be more efficient.
`ParallelArray<T>`	`addAll(ParallelArrayWithMapping<V, T> other)` Appends all (possibly bounded, filtered, or mapped) elements of the given ParallelArray, resizing and/or reallocating this array if necessary.
`ParallelArray<T>`	`all()` Returns a new ParallelArray holding all elements.
`ParallelArray<T>`	`all(java.lang.Class<? super T> elementType)` Returns a new ParallelArray with the given element type holding all elements.
`ParallelArray<T>`	`allNonidenticalElements()` Returns a new ParallelArray containing only the non-null unique elements of this array (that is, without any duplicates), using reference identity to test for duplication.
`ParallelArray<T>`	`allUniqueElements()` Returns a new ParallelArray containing only the non-null unique elements of this array (that is, without any duplicates), using each element's `equals` method to test for duplication.
`void`	`appendElement(T e)`
`void`	`apply(Procedure<? super T> procedure)` Applies the given procedure to elements.
`java.util.List<T>`	`asList()` Returns a view of this ParallelArray as a List.
`int`	`binarySearch(T target)` Assuming this array is sorted, returns the index of an element equal to given target, or -1 if not present.
`int`	`binarySearch(T target, java.util.Comparator<? super T> comparator)` Assuming this array is sorted with respect to the given comparator, returns the index of an element equal to given target, or -1 if not present.
`static ParallelArray<T>`	`create(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)` Creates a new ParallelArray using the given executor and an array of the given size constructed using the indicated base element type.
`static ParallelArray<T>`	`createEmpty(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)` Creates a new ParallelArray using the given executor and an array of the given size constructed using the indicated base element type, but with an initial effective size of zero, enabling incremental insertion via ParallelArray.asList operations.
`static ParallelArray<T>`	`createFromCopy(T[] source, java.util.concurrent.ForkJoinPool executor)` Creates a new ParallelArray using the given executor and initially holding copies of the given source elements.
`static ParallelArray<T>`	`createFromCopy(int size, T[] source, java.util.concurrent.ForkJoinPool executor)` Creates a new ParallelArray using an array of the given size, initially holding copies of the given source truncated or padded with nulls to obtain the specified length.
`static ParallelArray<T>`	`createUsingHandoff(T[] handoff, java.util.concurrent.ForkJoinPool executor)` Creates a new ParallelArray initially using the given array and executor.
`ParallelArray<T>`	`cumulate(Reducer<T> reducer, T base)` Replaces each element with the running cumulation of applying the given reducer.
`static java.util.concurrent.ForkJoinPool`	`defaultExecutor()` Returns a common default executor for use in ParallelArrays.
`T`	`get(int i)` Returns the element of the array at the given index.
`T[]`	`getArray()` Returns the underlying array used for computations.
`java.util.concurrent.ForkJoinPool`	`getExecutor()` Returns the executor used for computations.
`boolean`	`hasAllEqualElements(ParallelArrayWithMapping<U, V> other)` Returns true if all elements at the same relative positions of this and other array are equal.
`boolean`	`hasAllIdenticalElements(ParallelArrayWithMapping<U, V> other)` Returns true if all elements at the same relative positions of this and other array are identical.
`int`	`indexOf(T target)` Returns the index of some element equal to given target, or -1 if not present.
`void`	`insertElementAt(int index, T e)`
`void`	`insertSlotsAt(int index, int len)` Makes len slots available at index.
`java.util.Iterator<T>`	`iterator()` Returns an iterator stepping through each element of the array up to the current limit.
`T`	`max(java.util.Comparator<? super T> comparator)` Returns the maximum element, or null if empty.
`T`	`max()` Returns the maximum element, or null if empty, assuming that all elements are Comparables.
`T`	`min(java.util.Comparator<? super T> comparator)` Returns the minimum element, or null if empty.
`T`	`min()` Returns the minimum element, or null if empty, assuming that all elements are Comparables.
`T`	`precumulate(Reducer<T> reducer, T base)` Replaces each element with the cumulation of applying the given reducer to all previous values, and returns the total reduction.
`T`	`reduce(Reducer<T> reducer, T base)` Returns reduction of elements.
`ParallelArray<T>`	`removeAll(Predicate<? super T> selector)` Removes from the array all elements for which the given selector holds.
`ParallelArray<T>`	`removeConsecutiveDuplicates()` Removes consecutive elements that are equal (or null), shifting others leftward, and possibly decreasing size.
`ParallelArray<T>`	`removeNulls()` Removes null elements, shifting others leftward, and possibly decreasing size.
`void`	`removeSlotAt(int index)`
`void`	`removeSlotsAt(int fromIndex, int toIndex)`
`void`	`replaceElementsWith(T[] a)`
`ParallelArray<T>`	`replaceWithGeneratedValue(Generator<? extends T> generator)` Replaces elements with the results of applying the given generator.
`ParallelArray<T>`	`replaceWithMappedIndex(IntToObject<? extends T> op)` Replaces elements with the results of applying the given mapping to their indices.
`ParallelArray<T>`	`replaceWithMappedIndex(IntAndObjectToObject<? super T, ? extends T> op)` Replaces elements with the results of applying the given mapping to each index and current element value.
`ParallelArray<T>`	`replaceWithMapping(Op<? super T, ? extends T> op)` Replaces elements with the results of applying the given transform to their current values.
`ParallelArray<T>`	`replaceWithMapping(BinaryOp<? super T, ? super V, ? extends T> combiner, ParallelArrayWithMapping<W, V> other)` Replaces elements with results of applying `op(thisElement, otherElement)`.
`ParallelArray<T>`	`replaceWithMapping(BinaryOp<T, T, T> combiner, T[] other)` Replaces elements with results of applying `op(thisElement, otherElement)`.
`ParallelArray<T>`	`replaceWithValue(T value)` Replaces elements with the given value.
`void`	`resizeArray(int newCap)`
`int`	`seqIndexOf(java.lang.Object target)`
`int`	`seqLastIndexOf(java.lang.Object target)`
`void`	`set(int i, T x)` Sets the element of the array at the given index to the given value.
`void`	`setLimit(int newLimit)` Ensures that the underlying array can be accessed up to the given upper bound, reallocating and copying the underlying array to expand if necessary.
`int`	`size()` Returns the effective size of the underlying array.
`ParallelArray<T>`	`sort(java.util.Comparator<? super T> comparator)` Sorts the array.
`ParallelArray<T>`	`sort()` Sorts the array, assuming all elements are Comparable.
`groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T>`	`summary(java.util.Comparator<? super T> comparator)` Returns summary statistics, using the given comparator to locate minimum and maximum elements.
`groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T>`	`summary()` Returns summary statistics, assuming that all elements are Comparables.
`java.lang.String`	`toString()` Equivalent to `asList().toString()`.
`ParallelArrayWithBounds<T>`	`withBounds(int firstIndex, int upperBound)` Returns an operation prefix that causes a method to operate only on the elements of the array between firstIndex (inclusive) and upperBound (exclusive).
`ParallelArrayWithFilter<T>`	`withFilter(Predicate<? super T> selector)` Returns an operation prefix that causes a method to operate only on the elements of the array for which the given selector returns true.
`ParallelArrayWithFilter<T>`	`withFilter(BinaryPredicate<? super T, ? super V> selector, ParallelArrayWithMapping<W, V> other)` Returns an operation prefix that causes a method to operate only on elements for which the given binary selector returns true.
`ParallelArrayWithFilter<T>`	`withIndexedFilter(IntAndObjectPredicate<? super T> selector)` Returns an operation prefix that causes a method to operate only on elements for which the given indexed selector returns true.
`ParallelArrayWithMapping<T, U>`	`withIndexedMapping(IntAndObjectToObject<? super T, ? extends U> mapper)` Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value.
`ParallelArrayWithDoubleMapping<T>`	`withIndexedMapping(IntAndObjectToDouble<? super T> mapper)` Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value.
`ParallelArrayWithLongMapping<T>`	`withIndexedMapping(IntAndObjectToLong<? super T> mapper)` Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value.
`ParallelArrayWithMapping<T, U>`	`withMapping(Op<? super T, ? extends U> op)` Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
`ParallelArrayWithDoubleMapping<T>`	`withMapping(ObjectToDouble<? super T> op)` Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
`ParallelArrayWithLongMapping<T>`	`withMapping(ObjectToLong<? super T> op)` Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
`ParallelArrayWithMapping<T, V>`	`withMapping(BinaryOp<? super T, ? super U, ? extends V> combiner, ParallelArrayWithMapping<W, U> other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithMapping<T, V>`	`withMapping(ObjectAndDoubleToObject<? super T, ? extends V> combiner, ParallelDoubleArrayWithDoubleMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithMapping<T, V>`	`withMapping(ObjectAndLongToObject<? super T, ? extends V> combiner, ParallelLongArrayWithLongMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithDoubleMapping<T>`	`withMapping(ObjectAndObjectToDouble<? super T, ? super U> combiner, ParallelArrayWithMapping<W, U> other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithDoubleMapping<T>`	`withMapping(ObjectAndDoubleToDouble<? super T> combiner, ParallelDoubleArrayWithDoubleMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithDoubleMapping<T>`	`withMapping(ObjectAndLongToDouble<? super T> combiner, ParallelLongArrayWithLongMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithLongMapping<T>`	`withMapping(ObjectAndObjectToLong<? super T, ? super U> combiner, ParallelArrayWithMapping<W, U> other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithLongMapping<T>`	`withMapping(ObjectAndDoubleToLong<? super T> combiner, ParallelDoubleArrayWithDoubleMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
`ParallelArrayWithLongMapping<T>`	`withMapping(ObjectAndLongToLong<? super T> combiner, ParallelLongArrayWithLongMapping other)` Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.

- Field Detail
  - ParallelArray.AsList listView
    
    Lazily constructed list view
- Constructor Detail
  - protected ParallelArray(java.util.concurrent.ForkJoinPool executor, T[] array, int limit)
    
    Constructor for use by subclasses to create a new ParallelArray using the given executor, and initially using the supplied array, with effective size bound by the given limit. This constructor is designed to enable extensions via subclassing. To create a ParallelArray, use create, createEmpty, createUsingHandoff or createFromCopy.
    Parameters:
    executor - the executor
    array - the array
    limit - the upper bound limit
  - ParallelArray(java.util.concurrent.ForkJoinPool executor, T[] array)
    
    Trusted internal version of protected constructor.
- Method Detail
  - public ParallelArray<T> addAll(T[] other)
    
    Equivalent to asList().addAll but specialized for array arguments and likely to be more efficient.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    other - the elements to add
  - public ParallelArray<T> addAll(ParallelArrayWithMapping<V, T> other)
    
    Appends all (possibly bounded, filtered, or mapped) elements of the given ParallelArray, resizing and/or reallocating this array if necessary.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    other - the elements to add
  - public ParallelArray<T> all()
    
    Returns a new ParallelArray holding all elements.
    Returns:
    a new ParallelArray holding all elements
  - public ParallelArray<T> all(java.lang.Class<? super T> elementType)
    
    Returns a new ParallelArray with the given element type holding all elements.
    Returns:
    a new ParallelArray holding all elements
    Parameters:
    elementType - the type of the elements
  - public ParallelArray<T> allNonidenticalElements()
    
    Returns a new ParallelArray containing only the non-null unique elements of this array (that is, without any duplicates), using reference identity to test for duplication.
    Returns:
    the new ParallelArray
  - public ParallelArray<T> allUniqueElements()
    
    Returns a new ParallelArray containing only the non-null unique elements of this array (that is, without any duplicates), using each element's equals method to test for duplication.
    Returns:
    the new ParallelArray
  - final void appendElement(T e)
  - public void apply(Procedure<? super T> procedure)
    
    Applies the given procedure to elements.
    Parameters:
    procedure - the procedure
  - public java.util.List<T> asList()
    
    Returns a view of this ParallelArray as a List. This List has the same structural and performance characteristics as java.util.ArrayList, and may be used to modify, replace or extend the bounds of the array underlying this ParallelArray. The methods supported by this list view are not in general implemented as parallel operations. This list is also not itself thread-safe. In particular, performing list updates while other parallel operations are in progress has undefined (and surely undesired) effects.
    Returns:
    a list view
  - public int binarySearch(T target)
    
    Assuming this array is sorted, returns the index of an element equal to given target, or -1 if not present. If the array is not sorted, the results are undefined.
    Returns:
    the index or -1 if not present
    Parameters:
    target - the element to search for
  - public int binarySearch(T target, java.util.Comparator<? super T> comparator)
    
    Assuming this array is sorted with respect to the given comparator, returns the index of an element equal to given target, or -1 if not present. If the array is not sorted, the results are undefined.
    Returns:
    the index or -1 if not present
    Parameters:
    target - the element to search for
    comparator - the comparator
  - public static ParallelArray<T> create(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)
    
    Creates a new ParallelArray using the given executor and an array of the given size constructed using the indicated base element type.
    Parameters:
    size - the array size
    elementType - the type of the elements
    executor - the executor
  - public static ParallelArray<T> createEmpty(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)
    
    Creates a new ParallelArray using the given executor and an array of the given size constructed using the indicated base element type, but with an initial effective size of zero, enabling incremental insertion via ParallelArray.asList operations.
    Parameters:
    size - the array size
    elementType - the type of the elements
    executor - the executor
  - public static ParallelArray<T> createFromCopy(T[] source, java.util.concurrent.ForkJoinPool executor)
    
    Creates a new ParallelArray using the given executor and initially holding copies of the given source elements.
    Parameters:
    source - the source of initial elements
    executor - the executor
  - public static ParallelArray<T> createFromCopy(int size, T[] source, java.util.concurrent.ForkJoinPool executor)
    
    Creates a new ParallelArray using an array of the given size, initially holding copies of the given source truncated or padded with nulls to obtain the specified length.
    Parameters:
    source - the source of initial elements
    size - the array size
    executor - the executor
  - public static ParallelArray<T> createUsingHandoff(T[] handoff, java.util.concurrent.ForkJoinPool executor)
    
    Creates a new ParallelArray initially using the given array and executor. In general, the handed off array should not be used for other purposes once constructing this ParallelArray. The given array may be internally replaced by another array in the course of methods that add or remove elements.
    Parameters:
    handoff - the array
    executor - the executor
  - public ParallelArray<T> cumulate(Reducer<T> reducer, T base)
    
    Replaces each element with the running cumulation of applying the given reducer. For example, if the contents are the numbers 1, 2, 3, and the reducer operation adds numbers, then after invocation of this method, the contents would be 1, 3, 6 (that is, 1, 1+2, 1+2+3).
    Returns:
    this (to simplify use in expressions)
    Parameters:
    reducer - the reducer
    base - the result for an empty array
  - public static java.util.concurrent.ForkJoinPool defaultExecutor()
    
    Returns a common default executor for use in ParallelArrays. This executor arranges enough parallelism to use most, but not necessarily all, of the available processors on this system.
    Returns:
    the executor
  - public T get(int i)
    
    Returns the element of the array at the given index.
    Returns:
    the element of the array at the given index
    Parameters:
    i - the index
  - public T[] getArray()
    
    Returns the underlying array used for computations.
    Returns:
    the array
  - public java.util.concurrent.ForkJoinPool getExecutor()
    
    Returns the executor used for computations.
    Returns:
    the executor
  - public boolean hasAllEqualElements(ParallelArrayWithMapping<U, V> other)
    
    Returns true if all elements at the same relative positions of this and other array are equal.
    Returns:
    true if equal
    Parameters:
    other - the other array
  - public boolean hasAllIdenticalElements(ParallelArrayWithMapping<U, V> other)
    
    Returns true if all elements at the same relative positions of this and other array are identical.
    Returns:
    true if equal
    Parameters:
    other - the other array
  - public int indexOf(T target)
    
    Returns the index of some element equal to given target, or -1 if not present.
    Returns:
    the index or -1 if not present
    Parameters:
    target - the element to search for
  - final void insertElementAt(int index, T e)
  - final void insertSlotsAt(int index, int len)
    
    Makes len slots available at index.
  - public java.util.Iterator<T> iterator()
    
    Returns an iterator stepping through each element of the array up to the current limit. This iterator does not support the remove operation. However, a full ListIterator supporting add, remove, and set operations is available via asList.
    Returns:
    an iterator stepping through each element
  - public T max(java.util.Comparator<? super T> comparator)
    
    Returns the maximum element, or null if empty.
    Returns:
    maximum element, or null if empty
    Parameters:
    comparator - the comparator
  - public T max()
    
    Returns the maximum element, or null if empty, assuming that all elements are Comparables.
    throws:
    ClassCastException if any element is not Comparable
    
    Returns:
    maximum element, or null if empty
  - public T min(java.util.Comparator<? super T> comparator)
    
    Returns the minimum element, or null if empty.
    Returns:
    minimum element, or null if empty
    Parameters:
    comparator - the comparator
  - public T min()
    
    Returns the minimum element, or null if empty, assuming that all elements are Comparables.
    throws:
    ClassCastException if any element is not Comparable
    
    Returns:
    minimum element, or null if empty
  - public T precumulate(Reducer<T> reducer, T base)
    
    Replaces each element with the cumulation of applying the given reducer to all previous values, and returns the total reduction. For example, if the contents are the numbers 1, 2, 3, and the reducer operation adds numbers, then after invocation of this method, the contents would be 0, 1, 3 (that is, 0, 0+1, 0+1+2, and the return value would be 6 (that is, 1+2+3).
    Returns:
    the total reduction
    Parameters:
    reducer - the reducer
    base - the result for an empty array
  - public T reduce(Reducer<T> reducer, T base)
    
    Returns reduction of elements.
    Returns:
    reduction
    Parameters:
    reducer - the reducer
    base - the result for an empty array
  - public ParallelArray<T> removeAll(Predicate<? super T> selector)
    
    Removes from the array all elements for which the given selector holds.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    selector - the selector
  - public ParallelArray<T> removeConsecutiveDuplicates()
    
    Removes consecutive elements that are equal (or null), shifting others leftward, and possibly decreasing size. This method may be used after sorting to ensure that this ParallelArray contains a set of unique elements.
    Returns:
    this (to simplify use in expressions)
  - public ParallelArray<T> removeNulls()
    
    Removes null elements, shifting others leftward, and possibly decreasing size.
    Returns:
    this (to simplify use in expressions)
  - final void removeSlotAt(int index)
  - final void removeSlotsAt(int fromIndex, int toIndex)
  - final void replaceElementsWith(T[] a)
  - public ParallelArray<T> replaceWithGeneratedValue(Generator<? extends T> generator)
    
    Replaces elements with the results of applying the given generator.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    generator - the generator
  - public ParallelArray<T> replaceWithMappedIndex(IntToObject<? extends T> op)
    
    Replaces elements with the results of applying the given mapping to their indices.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    op - the op
  - public ParallelArray<T> replaceWithMappedIndex(IntAndObjectToObject<? super T, ? extends T> op)
    
    Replaces elements with the results of applying the given mapping to each index and current element value.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    op - the op
  - public ParallelArray<T> replaceWithMapping(Op<? super T, ? extends T> op)
    
    Replaces elements with the results of applying the given transform to their current values.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    op - the op
  - public ParallelArray<T> replaceWithMapping(BinaryOp<? super T, ? super V, ? extends T> combiner, ParallelArrayWithMapping<W, V> other)
    
    Replaces elements with results of applying op(thisElement, otherElement).
    Returns:
    this (to simplify use in expressions)
    Parameters:
    other - the other array
    combiner - the combiner
  - public ParallelArray<T> replaceWithMapping(BinaryOp<T, T, T> combiner, T[] other)
    
    Replaces elements with results of applying op(thisElement, otherElement).
    Returns:
    this (to simplify use in expressions)
    Parameters:
    other - the other array
    combiner - the combiner
  - public ParallelArray<T> replaceWithValue(T value)
    
    Replaces elements with the given value.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    value - the value
  - final void resizeArray(int newCap)
  - final int seqIndexOf(java.lang.Object target)
  - final int seqLastIndexOf(java.lang.Object target)
  - public void set(int i, T x)
    
    Sets the element of the array at the given index to the given value.
    Parameters:
    i - the index
    x - the value
  - public final void setLimit(int newLimit)
    
    Ensures that the underlying array can be accessed up to the given upper bound, reallocating and copying the underlying array to expand if necessary. Or, if the given limit is less than the length of the underlying array, causes computations to ignore elements past the given limit.
    throws:
    IllegalArgumentException if newLimit less than zero
    
    Parameters:
    newLimit - the new upper bound
  - public int size()
    
    Returns the effective size of the underlying array. The effective size is the current limit, if used (see setLimit), or the length of the array otherwise.
    Returns:
    the effective size of array
  - public ParallelArray<T> sort(java.util.Comparator<? super T> comparator)
    
    Sorts the array. Unlike Arrays.sort, this sort does not guarantee that elements with equal keys maintain their relative position in the array.
    Returns:
    this (to simplify use in expressions)
    Parameters:
    comparator - the comparator to use
  - public ParallelArray<T> sort()
    
    Sorts the array, assuming all elements are Comparable. Unlike Arrays.sort, this sort does not guarantee that elements with equal keys maintain their relative position in the array.
    throws:
    ClassCastException if any element is not Comparable
    
    Returns:
    this (to simplify use in expressions)
  - public groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T> summary(java.util.Comparator<? super T> comparator)
    
    Returns summary statistics, using the given comparator to locate minimum and maximum elements.
    Returns:
    the summary
    Parameters:
    comparator - the comparator to use for locating minimum and maximum elements
  - public groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T> summary()
    
    Returns summary statistics, assuming that all elements are Comparables.
    Returns:
    the summary
  - public java.lang.String toString()
    
    Equivalent to asList().toString().
    Returns:
    a string representation
  - public ParallelArrayWithBounds<T> withBounds(int firstIndex, int upperBound)
    
    Returns an operation prefix that causes a method to operate only on the elements of the array between firstIndex (inclusive) and upperBound (exclusive).
    Returns:
    operation prefix
    Parameters:
    firstIndex - the lower bound (inclusive)
    upperBound - the upper bound (exclusive)
  - public ParallelArrayWithFilter<T> withFilter(Predicate<? super T> selector)
    
    Returns an operation prefix that causes a method to operate only on the elements of the array for which the given selector returns true.
    Returns:
    operation prefix
    Parameters:
    selector - the selector
  - public ParallelArrayWithFilter<T> withFilter(BinaryPredicate<? super T, ? super V> selector, ParallelArrayWithMapping<W, V> other)
    
    Returns an operation prefix that causes a method to operate only on elements for which the given binary selector returns true.
    Returns:
    operation prefix
    Parameters:
    selector - the selector
  - public ParallelArrayWithFilter<T> withIndexedFilter(IntAndObjectPredicate<? super T> selector)
    
    Returns an operation prefix that causes a method to operate only on elements for which the given indexed selector returns true.
    Returns:
    operation prefix
    Parameters:
    selector - the selector
  - public ParallelArrayWithMapping<T, U> withIndexedMapping(IntAndObjectToObject<? super T, ? extends U> mapper)
    
    Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value. Index-based mappings allow parallel computation of many common array operations. For example, you could create function to average the values at the same index of multiple arrays and apply it using this method.
    Returns:
    operation prefix
    Parameters:
    mapper - the mapper
  - public ParallelArrayWithDoubleMapping<T> withIndexedMapping(IntAndObjectToDouble<? super T> mapper)
    
    Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value.
    Returns:
    operation prefix
    Parameters:
    mapper - the mapper
  - public ParallelArrayWithLongMapping<T> withIndexedMapping(IntAndObjectToLong<? super T> mapper)
    
    Returns an operation prefix that causes a method to operate on mappings of this array using the given mapper that accepts as arguments an element's current index and value, and produces a new value.
    Returns:
    operation prefix
    Parameters:
    mapper - the mapper
  - public ParallelArrayWithMapping<T, U> withMapping(Op<? super T, ? extends U> op)
    
    Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
    Returns:
    operation prefix
    Parameters:
    op - the op
  - public ParallelArrayWithDoubleMapping<T> withMapping(ObjectToDouble<? super T> op)
    
    Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
    Returns:
    operation prefix
    Parameters:
    op - the op
  - public ParallelArrayWithLongMapping<T> withMapping(ObjectToLong<? super T> op)
    
    Returns an operation prefix that causes a method to operate on mapped elements of the array using the given op.
    Returns:
    operation prefix
    Parameters:
    op - the op
  - public ParallelArrayWithMapping<T, V> withMapping(BinaryOp<? super T, ? super U, ? extends V> combiner, ParallelArrayWithMapping<W, U> other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithMapping<T, V> withMapping(ObjectAndDoubleToObject<? super T, ? extends V> combiner, ParallelDoubleArrayWithDoubleMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithMapping<T, V> withMapping(ObjectAndLongToObject<? super T, ? extends V> combiner, ParallelLongArrayWithLongMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithDoubleMapping<T> withMapping(ObjectAndObjectToDouble<? super T, ? super U> combiner, ParallelArrayWithMapping<W, U> other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithDoubleMapping<T> withMapping(ObjectAndDoubleToDouble<? super T> combiner, ParallelDoubleArrayWithDoubleMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithDoubleMapping<T> withMapping(ObjectAndLongToDouble<? super T> combiner, ParallelLongArrayWithLongMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithLongMapping<T> withMapping(ObjectAndObjectToLong<? super T, ? super U> combiner, ParallelArrayWithMapping<W, U> other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithLongMapping<T> withMapping(ObjectAndDoubleToLong<? super T> combiner, ParallelDoubleArrayWithDoubleMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array
  - public ParallelArrayWithLongMapping<T> withMapping(ObjectAndLongToLong<? super T> combiner, ParallelLongArrayWithLongMapping other)
    
    Returns an operation prefix that causes a method to operate on binary mappings of this array and the other array.
    throws:
    IllegalArgumentException if other array is a filtered view (all filters must precede all mappings)
    
    Returns:
    operation prefix
    Parameters:
    combiner - the combiner
    other - the other array

| Detail:
Field
Constructor
Method

[Java] Class ParallelArray<T>

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Field Detail

ParallelArray.AsList listView

Constructor Detail

protected ParallelArray(java.util.concurrent.ForkJoinPool executor, T[] array, int limit)

ParallelArray(java.util.concurrent.ForkJoinPool executor, T[] array)

Method Detail

public ParallelArray<T> addAll(T[] other)

public ParallelArray<T> addAll(ParallelArrayWithMapping<V, T> other)

public ParallelArray<T> all()

public ParallelArray<T> all(java.lang.Class<? super T> elementType)

public ParallelArray<T> allNonidenticalElements()

public ParallelArray<T> allUniqueElements()

final void appendElement(T e)

public void apply(Procedure<? super T> procedure)

public java.util.List<T> asList()

public int binarySearch(T target)

public int binarySearch(T target, java.util.Comparator<? super T> comparator)

public static ParallelArray<T> create(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)

public static ParallelArray<T> createEmpty(int size, java.lang.Class<? super T> elementType, java.util.concurrent.ForkJoinPool executor)

public static ParallelArray<T> createFromCopy(T[] source, java.util.concurrent.ForkJoinPool executor)

public static ParallelArray<T> createFromCopy(int size, T[] source, java.util.concurrent.ForkJoinPool executor)

public static ParallelArray<T> createUsingHandoff(T[] handoff, java.util.concurrent.ForkJoinPool executor)

public ParallelArray<T> cumulate(Reducer<T> reducer, T base)

public static java.util.concurrent.ForkJoinPool defaultExecutor()

public T get(int i)

public T[] getArray()

public java.util.concurrent.ForkJoinPool getExecutor()

public boolean hasAllEqualElements(ParallelArrayWithMapping<U, V> other)

public boolean hasAllIdenticalElements(ParallelArrayWithMapping<U, V> other)

public int indexOf(T target)

final void insertElementAt(int index, T e)

final void insertSlotsAt(int index, int len)

public java.util.Iterator<T> iterator()

public T max(java.util.Comparator<? super T> comparator)

public T max()

public T min(java.util.Comparator<? super T> comparator)

public T min()

public T precumulate(Reducer<T> reducer, T base)

public T reduce(Reducer<T> reducer, T base)

public ParallelArray<T> removeAll(Predicate<? super T> selector)

public ParallelArray<T> removeConsecutiveDuplicates()

public ParallelArray<T> removeNulls()

final void removeSlotAt(int index)

final void removeSlotsAt(int fromIndex, int toIndex)

final void replaceElementsWith(T[] a)

public ParallelArray<T> replaceWithGeneratedValue(Generator<? extends T> generator)

public ParallelArray<T> replaceWithMappedIndex(IntToObject<? extends T> op)

public ParallelArray<T> replaceWithMappedIndex(IntAndObjectToObject<? super T, ? extends T> op)

public ParallelArray<T> replaceWithMapping(Op<? super T, ? extends T> op)

public ParallelArray<T> replaceWithMapping(BinaryOp<? super T, ? super V, ? extends T> combiner, ParallelArrayWithMapping<W, V> other)

public ParallelArray<T> replaceWithMapping(BinaryOp<T, T, T> combiner, T[] other)

public ParallelArray<T> replaceWithValue(T value)

final void resizeArray(int newCap)

final int seqIndexOf(java.lang.Object target)

final int seqLastIndexOf(java.lang.Object target)

public void set(int i, T x)

public final void setLimit(int newLimit)

public int size()

public ParallelArray<T> sort(java.util.Comparator<? super T> comparator)

public ParallelArray<T> sort()

public groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T> summary(java.util.Comparator<? super T> comparator)

public groovyx.gpars.extra166y.ParallelArray.SummaryStatistics<T> summary()

public java.lang.String toString()

public ParallelArrayWithBounds<T> withBounds(int firstIndex, int upperBound)

public ParallelArrayWithFilter<T> withFilter(Predicate<? super T> selector)

public ParallelArrayWithFilter<T> withFilter(BinaryPredicate<? super T, ? super V> selector, ParallelArrayWithMapping<W, V> other)

public ParallelArrayWithFilter<T> withIndexedFilter(IntAndObjectPredicate<? super T> selector)

public ParallelArrayWithMapping<T, U> withIndexedMapping(IntAndObjectToObject<? super T, ? extends U> mapper)

public ParallelArrayWithDoubleMapping<T> withIndexedMapping(IntAndObjectToDouble<? super T> mapper)

public ParallelArrayWithLongMapping<T> withIndexedMapping(IntAndObjectToLong<? super T> mapper)

public ParallelArrayWithMapping<T, U> withMapping(Op<? super T, ? extends U> op)

public ParallelArrayWithDoubleMapping<T> withMapping(ObjectToDouble<? super T> op)

public ParallelArrayWithLongMapping<T> withMapping(ObjectToLong<? super T> op)

public ParallelArrayWithMapping<T, V> withMapping(BinaryOp<? super T, ? super U, ? extends V> combiner, ParallelArrayWithMapping<W, U> other)

public ParallelArrayWithMapping<T, V> withMapping(ObjectAndDoubleToObject<? super T, ? extends V> combiner, ParallelDoubleArrayWithDoubleMapping other)