X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FCircularArray.ts;h=4fafe5280a78cd849667f94e12e7e198e16f2dc7;hb=473045b1407bdddde5728f3ef3c1e6b078e18e30;hp=434a8f49b57439a127a56d568ec6f570765d9073;hpb=b6633b4c519a0aa579ed9c0653fa78fe99f6487b;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts
index 434a8f49..4fafe528 100644
--- a/src/utils/CircularArray.ts
+++ b/src/utils/CircularArray.ts
@@ -1,24 +1,96 @@
-import Constants from './Constants';
+// Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-export default class CircularArray<T> extends Array<T> {
+export const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024;
+
+/**
+ * Array with a maximum length and shifting items when full.
+ */
+export class CircularArray<T> extends Array<T> {
   public size: number;
 
-  constructor(size: number = Constants.MAXIMUM_MEASUREMENTS_NUMBER) {
+  constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) {
     super();
+    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;
+  }
+
+  public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> {
+    const concatenatedCircularArray = super.concat(items as T[]) as CircularArray<T>;
+    concatenatedCircularArray.size = this.size;
+    if (concatenatedCircularArray.length > concatenatedCircularArray.size) {
+      concatenatedCircularArray.splice(
+        0,
+        concatenatedCircularArray.length - concatenatedCircularArray.size,
+      );
+    }
+    return concatenatedCircularArray;
   }
 
-  push(...items: T[]): number {
-    if (this.length + items.length > this.size) {
-      super.splice(0, (this.length + items.length) - this.size);
+  public splice(start: number, deleteCount?: number, ...items: T[]): CircularArray<T> {
+    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<T>(
+          itemsRemoved.length + itemsOverflowing.length,
+          ...itemsRemoved,
+          ...itemsOverflowing,
+        );
+      }
+    } else if (arguments.length === 2) {
+      itemsRemoved = super.splice(start, deleteCount);
+    } else {
+      itemsRemoved = super.splice(start);
     }
-    return super.push(...items);
+    return itemsRemoved as CircularArray<T>;
+  }
+
+  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();
+      }
+    }
+    this.size = size;
   }
 
-  unshift(...items: T[]): number {
-    if (this.length + items.length > this.size) {
-      super.splice(this.size - items.length, (this.length + items.length) - this.size);
+  public empty(): boolean {
+    return this.length === 0;
+  }
+
+  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`);
     }
-    return super.unshift(...items);
   }
 }