X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FCircularArray.ts;h=4fafe5280a78cd849667f94e12e7e198e16f2dc7;hb=9f139e99d5c59592faad743f3285b26acc03b7c9;hp=c46b06b6cb8983bb2cab53bf1a0e248a0452d005;hpb=1699e597e585e54f8f0f540656597d6427080e0c;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts index c46b06b6..4fafe528 100644 --- a/src/utils/CircularArray.ts +++ b/src/utils/CircularArray.ts @@ -1,49 +1,78 @@ -const DEFAULT_CIRCULAR_ARRAY_SIZE = 2000; +// Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -export default class CircularArray extends Array { +export const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024; + +/** + * Array with a maximum length and shifting items when full. + */ +export class CircularArray extends Array { public size: number; - constructor(size?: number) { + constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) { super(); - this.size = size ?? DEFAULT_CIRCULAR_ARRAY_SIZE; + this.checkSize(size); + this.size = size; + if (arguments.length > 1) { + this.push(...items); + } } public push(...items: T[]): number { - if (this.length + items.length > this.size) { - super.splice(0, (this.length + items.length) - this.size); + const length = super.push(...items); + if (length > this.size) { + super.splice(0, length - this.size); } - return super.push(...items); + return this.length; } public unshift(...items: T[]): number { - if (this.length + items.length > this.size) { - super.splice(this.size - items.length, (this.length + items.length) - this.size); + const length = super.unshift(...items); + if (length > this.size) { + super.splice(this.size, items.length); } - return super.unshift(...items); + return this.length; } - public concat(...items: (T | ConcatArray)[]): T[] { - if (this.length + items.length > this.size) { - super.splice(0, (this.length + items.length) - this.size); + public concat(...items: (T | ConcatArray)[]): CircularArray { + const concatenatedCircularArray = super.concat(items as T[]) as CircularArray; + concatenatedCircularArray.size = this.size; + if (concatenatedCircularArray.length > concatenatedCircularArray.size) { + concatenatedCircularArray.splice( + 0, + concatenatedCircularArray.length - concatenatedCircularArray.size, + ); } - return super.concat(items as T[]); + return concatenatedCircularArray; } - public splice(start: number, deleteCount?: number, ...items: T[]): T[] { - this.push(...items); - return super.splice(start, deleteCount); + public splice(start: number, deleteCount?: number, ...items: T[]): CircularArray { + let itemsRemoved: T[] = []; + if (arguments.length >= 3 && deleteCount !== undefined) { + itemsRemoved = super.splice(start, deleteCount, ...items); + if (this.length > this.size) { + const itemsOverflowing = super.splice(0, this.length - this.size); + itemsRemoved = new CircularArray( + itemsRemoved.length + itemsOverflowing.length, + ...itemsRemoved, + ...itemsOverflowing, + ); + } + } else if (arguments.length === 2) { + itemsRemoved = super.splice(start, deleteCount); + } else { + itemsRemoved = super.splice(start); + } + return itemsRemoved as CircularArray; } public resize(size: number): void { - if (size < 0) { - throw new RangeError( - 'circular array size does not allow negative values.' - ); - } + this.checkSize(size); if (size === 0) { this.length = 0; - } else if (size !== this.size) { - this.slice(-size); + } else if (size < this.size) { + for (let i = size; i < this.size; i++) { + super.pop(); + } } this.size = size; } @@ -55,4 +84,13 @@ export default class CircularArray extends Array { public full(): boolean { return this.length === this.size; } + + private checkSize(size: number): void { + if (!Number.isSafeInteger(size)) { + throw new TypeError(`Invalid circular array size: ${size} is not a safe integer`); + } + if (size < 0) { + throw new RangeError(`Invalid circular array size: ${size} < 0`); + } + } }