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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
|
/*
* Copyright (C) 2014-2016 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;
/**
* <p>Class {@code ShiftedByteIndexArray} represents an immutable
* array of integer values between 0 and 255 inclusive that is stored
* as a {@code byte[]} array whose values have been translated by -128.
* </p>
* <p>
* Instances of {@code UnsignedByteArray} are immutable.
* </p>
*
* @author Brian L. Browning {@code <browning@uw.edu>}
*/
public final class UnsignedByteArray implements IntArray {
private final byte[] ba;
/**
* Constructs a new {@code UnsignedByteArray} instance from
* the specified data.
* @param ba an array of bytes which are interpreted as unsigned byte
* values between 0 and 255
* @throws NullPointerException if {@code ba == null}
*/
public UnsignedByteArray(byte[] ba) {
this.ba = ba.clone();
}
/**
* Constructs a new {@code UnsignedByteArray} instance from the
* specified data.
* @param ba an array of bytes which are interpreted as unsigned byte
* values between 0 and 255
* @param from the first element to be included (inclusive)
* @param to the last element to be included (exclusive)
* @throws IndexOutOfBoundsException if {@code (from < 0 || to > ia.length)}
* @throws NegativeArraySizeException if {@code to > from}
* @throws NullPointerException if {@code ba == null}
*/
public UnsignedByteArray(byte[] ba, int from, int to) {
this.ba = Arrays.copyOfRange(ba, from, to);
}
/**
* Constructs a new {@code UnsignedByteArray} instance from
* the specified data.
* @param ia an array of positive integer values whose lower order byte
* will be stored
* @throws IllegalArgumentException if
* {@code (ia[j] < 0 || ia[j] > 255)} for any index {@code j}
* satisfying {@code (j >= 0 && j < ia.length)}
* @throws NullPointerException if {@code ia == null}
*/
public UnsignedByteArray(int[] ia) {
this(ia, 0, ia.length);
}
/**
* Constructs a new {@code UnsignedByteArray} instance from the specified data.
* @param il an list of integer values between 0 and 255 inclusive
* @throws IllegalArgumentException if
* {@code (il.get(j) < 0 || il.get(j) > 255)} for any index {@code j}
* satisfying {@code (j >= 0 && j < il.size())}
* @throws NullPointerException if {@code il == null}
*/
public UnsignedByteArray(IntList il) {
this(il, 0, il.size());
}
/**
* Constructs a new {@code UnsignedByteArray} instance from
* the specified data.
* @param ia an array of nonnegative integer values
* @param valueSize the exclusive end of the range of non-negative
* array values
* @throws IllegalArgumentException if {@code valueSize < 1 || valueSize > 256}
* @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 UnsignedByteArray(int[] ia, int valueSize) {
if (valueSize < 1 || valueSize > 256) {
throw new IllegalArgumentException(String.valueOf(valueSize));
}
this.ba = new byte[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.ba[j] = (byte) ia[j];
}
}
/**
* Constructs a new {@code UnsignedByteArray} instance from
* the specified data.
* @param il an list of nonnegative integers
* @param valueSize the exclusive end of the range of non-negative
* array values
* @throws IllegalArgumentException if
* {@code (valueSize < 1) || (valueSize > 256)}
* @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 il == null}
*/
public UnsignedByteArray(IntList il, int valueSize) {
if (valueSize < 1 || valueSize > 256) {
throw new IllegalArgumentException(String.valueOf(valueSize));
}
this.ba = new byte[il.size()];
for (int j=0; j<ba.length; ++j) {
int value = il.get(j);
if (value<0 || value>=valueSize) {
throw new IllegalArgumentException(String.valueOf(value));
}
this.ba[j] = (byte) value;
}
}
/**
* Constructs a new {@code UnsignedByteArray} instance from the
* specified data.
* @param ia an array of integer values between 0 and 255 inclusive
* @param from the first element to be included (inclusive)
* @param to the last element to be included (exclusive)
* @throws IllegalArgumentException if
* {@code (ia[j] < 0 || ia[j] > 255)} for any index {@code j}
* satisfying {@code (j >= from && j < to)}
* @throws IndexOutOfBoundsException if {@code (from < 0 || to > ia.length)}
* @throws NegativeArraySizeException if {@code to > from}
* @throws NullPointerException if {@code ia == null}
*/
public UnsignedByteArray(int[] ia, int from, int to) {
this.ba = new byte[to - from];
for (int j=from; j<to; ++j) {
if (ia[j] < 0 || ia[j] > 255) {
throw new IllegalArgumentException(String.valueOf(ia[j]));
}
ba[j - from] = (byte) ia[j];
}
}
/**
* Constructs a new {@code UnsignedByteArray} instance from the
* specified data.
* @param il an list of integer values between 0 and 255 inclusive
* @param from the first element to be included (inclusive)
* @param to the last element to be included (exclusive)
* @throws IllegalArgumentException if
* {@code (il.get(j) < 0 || il.get(j) > 255)} for any index {@code j}
* satisfying {@code (j >= from && j < to)}
* @throws IndexOutOfBoundsException if {@code from < 0 || to > il.length}
* @throws NegativeArraySizeException if {@code to > from}
* @throws NullPointerException if {@code il == null}
*/
public UnsignedByteArray(IntList il, int from, int to) {
this.ba = new byte[to - from];
for (int j=from; j<to; ++j) {
int value = il.get(j);
if (value < 0 || value > 255) {
throw new IllegalArgumentException(String.valueOf(value));
}
ba[j - from] = (byte) value;
}
}
@Override
public int size() {
return ba.length;
}
@Override
public int get(int index) {
return ba[index] & 0xff;
}
@Override
public String toString() {
return IntArray.asString(this);
}
}
|