--- jsr166/src/extra166y/ParallelDoubleArray.java 2009/01/06 14:30:58 1.1
+++ jsr166/src/extra166y/ParallelDoubleArray.java 2013/07/19 19:34:43 1.12
@@ -1,7 +1,7 @@
/*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
- * http://creativecommons.org/licenses/publicdomain
+ * http://creativecommons.org/publicdomain/zero/1.0/
*/
package extra166y;
@@ -61,7 +61,7 @@ public class ParallelDoubleArray extends
/**
* Creates a new ParallelDoubleArray using the given executor and
- * an array of the given size
+ * an array of the given size.
* @param size the array size
* @param executor the executor
*/
@@ -137,30 +137,30 @@ public class ParallelDoubleArray extends
* mapped ParallelDoubleArray.
*/
public static interface SummaryStatistics {
- /** Return the number of elements */
+ /** Returns the number of elements */
public int size();
- /** Return the minimum element, or Double.MAX_VALUE if empty */
+ /** Returns the minimum element, or Double.MAX_VALUE if empty */
public double min();
- /** Return the maximum element, or -Double.MAX_VALUE if empty */
+ /** Returns the maximum element, or -Double.MAX_VALUE if empty */
public double max();
- /** Return the index of the minimum element, or -1 if empty */
+ /** Returns the index of the minimum element, or -1 if empty */
public int indexOfMin();
- /** Return the index of the maximum element, or -1 if empty */
+ /** Returns the index of the maximum element, or -1 if empty */
public int indexOfMax();
- /** Return the sum of all elements */
+ /** Returns the sum of all elements */
public double sum();
- /** Return the arithmetic average of all elements */
+ /** Returns the arithmetic average of all elements */
public double average();
}
/**
- * Returns the executor used for computations
+ * Returns the executor used for computations.
* @return the executor
*/
public ForkJoinPool getExecutor() { return ex; }
/**
- * Applies the given procedure to elements
+ * Applies the given procedure to elements.
* @param procedure the procedure
*/
public void apply(DoubleProcedure procedure) {
@@ -168,7 +168,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns reduction of elements
+ * Returns reduction of elements.
* @param reducer the reducer
* @param base the result for an empty array
* @return reduction
@@ -178,7 +178,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns a new ParallelDoubleArray holding all elements
+ * Returns a new ParallelDoubleArray holding all elements.
* @return a new ParallelDoubleArray holding all elements
*/
public ParallelDoubleArray all() {
@@ -191,7 +191,7 @@ public class ParallelDoubleArray extends
* @param op the op
* @return this (to simplify use in expressions)
*/
- public ParallelDoubleArray replaceWithMapping(DoubleOp op) {
+ public ParallelDoubleArray replaceWithMapping(DoubleOp op) {
super.replaceWithMapping(op);
return this;
}
@@ -209,7 +209,7 @@ public class ParallelDoubleArray extends
/**
* Replaces elements with the results of applying the given
- * mapping to each index and current element value
+ * mapping to each index and current element value.
* @param op the op
* @return this (to simplify use in expressions)
*/
@@ -222,7 +222,7 @@ public class ParallelDoubleArray extends
* Replaces elements with the results of applying the given
* generator. For example, to fill the array with uniform random
* values, use
- * replaceWithGeneratedValue(Ops.doubleRandom())
+ * {@code replaceWithGeneratedValue(Ops.doubleRandom())}.
* @param generator the generator
* @return this (to simplify use in expressions)
*/
@@ -243,12 +243,12 @@ public class ParallelDoubleArray extends
/**
* Replaces elements with results of applying
- * op(thisElement, otherElement)
+ * {@code op(thisElement, otherElement)}.
* @param other the other array
* @param combiner the combiner
* @return this (to simplify use in expressions)
* @throws ArrayIndexOutOfBoundsException if other array has
- * fewer elements than this array.
+ * fewer elements than this array
*/
public ParallelDoubleArray replaceWithMapping
(BinaryDoubleOp combiner, ParallelDoubleArrayWithDoubleMapping other) {
@@ -258,12 +258,12 @@ public class ParallelDoubleArray extends
/**
* Replaces elements with results of applying
- * op(thisElement, otherElement)
+ * {@code op(thisElement, otherElement)}.
* @param other the other array
* @param combiner the combiner
* @return this (to simplify use in expressions)
* @throws ArrayIndexOutOfBoundsException if other array has
- * fewer elements than this array.
+ * fewer elements than this array
*/
public ParallelDoubleArray replaceWithMapping(BinaryDoubleOp combiner,
double[] other) {
@@ -273,7 +273,7 @@ public class ParallelDoubleArray extends
/**
* Returns the index of some element equal to given target, or -1
- * if not present
+ * if not present.
* @param target the element to search for
* @return the index or -1 if not present
*/
@@ -310,7 +310,7 @@ public class ParallelDoubleArray extends
* to locate minimum and maximum elements.
* @param comparator the comparator to use for
* locating minimum and maximum elements
- * @return the summary.
+ * @return the summary
*/
public ParallelDoubleArray.SummaryStatistics summary
(DoubleComparator comparator) {
@@ -318,15 +318,15 @@ public class ParallelDoubleArray extends
}
/**
- * Returns summary statistics, using natural comparator
- * @return the summary.
+ * Returns summary statistics, using natural comparator.
+ * @return the summary
*/
public ParallelDoubleArray.SummaryStatistics summary() {
return super.summary();
}
/**
- * Returns the minimum element, or Double.MAX_VALUE if empty
+ * Returns the minimum element, or Double.MAX_VALUE if empty.
* @param comparator the comparator
* @return minimum element, or Double.MAX_VALUE if empty
*/
@@ -335,7 +335,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns the minimum element, or Double.MAX_VALUE if empty,
+ * Returns the minimum element, or Double.MAX_VALUE if empty.
* @return minimum element, or Double.MAX_VALUE if empty
*/
public double min() {
@@ -343,7 +343,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns the maximum element, or -Double.MAX_VALUE if empty
+ * Returns the maximum element, or -Double.MAX_VALUE if empty.
* @param comparator the comparator
* @return maximum element, or -Double.MAX_VALUE if empty
*/
@@ -352,7 +352,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns the maximum element, or -Double.MAX_VALUE if empty
+ * Returns the maximum element, or -Double.MAX_VALUE if empty.
* @return maximum element, or -Double.MAX_VALUE if empty
*/
public double max() {
@@ -362,9 +362,9 @@ public class ParallelDoubleArray extends
/**
* 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);
+ * {@code 1, 2, 3}, and the reducer operation adds numbers, then
+ * after invocation of this method, the contents would be {@code 1,
+ * 3, 6} (that is, {@code 1, 1+2, 1+2+3}).
* @param reducer the reducer
* @param base the result for an empty array
* @return this (to simplify use in expressions)
@@ -377,11 +377,11 @@ public class ParallelDoubleArray extends
/**
* 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);
+ * reduction. For example, if the contents are the numbers {@code 1,
+ * 2, 3}, and the reducer operation adds numbers, then after
+ * invocation of this method, the contents would be {@code 0, 1,
+ * 3} (that is, {@code 0, 0+1, 0+1+2}, and the return value
+ * would be 6 (that is, {@code 1+2+3}).
* @param reducer the reducer
* @param base the result for an empty array
* @return the total reduction
@@ -406,8 +406,8 @@ public class ParallelDoubleArray extends
* 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.
* @return this (to simplify use in expressions)
+ * @throws ClassCastException if any element is not Comparable
*/
public ParallelDoubleArray sort() {
super.sort();
@@ -439,7 +439,7 @@ public class ParallelDoubleArray extends
}
/**
- * Equivalent to asList().addAll but specialized for
+ * Equivalent to {@code asList().addAll} but specialized for
* array arguments and likely to be more efficient.
* @param other the elements to add
* @return this (to simplify use in expressions)
@@ -502,6 +502,7 @@ public class ParallelDoubleArray extends
removeSlotsAt(f.offset, fence);
return this;
}
+
/**
* Returns true if all elements at the same relative positions
* of this and other array are equal.
@@ -514,7 +515,7 @@ public class ParallelDoubleArray extends
}
/**
- * Returns the sum of elements
+ * Returns the sum of elements.
* @return the sum of elements
*/
public double sum() {
@@ -522,7 +523,7 @@ public class ParallelDoubleArray extends
}
/**
- * Replaces each element with the running sum
+ * Replaces each element with the running sum.
* @return this (to simplify use in expressions)
*/
public ParallelDoubleArray cumulateSum() {
@@ -531,7 +532,7 @@ public class ParallelDoubleArray extends
}
/**
- * Replaces each element with its prefix sum
+ * Replaces each element with its prefix sum.
* @return the total sum
*/
public double precumulateSum() {
@@ -554,7 +555,7 @@ public class ParallelDoubleArray extends
/**
* 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 true.
* @param selector the selector
* @return operation prefix
*/
@@ -565,7 +566,7 @@ public class ParallelDoubleArray extends
/**
* Returns an operation prefix that causes a method to operate
* only on elements for which the given binary selector returns
- * true
+ * true.
* @param selector the selector
* @return operation prefix
*/
@@ -578,7 +579,7 @@ public class ParallelDoubleArray extends
/**
* Returns an operation prefix that causes a method to operate
* only on elements for which the given indexed selector returns
- * true
+ * true.
* @param selector the selector
* @return operation prefix
*/
@@ -625,7 +626,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithMapping withMapping
(DoubleAndObjectToObject super V, ? extends W> combiner,
@@ -640,7 +641,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithMapping withMapping
(DoubleAndDoubleToObject extends V> combiner,
@@ -655,7 +656,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithMapping withMapping
(DoubleAndLongToObject extends V> combiner,
@@ -670,7 +671,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithDoubleMapping withMapping
(DoubleAndObjectToDouble super V> combiner,
@@ -685,7 +686,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithDoubleMapping withMapping
(BinaryDoubleOp combiner,
@@ -700,7 +701,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithDoubleMapping withMapping
(DoubleAndLongToDouble combiner,
@@ -715,7 +716,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithLongMapping withMapping
(DoubleAndObjectToLong super V> combiner,
@@ -730,7 +731,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithLongMapping withMapping
(DoubleAndDoubleToLong combiner,
@@ -745,7 +746,7 @@ public class ParallelDoubleArray extends
* @param other the other array
* @return operation prefix
* @throws IllegalArgumentException if other array is a
- * filtered view (all filters must precede all mappings).
+ * filtered view (all filters must precede all mappings)
*/
public ParallelDoubleArrayWithLongMapping withMapping
(DoubleAndLongToLong combiner,
@@ -796,9 +797,9 @@ public class ParallelDoubleArray extends
* 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
+ * {@code ListIterator} supporting add, remove, and set
* operations is available via {@link #asList}.
- * @return an iterator stepping through each element.
+ * @return an iterator stepping through each element
*/
public Iterator iterator() {
return new ParallelDoubleArrayIterator(array, fence);
@@ -851,27 +852,27 @@ public class ParallelDoubleArray extends
public int size() { return fence; }
/**
- * Returns the underlying array used for computations
+ * Returns the underlying array used for computations.
* @return the array
*/
public double[] getArray() { return array; }
/**
- * Returns the element of the array at the given index
+ * Returns the element of the array at the given index.
* @param i the index
* @return the element of the array at the given index
*/
public double get(int i) { return array[i]; }
/**
- * Sets the element of the array at the given index to the given value
+ * Sets the element of the array at the given index to the given value.
* @param i the index
* @param x the value
*/
public void set(int i, double x) { array[i] = x; }
/**
- * Equivalent to asList().toString()
+ * Equivalent to {@code asList().toString()}.
* @return a string representation
*/
public String toString() {
@@ -885,7 +886,7 @@ public class ParallelDoubleArray extends
* than the length of the underlying array, causes computations to
* ignore elements past the given limit.
* @param newLimit the new upper bound
- * @throws IllegalArgumentException if newLimit less than zero.
+ * @throws IllegalArgumentException if newLimit less than zero
*/
public final void setLimit(int newLimit) {
if (newLimit < 0)
@@ -922,7 +923,7 @@ public class ParallelDoubleArray extends
}
/**
- * Make len slots available at index
+ * Makes len slots available at index.
*/
final void insertSlotsAt(int index, int len) {
if (len <= 0)
@@ -1164,4 +1165,3 @@ public class ParallelDoubleArray extends
}
}
-