ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/extra166y/ParallelDoubleArrayWithBounds.java
Revision: 1.9
Committed: Thu Feb 26 06:53:34 2015 UTC (9 years, 1 month ago) by jsr166
Branch: MAIN
CVS Tags: HEAD
Changes since 1.8: +0 -1 lines
Log Message:
delete unused imports

File Contents

# Content
1 /*
2 * Written by Doug Lea with assistance from members of JCP JSR-166
3 * Expert Group and released to the public domain, as explained at
4 * http://creativecommons.org/publicdomain/zero/1.0/
5 */
6
7 package extra166y;
8
9 import jsr166y.*;
10 import static extra166y.Ops.*;
11 import java.util.*;
12 import java.util.concurrent.atomic.*;
13
14 /**
15 * A prefix view of ParallelDoubleArray that causes operations to apply
16 * only to elements within a given range.
17 * Instances of this class may be constructed only via prefix
18 * methods of ParallelDoubleArray or its other prefix classes.
19 */
20 public abstract class ParallelDoubleArrayWithBounds extends ParallelDoubleArrayWithFilter {
21 ParallelDoubleArrayWithBounds
22 (ForkJoinPool ex, int origin, int fence, double[] array) {
23 super(ex, origin, fence, array);
24 }
25
26 /**
27 * Returns an operation prefix that causes a method to operate
28 * only on the elements of the array between firstIndex
29 * (inclusive) and upperBound (exclusive). The bound
30 * arguments are relative to the current bounds. For example
31 * {@code pa.withBounds(2, 8).withBounds(3, 5)} indexes the
32 * 5th (= 2+3) and 6th elements of pa. However, indices
33 * returned by methods such as {@code indexOf} are
34 * with respect to the underlying ParallelDoubleArray.
35 * @param firstIndex the lower bound (inclusive)
36 * @param upperBound the upper bound (exclusive)
37 * @return operation prefix
38 */
39 public abstract ParallelDoubleArrayWithBounds withBounds
40 (int firstIndex, int upperBound);
41
42 /**
43 * Returns the index of some element equal to given target,
44 * or -1 if not present.
45 * @param target the element to search for
46 * @return the index or -1 if not present
47 */
48 public abstract int indexOf(double target);
49
50 /**
51 * Assuming this array is sorted, returns the index of an
52 * element equal to given target, or -1 if not present. If the
53 * array is not sorted, the results are undefined.
54 * @param target the element to search for
55 * @return the index or -1 if not present
56 */
57 public abstract int binarySearch(double target);
58
59 /**
60 * Assuming this array is sorted with respect to the given
61 * comparator, returns the index of an element equal to given
62 * target, or -1 if not present. If the array is not sorted,
63 * the results are undefined.
64 * @param target the element to search for
65 * @param comparator the comparator
66 * @return the index or -1 if not present
67 */
68 public abstract int binarySearch(double target,
69 DoubleComparator comparator);
70
71 /**
72 * Replaces each element with the running cumulation of applying
73 * the given reducer.
74 * @param reducer the reducer
75 * @param base the result for an empty array
76 * @return this (to simplify use in expressions)
77 */
78 public abstract ParallelDoubleArrayWithBounds cumulate(DoubleReducer reducer, double base);
79
80 /**
81 * Replaces each element with the running sum.
82 * @return this (to simplify use in expressions)
83 */
84 public abstract ParallelDoubleArrayWithBounds cumulateSum();
85
86 /**
87 * Replaces each element with the cumulation of applying the given
88 * reducer to all previous values, and returns the total
89 * reduction.
90 * @param reducer the reducer
91 * @param base the result for an empty array
92 * @return the total reduction
93 */
94 public abstract double precumulate(DoubleReducer reducer, double base);
95
96 /**
97 * Replaces each element with its prefix sum.
98 * @return the total sum
99 */
100 public abstract double precumulateSum();
101
102 /**
103 * Sorts the elements.
104 * Unlike Arrays.sort, this sort does
105 * not guarantee that elements with equal keys maintain their
106 * relative position in the array.
107 * @param cmp the comparator to use
108 * @return this (to simplify use in expressions)
109 */
110 public abstract ParallelDoubleArrayWithBounds sort(DoubleComparator cmp);
111
112 /**
113 * Sorts the elements, assuming all elements are
114 * Comparable. Unlike Arrays.sort, this sort does not
115 * guarantee that elements with equal keys maintain their relative
116 * position in the array.
117 * @return this (to simplify use in expressions)
118 * @throws ClassCastException if any element is not Comparable
119 */
120 public abstract ParallelDoubleArrayWithBounds sort();
121 }