Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
b49422c6 | 3 | export const DEFAULT_CIRCULAR_ARRAY_SIZE = Number.MAX_SAFE_INTEGER; |
edfb206c | 4 | |
a01c18a0 | 5 | /** Array with a maximum length shifting items when full. */ |
ef72d3f5 | 6 | export class CircularArray<T> extends Array<T> { |
365f6bc9 | 7 | public size: number; |
edfb206c | 8 | |
534434b0 | 9 | constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) { |
edfb206c | 10 | super(); |
534434b0 JB |
11 | this.checkSize(size); |
12 | this.size = size; | |
13 | if (arguments.length > 1) { | |
14 | this.push(...items); | |
15 | } | |
edfb206c JB |
16 | } |
17 | ||
d43a619b | 18 | public push(...items: T[]): number { |
534434b0 JB |
19 | const length = super.push(...items); |
20 | if (length > this.size) { | |
21 | super.splice(0, length - this.size); | |
edfb206c | 22 | } |
534434b0 | 23 | return this.length; |
edfb206c JB |
24 | } |
25 | ||
d43a619b | 26 | public unshift(...items: T[]): number { |
534434b0 JB |
27 | const length = super.unshift(...items); |
28 | if (length > this.size) { | |
29 | super.splice(this.size, items.length); | |
edfb206c | 30 | } |
35e15933 | 31 | return this.length; |
edfb206c | 32 | } |
c70ff58d | 33 | |
534434b0 JB |
34 | public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> { |
35 | const concatenatedCircularArray = super.concat( | |
36 | items as T[] | |
37 | ) as CircularArray<T>; | |
38 | concatenatedCircularArray.size = this.size; | |
39 | if (concatenatedCircularArray.length > concatenatedCircularArray.size) { | |
40 | concatenatedCircularArray.splice( | |
41 | 0, | |
9be37455 | 42 | concatenatedCircularArray.length - concatenatedCircularArray.size |
534434b0 | 43 | ); |
c70ff58d | 44 | } |
534434b0 | 45 | return concatenatedCircularArray; |
c70ff58d JB |
46 | } |
47 | ||
d43a619b | 48 | public splice(start: number, deleteCount?: number, ...items: T[]): T[] { |
534434b0 JB |
49 | let itemsRemoved: T[]; |
50 | if (arguments.length >= 3 && typeof deleteCount !== 'undefined') { | |
51 | itemsRemoved = super.splice(start, deleteCount); | |
52 | // FIXME: that makes the items insert not in place | |
53 | this.push(...items); | |
54 | } else if (arguments.length === 2) { | |
55 | itemsRemoved = super.splice(start, deleteCount); | |
56 | } else { | |
57 | itemsRemoved = super.splice(start); | |
58 | } | |
59 | return itemsRemoved; | |
c70ff58d | 60 | } |
d43a619b JB |
61 | |
62 | public resize(size: number): void { | |
534434b0 | 63 | this.checkSize(size); |
d43a619b JB |
64 | if (size === 0) { |
65 | this.length = 0; | |
534434b0 JB |
66 | } else if (size < this.size) { |
67 | for (let i = size; i < this.size; i++) { | |
68 | super.pop(); | |
69 | } | |
d43a619b JB |
70 | } |
71 | this.size = size; | |
72 | } | |
73 | ||
74 | public empty(): boolean { | |
75 | return this.length === 0; | |
76 | } | |
77 | ||
78 | public full(): boolean { | |
79 | return this.length === this.size; | |
80 | } | |
534434b0 JB |
81 | |
82 | private checkSize(size: number) { | |
83 | if (size < 0) { | |
84 | throw new RangeError('Invalid circular array size'); | |
85 | } | |
86 | } | |
edfb206c | 87 | } |