Added graph object to the NextWeightFnParams ...

Author: ravann

README.md

@@ -201,8 +201,8 @@ console.log(result.weight); // Prints the total weight of the path
 Calculates the weight based on the custom function.
 
 ```javascript
-import type { WeightParams } from '../../types.js';
-function multiplyWeightFunction(wp: WeightParams): number {
+import type { NextWeightFnParams } from '../../types.js';
+function multiplyWeightFunction(wp: NextWeightFnParams): number {
     if (wp.currentPathWeight === undefined) {
         return wp.edgeWeight;
     }

src/algorithms/shortestPath/getPath.ts

@@ -40,7 +40,7 @@ export function getPath<Node, LinkProps>(
 
     nodeList.push(node);
     const edgeWeight = graph.getEdgeWeight(currentNode, node)
-    totalWeight = nextWeightFn({edgeWeight, currentPathWeight: totalWeight, hop });
+    totalWeight = nextWeightFn({edgeWeight, currentPathWeight: totalWeight, hop: hop,  sourceGraph: graph});
     node = currentNode;
     hop++;
   }

src/algorithms/shortestPath/shortestPath.spec.ts

@@ -109,12 +109,14 @@ describe("Dijkstra's Shortest Path Algorithm", function () {
 
 describe('addWeightFunction', () => {
   it('should return edgeWeight if currentPathWeight is undefined', () => {
-    const params = { edgeWeight: 5, currentPathWeight: undefined, hop: 1 };
+    const graph = new Graph();
+    const params = { edgeWeight: 5, currentPathWeight: undefined, hop: 1, sourceGraph: graph };
     expect(addWeightFunction(params)).toBe(5);
   });
 
   it('should return the sum of edgeWeight and currentPathWeight', () => {
-    const params = { edgeWeight: 5, currentPathWeight: 10, hop: 1 };
+    const graph = new Graph()
+    const params = { edgeWeight: 5, currentPathWeight: 10, hop: 1, sourceGraph: graph };
     expect(addWeightFunction(params)).toBe(15);
   });
 });
@@ -154,8 +156,8 @@ describe('shortestPath with custom weight functions', () => {
     const graph = new Graph().addEdge('a', 'b', 1).addEdge('b', 'c', 2);
     shortestPath(graph, 'a', 'c', customWeightFn);
 
-    expect(customWeightFn).toHaveBeenCalledWith({ edgeWeight: 2, currentPathWeight: undefined, hop: 1 });
-    expect(customWeightFn).toHaveBeenCalledWith({ edgeWeight: 1, currentPathWeight: 2, hop: 2 });
+    expect(customWeightFn).toHaveBeenCalledWith({ edgeWeight: 2, currentPathWeight: undefined, hop: 1, sourceGraph: graph });
+    expect(customWeightFn).toHaveBeenCalledWith({ edgeWeight: 1, currentPathWeight: 2, hop: 2, sourceGraph: graph });
   });
 
   it('should compute shortest path with a custom weight function in a graph with multiple paths', () => {

src/types.ts

@@ -1,3 +1,5 @@
+import { Graph } from './Graph.js';
+
 export type EdgeWeight = number;
 
 export type Edge<NodeIdentity = unknown, Props = unknown> = {
@@ -19,8 +21,9 @@ export type SerializedInput<Node = unknown, LinkProps = unknown> = {
 
 export type NoInfer<T> = [T][T extends any ? 0 : never];
 
-export type NextWeightFnParams = {
+export type NextWeightFnParams<Node = unknown, LinkProps = unknown> = {
   edgeWeight: EdgeWeight;
   currentPathWeight: EdgeWeight | undefined;
   hop: number;
+  sourceGraph: Graph<Node, LinkProps>;
 };