refactor(simulator): add more default values to ATG

[e-mobility-charging-stations-simulator.git] / src / utils / Utils.ts

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index ab2a8a5f26302bf23d52aa3bf0a21e407d29ace8..3d8c73bdf0cdbeec9516dd079832587a0696ebba 100644 (file)
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -3,10 +3,10 @@ import util from 'node:util';
 
 import clone from 'just-clone';
 
-import Constants from './Constants';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
+import { Constants } from './Constants';
+import { WebSocketCloseEventStatusString } from '../types';
 
-export default class Utils {
+export class Utils {
   private constructor() {
     // This is intentional
   }
@@ -128,8 +128,7 @@ export default class Utils {
     if (max - min === Infinity) {
       throw new RangeError('Invalid interval');
     }
-    const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff;
-    return randomPositiveFloat * (max - min) + min;
+    return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min;
   }
 
   public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number {
@@ -186,6 +185,14 @@ export default class Utils {
     return clone<T>(object);
   }
 
+  public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
+    return Utils.isObject(object) && Object.hasOwn(object as object, property);
+  }
+
+  public static isCFEnvironment(): boolean {
+    return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION);
+  }
+
   public static isIterable<T>(obj: T): boolean {
     return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
   }
@@ -214,14 +221,12 @@ export default class Utils {
     return value == null;
   }
 
-  public static isEmptyArray(object: unknown | unknown[]): boolean {
-    if (!Array.isArray(object)) {
-      return true;
-    }
-    if (object.length > 0) {
-      return false;
-    }
-    return true;
+  public static isEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length === 0;
+  }
+
+  public static isNotEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length > 0;
   }
 
   public static isEmptyObject(obj: object): boolean {
@@ -243,9 +248,9 @@ export default class Utils {
    * @param retryNumber - the number of retries that have already been attempted
    * @returns delay in milliseconds
    */
-  public static exponentialDelay(retryNumber = 0): number {
+  public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number {
     const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay
+    const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay
     return delay + randomSum;
   }
 
@@ -329,4 +334,59 @@ export default class Utils {
     }
     return '(Unknown)';
   }
+
+  public static median(dataSet: number[]): number {
+    if (Utils.isEmptyArray(dataSet)) {
+      return 0;
+    }
+    if (Array.isArray(dataSet) === true && dataSet.length === 1) {
+      return dataSet[0];
+    }
+    const sortedDataSet = dataSet.slice().sort((a, b) => a - b);
+    return (
+      (sortedDataSet[(sortedDataSet.length - 1) >> 1] + sortedDataSet[sortedDataSet.length >> 1]) /
+      2
+    );
+  }
+
+  // TODO: use order statistics tree https://en.wikipedia.org/wiki/Order_statistic_tree
+  public static percentile(dataSet: number[], percentile: number): number {
+    if (percentile < 0 && percentile > 100) {
+      throw new RangeError('Percentile is not between 0 and 100');
+    }
+    if (Utils.isEmptyArray(dataSet)) {
+      return 0;
+    }
+    const sortedDataSet = dataSet.slice().sort((a, b) => a - b);
+    if (percentile === 0 || sortedDataSet.length === 1) {
+      return sortedDataSet[0];
+    }
+    if (percentile === 100) {
+      return sortedDataSet[sortedDataSet.length - 1];
+    }
+    const percentileIndexBase = (percentile / 100) * (sortedDataSet.length - 1);
+    const percentileIndexInteger = Math.floor(percentileIndexBase);
+    if (!Utils.isNullOrUndefined(sortedDataSet[percentileIndexInteger + 1])) {
+      return (
+        sortedDataSet[percentileIndexInteger] +
+        (percentileIndexBase - percentileIndexInteger) *
+          (sortedDataSet[percentileIndexInteger + 1] - sortedDataSet[percentileIndexInteger])
+      );
+    }
+    return sortedDataSet[percentileIndexInteger];
+  }
+
+  public static stdDeviation(dataSet: number[]): number {
+    let totalDataSet = 0;
+    for (const data of dataSet) {
+      totalDataSet += data;
+    }
+    const dataSetMean = totalDataSet / dataSet.length;
+    let totalGeometricDeviation = 0;
+    for (const data of dataSet) {
+      const deviation = data - dataSetMean;
+      totalGeometricDeviation += deviation * deviation;
+    }
+    return Math.sqrt(totalGeometricDeviation / dataSet.length);
+  }
 }