1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* Copyright (C) 2014-2021 Brian L. Browning
*
* This file is part of Beagle
*
* Beagle is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Beagle is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package ints;
import java.util.Arrays;
import java.util.stream.IntStream;
/**
* <p>Class {@code WrappedIntArray} represents an immutable
* {@code int[]} array.
* </p>
* Instances of {@code WrappedIntArray} are immutable.
*
* @author Brian L. Browning {@code <browning@uw.edu>}
*/
public final class WrappedIntArray implements IntArray {
private final int[] ia;
/**
* Constructs a new {@code WrappedIntArray} instance.
* @param ia an array of integers
* @throws NullPointerException if {@code ia == null}
*/
public WrappedIntArray(int[] ia) {
this.ia = ia.clone();
}
/**
* Constructs an {@code WrappedIntrray} object with the specified
* values.
* @param values a stream of integer values
* @throws NullPointerException if {@code values == null}
* @throws IllegalStateException if the stream has previously been used
*/
public WrappedIntArray(IntStream values) {
this.ia = values.toArray();
}
/**
* Constructs a new {@code WrappedIntArray} instance.
* @param ia an array of integers
* @param valueSize the exclusive end of the range of non-negative
* array values
* @throws IllegalArgumentException if
* {@code (ia[j] < 0 || ia[j] > valueSize)} for any index {@code j}
* satisfying {@code (j >= 0 && j < ia.length)}
* @throws NullPointerException if {@code ia == null}
*/
public WrappedIntArray(int[] ia, int valueSize) {
this.ia = new int[ia.length];
for (int j=0; j<ia.length; ++j) {
if (ia[j]<0 || ia[j]>=valueSize) {
throw new IllegalArgumentException(String.valueOf(ia[j]));
}
this.ia[j] = ia[j];
}
}
/**
* Constructs a new {@code WrappedIntArray} instance.
* @param il a list of integers
* @throws NullPointerException if {@code il == null}
*/
public WrappedIntArray(IntList il) {
this.ia = il.toArray();
}
/**
* Constructs a new {@code WrappedIntArray} instance.
* @param il a list of integers
* @param valueSize the exclusive end of the range of non-negative
* array values
* @throws IllegalArgumentException if
* {@code (il[j] < 0 || il[j] > valueSize)} for any index {@code j}
* satisfying {@code (j >= 0 && j < il.length)}
* @throws NullPointerException if {@code il == null}
*/
public WrappedIntArray(IntList il, int valueSize) {
this.ia = new int[il.size()];
for (int j=0; j<ia.length; ++j) {
int value = il.get(j);
if (value<0 || value>=valueSize) {
throw new IllegalArgumentException(String.valueOf(value));
}
ia[j] = value;
}
}
@Override
public int size() {
return ia.length;
}
@Override
public int get(int index) {
return ia[index];
}
@Override
public String toString() {
return Arrays.toString(ia);
}
/**
* Returns the list of integers.
* @return the list of integers
*/
public int[] toArray() {
return ia.clone();
}
/**
* Searches {@code this} for the specified value using the binary search
* algorithm. This list must be sorted (as by the
* {@code java.util.Arrays.sort(int[])} method) prior to making
* this call. If it is not sorted, the results are undefined.
* If the list contains multiple elements with the specified
* value, there is no guarantee which one will be found.
*
* @param key the value to be searched for
*
* @return index of the search key, if it is contained in the list;
* otherwise, {@code (-(insertion point) - 1)}. The insertion point is
* defined as the point at which the key would be inserted into the list:
* the index of the first element greater than the key, or
* {@code this.size()} if all elements in the list are less than the
* specified key. Note that this guarantees that the return value will
* be {@code >= 0} if and only if the key is found.
*/
public int binarySearch(int key) {
return Arrays.binarySearch(ia, key);
}
/**
* Searches the specified range of {@code this} for the specified value
* using the binary search algorithm. This range must be sorted (as by the
* {@code java.util.Arrays.sort(int[])} method) prior to making
* this call. If it is not sorted, the results are undefined.
* If the range contains multiple elements with the specified
* value, there is no guarantee which one will be found. This method
* considers all NaN values to be equivalent and equal.
*
* @param fromIndex the index of the first element (inclusive) to be searched
* @param toIndex the index of the last element (exclusive) to be searched
* @param key the value to be searched for
*
* @return index of the search key, if it is contained in the list;
* otherwise, {@code (-(insertion point) - 1)}. The insertion point is
* defined as the point at which the key would be inserted into the list:
* the index of the first element greater than the key, or
* {@code this.size()} if all elements in the list are less than the
* specified key. Note that this guarantees that the return value will
* be {@code >= 0} if and only if the key is found.
*
* @throws IllegalArgumentException if {@code fromIndex > toIndex}
* @throws ArrayIndexOutOfBoundsException if
* {@code fromIndex < 0 || toIndex > this.size()}
*/
public int binarySearch(int fromIndex, int toIndex, int key) {
return Arrays.binarySearch(ia, fromIndex, toIndex, key);
}
}
|
