Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.util; |
| 18 | |
| 19 | import com.android.internal.util.ArrayUtils; |
Adam Lesinski | 776abc2 | 2014-03-07 11:30:59 -0500 | [diff] [blame] | 20 | import com.android.internal.util.GrowingArrayUtils; |
| 21 | |
| 22 | import libcore.util.EmptyArray; |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 23 | |
| 24 | /** |
| 25 | * SparseLongArrays map integers to longs. Unlike a normal array of longs, |
Dianne Hackborn | b993f41 | 2013-07-12 17:46:45 -0700 | [diff] [blame] | 26 | * there can be gaps in the indices. It is intended to be more memory efficient |
| 27 | * than using a HashMap to map Integers to Longs, both because it avoids |
| 28 | * auto-boxing keys and values and its data structure doesn't rely on an extra entry object |
| 29 | * for each mapping. |
| 30 | * |
| 31 | * <p>Note that this container keeps its mappings in an array data structure, |
| 32 | * using a binary search to find keys. The implementation is not intended to be appropriate for |
| 33 | * data structures |
| 34 | * that may contain large numbers of items. It is generally slower than a traditional |
| 35 | * HashMap, since lookups require a binary search and adds and removes require inserting |
| 36 | * and deleting entries in the array. For containers holding up to hundreds of items, |
| 37 | * the performance difference is not significant, less than 50%.</p> |
Flavio Lerda | 5771302 | 2013-09-08 18:04:58 +0100 | [diff] [blame] | 38 | * |
| 39 | * <p>It is possible to iterate over the items in this container using |
| 40 | * {@link #keyAt(int)} and {@link #valueAt(int)}. Iterating over the keys using |
| 41 | * <code>keyAt(int)</code> with ascending values of the index will return the |
| 42 | * keys in ascending order, or the values corresponding to the keys in ascending |
Newton Allen | ebb4795 | 2013-11-21 13:27:10 -0800 | [diff] [blame] | 43 | * order in the case of <code>valueAt(int)</code>.</p> |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 44 | */ |
| 45 | public class SparseLongArray implements Cloneable { |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 46 | private int[] mKeys; |
| 47 | private long[] mValues; |
| 48 | private int mSize; |
| 49 | |
| 50 | /** |
| 51 | * Creates a new SparseLongArray containing no mappings. |
| 52 | */ |
| 53 | public SparseLongArray() { |
| 54 | this(10); |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Creates a new SparseLongArray containing no mappings that will not |
| 59 | * require any additional memory allocation to store the specified |
Dianne Hackborn | f4bf0ae | 2013-05-20 18:42:16 -0700 | [diff] [blame] | 60 | * number of mappings. If you supply an initial capacity of 0, the |
| 61 | * sparse array will be initialized with a light-weight representation |
| 62 | * not requiring any additional array allocations. |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 63 | */ |
| 64 | public SparseLongArray(int initialCapacity) { |
Dianne Hackborn | f4bf0ae | 2013-05-20 18:42:16 -0700 | [diff] [blame] | 65 | if (initialCapacity == 0) { |
Adam Lesinski | 776abc2 | 2014-03-07 11:30:59 -0500 | [diff] [blame] | 66 | mKeys = EmptyArray.INT; |
| 67 | mValues = EmptyArray.LONG; |
Dianne Hackborn | f4bf0ae | 2013-05-20 18:42:16 -0700 | [diff] [blame] | 68 | } else { |
Adam Lesinski | 776abc2 | 2014-03-07 11:30:59 -0500 | [diff] [blame] | 69 | mValues = ArrayUtils.newUnpaddedLongArray(initialCapacity); |
| 70 | mKeys = new int[mValues.length]; |
Dianne Hackborn | f4bf0ae | 2013-05-20 18:42:16 -0700 | [diff] [blame] | 71 | } |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 72 | mSize = 0; |
| 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public SparseLongArray clone() { |
| 77 | SparseLongArray clone = null; |
| 78 | try { |
| 79 | clone = (SparseLongArray) super.clone(); |
| 80 | clone.mKeys = mKeys.clone(); |
| 81 | clone.mValues = mValues.clone(); |
| 82 | } catch (CloneNotSupportedException cnse) { |
| 83 | /* ignore */ |
| 84 | } |
| 85 | return clone; |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Gets the long mapped from the specified key, or <code>0</code> |
| 90 | * if no such mapping has been made. |
| 91 | */ |
| 92 | public long get(int key) { |
| 93 | return get(key, 0); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Gets the long mapped from the specified key, or the specified value |
| 98 | * if no such mapping has been made. |
| 99 | */ |
| 100 | public long get(int key, long valueIfKeyNotFound) { |
Dianne Hackborn | 3e82ba1 | 2013-07-16 13:23:55 -0700 | [diff] [blame] | 101 | int i = ContainerHelpers.binarySearch(mKeys, mSize, key); |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 102 | |
| 103 | if (i < 0) { |
| 104 | return valueIfKeyNotFound; |
| 105 | } else { |
| 106 | return mValues[i]; |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Removes the mapping from the specified key, if there was any. |
| 112 | */ |
| 113 | public void delete(int key) { |
Dianne Hackborn | 3e82ba1 | 2013-07-16 13:23:55 -0700 | [diff] [blame] | 114 | int i = ContainerHelpers.binarySearch(mKeys, mSize, key); |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 115 | |
| 116 | if (i >= 0) { |
| 117 | removeAt(i); |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | /** |
Suprabh Shukla | e6e723d | 2017-06-14 16:14:43 -0700 | [diff] [blame] | 122 | * @hide |
| 123 | * Remove a range of mappings as a batch. |
| 124 | * |
| 125 | * @param index Index to begin at |
| 126 | * @param size Number of mappings to remove |
| 127 | * |
| 128 | * <p>For indices outside of the range <code>0...size()-1</code>, |
| 129 | * the behavior is undefined.</p> |
| 130 | */ |
| 131 | public void removeAtRange(int index, int size) { |
| 132 | size = Math.min(size, mSize - index); |
| 133 | System.arraycopy(mKeys, index + size, mKeys, index, mSize - (index + size)); |
| 134 | System.arraycopy(mValues, index + size, mValues, index, mSize - (index + size)); |
| 135 | mSize -= size; |
| 136 | } |
| 137 | |
| 138 | /** |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 139 | * Removes the mapping at the given index. |
| 140 | */ |
| 141 | public void removeAt(int index) { |
| 142 | System.arraycopy(mKeys, index + 1, mKeys, index, mSize - (index + 1)); |
| 143 | System.arraycopy(mValues, index + 1, mValues, index, mSize - (index + 1)); |
| 144 | mSize--; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Adds a mapping from the specified key to the specified value, |
| 149 | * replacing the previous mapping from the specified key if there |
| 150 | * was one. |
| 151 | */ |
| 152 | public void put(int key, long value) { |
Dianne Hackborn | 3e82ba1 | 2013-07-16 13:23:55 -0700 | [diff] [blame] | 153 | int i = ContainerHelpers.binarySearch(mKeys, mSize, key); |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 154 | |
| 155 | if (i >= 0) { |
| 156 | mValues[i] = value; |
| 157 | } else { |
| 158 | i = ~i; |
| 159 | |
Adam Lesinski | 776abc2 | 2014-03-07 11:30:59 -0500 | [diff] [blame] | 160 | mKeys = GrowingArrayUtils.insert(mKeys, mSize, i, key); |
| 161 | mValues = GrowingArrayUtils.insert(mValues, mSize, i, value); |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 162 | mSize++; |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Returns the number of key-value mappings that this SparseIntArray |
| 168 | * currently stores. |
| 169 | */ |
| 170 | public int size() { |
| 171 | return mSize; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Given an index in the range <code>0...size()-1</code>, returns |
| 176 | * the key from the <code>index</code>th key-value mapping that this |
| 177 | * SparseLongArray stores. |
Flavio Lerda | 5771302 | 2013-09-08 18:04:58 +0100 | [diff] [blame] | 178 | * |
| 179 | * <p>The keys corresponding to indices in ascending order are guaranteed to |
| 180 | * be in ascending order, e.g., <code>keyAt(0)</code> will return the |
| 181 | * smallest key and <code>keyAt(size()-1)</code> will return the largest |
| 182 | * key.</p> |
Kweku Adams | 4be0b1a | 2019-04-25 16:16:34 -0700 | [diff] [blame] | 183 | * |
| 184 | * <p>For indices outside of the range <code>0...size()-1</code>, the behavior is undefined for |
| 185 | * apps targeting {@link android.os.Build.VERSION_CODES#P} and earlier, and an |
| 186 | * {@link ArrayIndexOutOfBoundsException} is thrown for apps targeting |
| 187 | * {@link android.os.Build.VERSION_CODES#Q} and later.</p> |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 188 | */ |
| 189 | public int keyAt(int index) { |
Kweku Adams | 4be0b1a | 2019-04-25 16:16:34 -0700 | [diff] [blame] | 190 | if (index >= mSize && UtilConfig.sThrowExceptionForUpperArrayOutOfBounds) { |
Kweku Adams | 025a166 | 2019-03-30 00:03:17 +0000 | [diff] [blame] | 191 | // The array might be slightly bigger than mSize, in which case, indexing won't fail. |
Kweku Adams | 3858b2d | 2019-04-29 11:47:41 -0700 | [diff] [blame] | 192 | // Check if exception should be thrown outside of the critical path. |
Kweku Adams | 025a166 | 2019-03-30 00:03:17 +0000 | [diff] [blame] | 193 | throw new ArrayIndexOutOfBoundsException(index); |
| 194 | } |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 195 | return mKeys[index]; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Given an index in the range <code>0...size()-1</code>, returns |
| 200 | * the value from the <code>index</code>th key-value mapping that this |
| 201 | * SparseLongArray stores. |
Flavio Lerda | 5771302 | 2013-09-08 18:04:58 +0100 | [diff] [blame] | 202 | * |
| 203 | * <p>The values corresponding to indices in ascending order are guaranteed |
| 204 | * to be associated with keys in ascending order, e.g., |
| 205 | * <code>valueAt(0)</code> will return the value associated with the |
| 206 | * smallest key and <code>valueAt(size()-1)</code> will return the value |
| 207 | * associated with the largest key.</p> |
Kweku Adams | 4be0b1a | 2019-04-25 16:16:34 -0700 | [diff] [blame] | 208 | * |
| 209 | * <p>For indices outside of the range <code>0...size()-1</code>, the behavior is undefined for |
| 210 | * apps targeting {@link android.os.Build.VERSION_CODES#P} and earlier, and an |
| 211 | * {@link ArrayIndexOutOfBoundsException} is thrown for apps targeting |
| 212 | * {@link android.os.Build.VERSION_CODES#Q} and later.</p> |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 213 | */ |
| 214 | public long valueAt(int index) { |
Kweku Adams | 4be0b1a | 2019-04-25 16:16:34 -0700 | [diff] [blame] | 215 | if (index >= mSize && UtilConfig.sThrowExceptionForUpperArrayOutOfBounds) { |
Kweku Adams | 025a166 | 2019-03-30 00:03:17 +0000 | [diff] [blame] | 216 | // The array might be slightly bigger than mSize, in which case, indexing won't fail. |
Kweku Adams | 3858b2d | 2019-04-29 11:47:41 -0700 | [diff] [blame] | 217 | // Check if exception should be thrown outside of the critical path. |
Kweku Adams | 025a166 | 2019-03-30 00:03:17 +0000 | [diff] [blame] | 218 | throw new ArrayIndexOutOfBoundsException(index); |
| 219 | } |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 220 | return mValues[index]; |
| 221 | } |
| 222 | |
| 223 | /** |
| 224 | * Returns the index for which {@link #keyAt} would return the |
| 225 | * specified key, or a negative number if the specified |
| 226 | * key is not mapped. |
| 227 | */ |
| 228 | public int indexOfKey(int key) { |
Dianne Hackborn | 3e82ba1 | 2013-07-16 13:23:55 -0700 | [diff] [blame] | 229 | return ContainerHelpers.binarySearch(mKeys, mSize, key); |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Returns an index for which {@link #valueAt} would return the |
| 234 | * specified key, or a negative number if no keys map to the |
| 235 | * specified value. |
| 236 | * Beware that this is a linear search, unlike lookups by key, |
| 237 | * and that multiple keys can map to the same value and this will |
| 238 | * find only one of them. |
| 239 | */ |
| 240 | public int indexOfValue(long value) { |
| 241 | for (int i = 0; i < mSize; i++) |
| 242 | if (mValues[i] == value) |
| 243 | return i; |
| 244 | |
| 245 | return -1; |
| 246 | } |
| 247 | |
| 248 | /** |
| 249 | * Removes all key-value mappings from this SparseIntArray. |
| 250 | */ |
| 251 | public void clear() { |
| 252 | mSize = 0; |
| 253 | } |
| 254 | |
| 255 | /** |
| 256 | * Puts a key/value pair into the array, optimizing for the case where |
| 257 | * the key is greater than all existing keys in the array. |
| 258 | */ |
| 259 | public void append(int key, long value) { |
| 260 | if (mSize != 0 && key <= mKeys[mSize - 1]) { |
| 261 | put(key, value); |
| 262 | return; |
| 263 | } |
| 264 | |
Adam Lesinski | 776abc2 | 2014-03-07 11:30:59 -0500 | [diff] [blame] | 265 | mKeys = GrowingArrayUtils.append(mKeys, mSize, key); |
| 266 | mValues = GrowingArrayUtils.append(mValues, mSize, value); |
| 267 | mSize++; |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 268 | } |
Dianne Hackborn | 3e82ba1 | 2013-07-16 13:23:55 -0700 | [diff] [blame] | 269 | |
| 270 | /** |
| 271 | * {@inheritDoc} |
| 272 | * |
| 273 | * <p>This implementation composes a string by iterating over its mappings. |
| 274 | */ |
| 275 | @Override |
| 276 | public String toString() { |
| 277 | if (size() <= 0) { |
| 278 | return "{}"; |
| 279 | } |
| 280 | |
| 281 | StringBuilder buffer = new StringBuilder(mSize * 28); |
| 282 | buffer.append('{'); |
| 283 | for (int i=0; i<mSize; i++) { |
| 284 | if (i > 0) { |
| 285 | buffer.append(", "); |
| 286 | } |
| 287 | int key = keyAt(i); |
| 288 | buffer.append(key); |
| 289 | buffer.append('='); |
| 290 | long value = valueAt(i); |
| 291 | buffer.append(value); |
| 292 | } |
| 293 | buffer.append('}'); |
| 294 | return buffer.toString(); |
| 295 | } |
Svetoslav Ganov | 0210785 | 2011-10-03 17:06:56 -0700 | [diff] [blame] | 296 | } |