docs: refinements

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index da1459f96be3877b3faf22913f548b920b4979e3..c7efbc22638c59b55bd5e7508f3e19877c3c12a1 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,4 +1,7 @@
-import type { WorkerChoiceStrategyOptions } from './pools/selection-strategies/selection-strategies-types'
+import type {
+  MeasurementStatisticsRequirements,
+  WorkerChoiceStrategyOptions
+} from './pools/selection-strategies/selection-strategies-types'
 
 /**
  * An intentional empty function.
@@ -12,7 +15,19 @@ export const EMPTY_FUNCTION: () => void = Object.freeze(() => {
  */
 export const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions =
   {
-    medRunTime: false
+    runTime: { median: false },
+    waitTime: { median: false },
+    elu: { median: false }
+  }
+
+/**
+ * Default measurement statistics requirements.
+ */
+export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsRequirements =
+  {
+    aggregate: false,
+    average: false,
+    median: false
   }
 
 /**
@@ -29,9 +44,6 @@ export const median = (dataSet: number[]): number => {
     return dataSet[0]
   }
   const sortedDataSet = dataSet.slice().sort((a, b) => a - b)
-  if (sortedDataSet.length % 2 === 0) {
-    return sortedDataSet[sortedDataSet.length / 2]
-  }
   return (
     (sortedDataSet[(sortedDataSet.length - 1) >> 1] +
       sortedDataSet[sortedDataSet.length >> 1]) /
@@ -39,6 +51,12 @@ export const median = (dataSet: number[]): number => {
   )
 }
 
+/**
+ * Is the given object a plain object?
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the given object is a plain object, `false` otherwise.
+ */
 export const isPlainObject = (obj: unknown): boolean =>
   typeof obj === 'object' &&
   obj !== null &&