X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FCircularArray.ts;h=4fafe5280a78cd849667f94e12e7e198e16f2dc7;hb=42b8cf5cdca8eaab1e7442f7c92c2a5ed97434f6;hp=535fb00e5cd34c811d03e96125e608d4ae6693d3;hpb=1af50fac1ab71fed19f11864d1644261046698a3;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts index 535fb00e..4fafe528 100644 --- a/src/utils/CircularArray.ts +++ b/src/utils/CircularArray.ts @@ -1,36 +1,96 @@ +// Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -export default class CircularArray extends Array { - size: number; - private readonly maximumCircularArraySize = 2000; +export const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024; - constructor(size?: number) { +/** + * Array with a maximum length and shifting items when full. + */ +export class CircularArray extends Array { + public size: number; + + constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) { super(); - this.size = size && size <= this.maximumCircularArraySize ? size : this.maximumCircularArraySize; + this.checkSize(size); + this.size = size; + if (arguments.length > 1) { + this.push(...items); + } + } + + public push(...items: T[]): number { + const length = super.push(...items); + if (length > this.size) { + super.splice(0, length - this.size); + } + return this.length; + } + + public unshift(...items: T[]): number { + const length = super.unshift(...items); + if (length > this.size) { + super.splice(this.size, items.length); + } + return this.length; } - push(...items: T[]): number { - 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.push(...items); + return concatenatedCircularArray; } - unshift(...items: T[]): number { - if (this.length + items.length > this.size) { - super.splice(this.size - items.length, (this.length + items.length) - this.size); + 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 super.unshift(...items); + return itemsRemoved as CircularArray; } - concat(...items: (T | ConcatArray)[]): T[] { - if (this.length + items.length > this.size) { - super.splice(0, (this.length + items.length) - this.size); + public resize(size: number): void { + this.checkSize(size); + if (size === 0) { + this.length = 0; + } else if (size < this.size) { + for (let i = size; i < this.size; i++) { + super.pop(); + } } - return super.concat(items as T[]); + this.size = size; + } + + public empty(): boolean { + return this.length === 0; } - splice(start: number, deleteCount?: number, ...items: T[]): T[] { - this.push(...items); - return super.splice(start, deleteCount); + 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`); + } } }