feat: add xyObjectNormedY

Author: lpatiny

src/__tests__/__snapshots__/index.test.ts.snap

@@ -134,6 +134,7 @@ exports[`test existence of exported functions 1`] = `
   "xyObjectMinMaxValues",
   "xyObjectMinXPoint",
   "xyObjectMinYPoint",
+  "xyObjectNormedY",
   "xyObjectSlotX",
   "xyObjectSortX",
   "xyObjectSumY",

src/xyObject/__tests__/xyObjectNormedY.test.ts

@@ -0,0 +1,19 @@
+import { expect, test } from 'vitest';
+
+import { xyObjectNormedY } from '../xyObjectNormedY';
+
+test('xyObjectNormedY', () => {
+  const arrayXY = [
+    { x: 1, y: 1 },
+    { x: 2, y: 2 },
+    { x: 3, y: 3 },
+    { x: 4, y: 4 },
+  ];
+  const result = xyObjectNormedY(arrayXY, { algorithm: 'max', value: 100 });
+  expect(result).toStrictEqual([
+    { x: 1, y: 25 },
+    { x: 2, y: 50 },
+    { x: 3, y: 75 },
+    { x: 4, y: 100 },
+  ]);
+});

src/xyObject/index.ts

@@ -6,6 +6,7 @@ export * from './xyObjectMaxYPoint';
 export * from './xyObjectMinMaxValues';
 export * from './xyObjectMinXPoint';
 export * from './xyObjectMinYPoint';
+export * from './xyObjectNormedY';
 export * from './xyObjectSlotX';
 export * from './xyObjectSortX';
 export * from './xyObjectSumY';

src/xyObject/xyObjectNormedY.ts

@@ -0,0 +1,23 @@
+import type { Point } from '../types';
+import { xNormed } from '../x/xNormed';
+import type { XNormedOptions } from '../x/xNormed';
+
+/**
+ * Resize the Y values of the points to be normalized.
+ * @param points - array of points {x,y}
+ * @param options
+ * @returns - array of points {x,y} with normalized Y values
+ */
+export function xyObjectNormedY(
+  points: Point[],
+  options?: XNormedOptions,
+): Point[] {
+  points = structuredClone(points);
+
+  const ys = points.map((point) => point.y);
+  const normalizedYs = xNormed(ys, options);
+  for (let i = 0; i < points.length; i++) {
+    points[i].y = normalizedYs[i];
+  }
+  return points;
+}