bmssp 0.10.0 → 0.12.0

package/README.md

@@ -1,19 +1,62 @@
-# Tsinghua Single Source Shortest Paths algorithm
+# BMSSP: Bounded Multi-Source Shortest Paths
+[![codecov](https://codecov.io/gh/sirivasv/bmssp-js/branch/main/graph/badge.svg)](https://codecov.io/gh/sirivasv/bmssp-js)
+[![npm version](https://img.shields.io/npm/v/bmssp.svg)](https://www.npmjs.com/package/bmssp)
+[![Docker Image Version](https://img.shields.io/docker/v/sirivasv/bmssp-js?label=docker&sort=semver)](https://hub.docker.com/r/sirivasv/bmssp-js)
+[![GitHub Repo stars](https://img.shields.io/github/stars/sirivasv/bmssp-js?style=social)](https://github.com/sirivasv/bmssp-js/stargazers)
 
-This is a repository containing a simple community driven implementation in Javascript based on the paper written by Duan Ran et. al. from Tsinghua University.
-"Breaking the Sorting Barrier for Directed Single-Source Shortest Paths".
+This repository provides a community-driven JavaScript implementation of the Tsinghua Single Source Shortest Paths algorithm, based on the paper ["Breaking the Sorting Barrier for Directed Single-Source Shortest Paths"](https://dl.acm.org/doi/10.1145/3717823.3718179) by Duan Ran et al. from Tsinghua University.
 
-https://dl.acm.org/doi/10.1145/3717823.3718179
+BMSSP stands for Bounded Multi-Source Shortest Paths.
 
-BMSSP - Bounded multi-source shortest paths.
+## Project Overview
 
-## Abstract
+- **Language:** JavaScript (ES Modules)
+- **Goal:** Provide an easy-to-use, modern implementation of the algorithm, published to [npmjs.com](https://www.npmjs.com/).
+- **Reference:** For more on ES modules, see the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).
 
-We give a deterministic O(mlog2/3n)-time algorithm for single-source shortest paths (SSSP) on directed graphs with real non-negative edge weights in the comparison-addition model. This is the first result to break the O(m+nlogn) time bound of Dijkstra’s algorithm on sparse graphs, showing that Dijkstra’s algorithm is not optimal for SSSP.
 
-## Development Details
+## Installation
 
-This project is mainly focused in Javascript in order to be published to npmjs.com as a JS module (esmodule).
+To install this package, you can use npm:
+
+```bash
+npm install bmssp
+```
+
+## Usage
+
+To use this package, you can import it in your JavaScript code as follows:
+
+```javascript
+// This is a WIP example
+import { BMSSP } from "bmssp";
+
+const myBMSSP = new BMSSP([
+  [0, 1, 50],
+  [1, 2, 75],
+  [0, 2, 25],
+]);
+
+console.log(myBMSSP.graph);
+```
+
+The file must use ECMAScript modules (ESM) syntax and have the `.mjs` file extension. Go to the `examples` directory for more usage examples.
+
+### Using the docker image
+
+You can also use the published docker image and run the example:
+
+```bash
+docker run -it sirivasv/bmssp-js:latest
+```
+
+Or your tests in a pre-configured environment (replace `folder-mytest/` with your tests folder and `index.mjs` with your test file):
+
+```bash
+docker run -it -v ./folder-mytest/:/bmssp-js/folder-mytest/ sirivasv/bmssp-js:latest node /bmssp-js/folder-mytest/index.mjs
+```
+
+Other versions of the docker image can be found on [Docker Hub](https://hub.docker.com/r/sirivasv/bmssp-js/tags).
 
 ### Other Implementations in GitHub
 

package/index.mjs

@@ -1 +1 @@
-export { printMessage, processMessage } from "./src/bmssp.mjs";
+export { BMSSP } from "./src/bmssp.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bmssp",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Javascript package implementation of the bmssp algorithm.",
   "main": "index.mjs",
   "keywords": [

package/src/bmssp.mjs

@@ -1,9 +1,11 @@
-function printMessage(message) {
-  return message;
+class BMSSP {
+  constructor(inputGraph) {
+    this.graph = [];
+    for (let edge of inputGraph) {
+      // Create a deep copy of each edge array
+      this.graph.push([...edge]);
+    }
+  }
 }
 
-function processMessage(message) {
-  return `Processed: ${message}`;
-}
-
-export { printMessage, processMessage };
+export { BMSSP };