/
Buffer.scala
232 lines (196 loc) · 7.66 KB
/
Buffer.scala
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
* Scala (https://www.scala-lang.org)
*
* Copyright EPFL and Lightbend, Inc.
*
* Licensed under Apache License 2.0
* (http://www.apache.org/licenses/LICENSE-2.0).
*
* See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*/
package scala.collection
package mutable
import scala.annotation.nowarn
/** A `Buffer` is a growable and shrinkable `Seq`. */
trait Buffer[A]
extends Seq[A]
with SeqOps[A, Buffer, Buffer[A]]
with Growable[A]
with Shrinkable[A]
with IterableFactoryDefaults[A, Buffer] {
override def iterableFactory: SeqFactory[Buffer] = Buffer
override def knownSize: Int = super[Seq].knownSize
//TODO Prepend is a logical choice for a readable name of `+=:` but it conflicts with the renaming of `append` to `add`
/** Prepends a single element at the front of this $coll.
*
* @param elem the element to $add.
* @return the $coll itself
*/
def prepend(elem: A): this.type
/** Appends the given elements to this buffer.
*
* @param elem the element to append.
*/
@`inline` final def append(elem: A): this.type = addOne(elem)
@deprecated("Use appendAll instead", "2.13.0")
@`inline` final def append(elems: A*): this.type = addAll(elems)
/** Appends the elements contained in a iterable object to this buffer.
* @param xs the iterable object containing the elements to append.
*/
@`inline` final def appendAll(xs: IterableOnce[A]): this.type = addAll(xs)
/** Alias for `prepend` */
@`inline` final def +=: (elem: A): this.type = prepend(elem)
def prependAll(elems: IterableOnce[A]): this.type = { insertAll(0, elems); this }
@deprecated("Use prependAll instead", "2.13.0")
@`inline` final def prepend(elems: A*): this.type = prependAll(elems)
/** Alias for `prependAll` */
@inline final def ++=:(elems: IterableOnce[A]): this.type = prependAll(elems)
/** Inserts a new element at a given index into this buffer.
*
* @param idx the index where the new elements is inserted.
* @param elem the element to insert.
* @throws IndexOutOfBoundsException if the index `idx` is not in the valid range
* `0 <= idx <= length`.
*/
@throws[IndexOutOfBoundsException]
def insert(idx: Int, elem: A): Unit
/** Inserts new elements at the index `idx`. Opposed to method
* `update`, this method will not replace an element with a new
* one. Instead, it will insert a new element at index `idx`.
*
* @param idx the index where a new element will be inserted.
* @param elems the iterable object providing all elements to insert.
* @throws IndexOutOfBoundsException if `idx` is out of bounds.
*/
@throws[IndexOutOfBoundsException]
def insertAll(idx: Int, elems: IterableOnce[A]): Unit
/** Removes the element at a given index position.
*
* @param idx the index which refers to the element to delete.
* @return the element that was formerly at index `idx`.
*/
@throws[IndexOutOfBoundsException]
def remove(idx: Int): A
/** Removes the element on a given index position. It takes time linear in
* the buffer size.
*
* @param idx the index which refers to the first element to remove.
* @param count the number of elements to remove.
* @throws IndexOutOfBoundsException if the index `idx` is not in the valid range
* `0 <= idx <= length - count` (with `count > 0`).
* @throws IllegalArgumentException if `count < 0`.
*/
@throws[IndexOutOfBoundsException]
@throws[IllegalArgumentException]
def remove(idx: Int, count: Int): Unit
/** Removes a single element from this buffer, at its first occurrence.
* If the buffer does not contain that element, it is unchanged.
*
* @param x the element to remove.
* @return the buffer itself
*/
def subtractOne (x: A): this.type = {
val i = indexOf(x)
if (i != -1) remove(i)
this
}
/** Removes the first ''n'' elements of this buffer.
*
* @param n the number of elements to remove from the beginning
* of this buffer.
*/
@deprecated("use dropInPlace instead", since = "2.13.4")
def trimStart(n: Int): Unit = dropInPlace(n)
/** Removes the last ''n'' elements of this buffer.
*
* @param n the number of elements to remove from the end
* of this buffer.
*/
@deprecated("use dropRightInPlace instead", since = "2.13.4")
def trimEnd(n: Int): Unit = dropRightInPlace(n)
def patchInPlace(from: Int, patch: scala.collection.IterableOnce[A], replaced: Int): this.type
// +=, ++=, clear inherited from Growable
// Per remark of @ichoran, we should preferably not have these:
//
// def +=:(elem: A): this.type = { insert(0, elem); this }
// def +=:(elem1: A, elem2: A, elems: A*): this.type = elem1 +=: elem2 +=: elems ++=: this
// def ++=:(elems: IterableOnce[A]): this.type = { insertAll(0, elems); this }
def dropInPlace(n: Int): this.type = { remove(0, normalized(n)); this }
def dropRightInPlace(n: Int): this.type = {
val norm = normalized(n)
remove(length - norm, norm)
this
}
def takeInPlace(n: Int): this.type = {
val norm = normalized(n)
remove(norm, length - norm)
this
}
def takeRightInPlace(n: Int): this.type = { remove(0, length - normalized(n)); this }
def sliceInPlace(start: Int, end: Int): this.type = takeInPlace(end).dropInPlace(start)
private def normalized(n: Int): Int = math.min(math.max(n, 0), length)
def dropWhileInPlace(p: A => Boolean): this.type = {
val idx = indexWhere(!p(_))
if (idx < 0) { clear(); this } else dropInPlace(idx)
}
def takeWhileInPlace(p: A => Boolean): this.type = {
val idx = indexWhere(!p(_))
if (idx < 0) this else takeInPlace(idx)
}
def padToInPlace(len: Int, elem: A): this.type = {
while (length < len) +=(elem)
this
}
@nowarn("""cat=deprecation&origin=scala\.collection\.Iterable\.stringPrefix""")
override protected[this] def stringPrefix = "Buffer"
}
trait IndexedBuffer[A] extends IndexedSeq[A]
with IndexedSeqOps[A, IndexedBuffer, IndexedBuffer[A]]
with Buffer[A]
with IterableFactoryDefaults[A, IndexedBuffer] {
override def iterableFactory: SeqFactory[IndexedBuffer] = IndexedBuffer
def flatMapInPlace(f: A => IterableOnce[A]): this.type = {
// There's scope for a better implementation which copies elements in place.
var i = 0
val s = size
val newElems = new Array[IterableOnce[A]](s)
while (i < s) { newElems(i) = f(this(i)); i += 1 }
clear()
i = 0
while (i < s) { ++=(newElems(i)); i += 1 }
this
}
def filterInPlace(p: A => Boolean): this.type = {
var i, j = 0
while (i < size) {
if (p(apply(i))) {
if (i != j) {
this(j) = this(i)
}
j += 1
}
i += 1
}
if (i == j) this else takeInPlace(j)
}
def patchInPlace(from: Int, patch: scala.collection.IterableOnce[A], replaced: Int): this.type = {
val replaced0 = math.min(math.max(replaced, 0), length)
val i = math.min(math.max(from, 0), length)
var j = 0
val iter = patch.iterator
while (iter.hasNext && j < replaced0 && i + j < length) {
update(i + j, iter.next())
j += 1
}
if (iter.hasNext) insertAll(i + j, iter)
else if (j < replaced0) remove(i + j, math.min(replaced0 - j, length - i - j))
this
}
}
@SerialVersionUID(3L)
object Buffer extends SeqFactory.Delegate[Buffer](ArrayBuffer)
@SerialVersionUID(3L)
object IndexedBuffer extends SeqFactory.Delegate[IndexedBuffer](ArrayBuffer)
/** Explicit instantiation of the `Buffer` trait to reduce class file size in subclasses. */
abstract class AbstractBuffer[A] extends AbstractSeq[A] with Buffer[A]