1 // Copyright Jerome Benoit. 2021. All Rights Reserved.
3 export const DEFAULT_CIRCULAR_ARRAY_SIZE
= Number.MAX_SAFE_INTEGER
;
6 * Array with a maximum length shifting items when full.
8 export class CircularArray
<T
> extends Array<T
> {
11 constructor(size
: number = DEFAULT_CIRCULAR_ARRAY_SIZE
, ...items
: T
[]) {
15 if (arguments.length
> 1) {
20 public push(...items
: T
[]): number {
21 const length
= super.push(...items
);
22 if (length
> this.size
) {
23 super.splice(0, length
- this.size
);
28 public unshift(...items
: T
[]): number {
29 const length
= super.unshift(...items
);
30 if (length
> this.size
) {
31 super.splice(this.size
, items
.length
);
36 public concat(...items
: (T
| ConcatArray
<T
>)[]): CircularArray
<T
> {
37 const concatenatedCircularArray
= super.concat(items
as T
[]) as CircularArray
<T
>;
38 concatenatedCircularArray
.size
= this.size
;
39 if (concatenatedCircularArray
.length
> concatenatedCircularArray
.size
) {
40 concatenatedCircularArray
.splice(
42 concatenatedCircularArray
.length
- concatenatedCircularArray
.size
45 return concatenatedCircularArray
;
48 public splice(start
: number, deleteCount
?: number, ...items
: T
[]): T
[] {
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
54 } else if (arguments.length
=== 2) {
55 itemsRemoved
= super.splice(start
, deleteCount
);
57 itemsRemoved
= super.splice(start
);
62 public resize(size
: number): void {
66 } else if (size
< this.size
) {
67 for (let i
= size
; i
< this.size
; i
++) {
74 public empty(): boolean {
75 return this.length
=== 0;
78 public full(): boolean {
79 return this.length
=== this.size
;
82 private checkSize(size
: number) {
84 throw new RangeError('Invalid circular array size');