X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FCircularArray.ts;h=f84b21aa3ac9d93a19075b8db1a2f889e05bdfa9;hb=8a4f882a2486682b72195ad978ec1d81604b452b;hp=feb5e3e2b66fb99aef38c6d24db1a6c5eafccfe1;hpb=c8eeb62b00988601b40e599745329acb67197750;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts index feb5e3e2..f84b21aa 100644 --- a/src/utils/CircularArray.ts +++ b/src/utils/CircularArray.ts @@ -1,87 +1,96 @@ -// Copyright Jerome Benoit. 2021. All Rights Reserved. +// Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -export const DEFAULT_CIRCULAR_ARRAY_SIZE = Number.MAX_SAFE_INTEGER; +export const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024 -/** Array with a maximum length shifting items when full. */ +/** + * Array with a maximum length and shifting items when full. + */ export class CircularArray extends Array { - public size: number; + public size: number - constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) { - super(); - this.checkSize(size); - this.size = size; + constructor (size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) { + super() + this.checkSize(size) + this.size = size if (arguments.length > 1) { - this.push(...items); + this.push(...items) } } - public push(...items: T[]): number { - const length = super.push(...items); + public push (...items: T[]): number { + const length = super.push(...items) if (length > this.size) { - super.splice(0, length - this.size); + super.splice(0, length - this.size) } - return this.length; + return this.length } - public unshift(...items: T[]): number { - const length = super.unshift(...items); + public unshift (...items: T[]): number { + const length = super.unshift(...items) if (length > this.size) { - super.splice(this.size, items.length); + super.splice(this.size, items.length) } - return this.length; + return this.length } - public concat(...items: (T | ConcatArray)[]): CircularArray { - const concatenatedCircularArray = super.concat( - items as T[] - ) as CircularArray; - concatenatedCircularArray.size = this.size; + public concat (...items: Array>): 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 concatenatedCircularArray; + return concatenatedCircularArray } - public splice(start: number, deleteCount?: number, ...items: T[]): T[] { - let itemsRemoved: T[]; - if (arguments.length >= 3 && typeof deleteCount !== 'undefined') { - itemsRemoved = super.splice(start, deleteCount); - // FIXME: that makes the items insert not in place - this.push(...items); + public splice (start: number, deleteCount?: number, ...items: T[]): CircularArray { + let itemsRemoved: T[] = [] + if (arguments.length >= 3 && deleteCount != null) { + 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); + itemsRemoved = super.splice(start, deleteCount) } else { - itemsRemoved = super.splice(start); + itemsRemoved = super.splice(start) } - return itemsRemoved; + return itemsRemoved as CircularArray } - public resize(size: number): void { - this.checkSize(size); + public resize (size: number): void { + this.checkSize(size) if (size === 0) { - this.length = 0; + this.length = 0 } else if (size < this.size) { for (let i = size; i < this.size; i++) { - super.pop(); + super.pop() } } - this.size = size; + this.size = size } - public empty(): boolean { - return this.length === 0; + public empty (): boolean { + return this.length === 0 } - public full(): boolean { - return this.length === this.size; + public full (): boolean { + return this.length === this.size } - private checkSize(size: number) { + 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'); + throw new RangeError(`Invalid circular array size: ${size} < 0`) } } }