@iyulab/u-routing 0.1.0 → 0.2.0

package/README.md

@@ -118,6 +118,69 @@ u-routing
 - Ropke, S. & Pisinger, D. (2006). "An Adaptive Large Neighborhood Search Heuristic for the Pickup and Delivery Problem with Time Windows"
 - Shaw, P. (1998). "Using Constraint Programming and Local Search Methods to Solve Vehicle Routing Problems"
 
+## WebAssembly / npm
+
+Available as an npm package via [wasm-pack](https://rustwasm.github.io/wasm-pack/).
+
+```bash
+npm install @iyulab/u-routing
+```
+
+### Quick Start
+
+```javascript
+import init, { solve_vrp } from '@iyulab/u-routing';
+
+await init();
+const result = solve_vrp({
+  customers: [
+    { id: 1, x: 1.0, y: 2.0, demand: 10 },
+    { id: 2, x: 3.0, y: 4.0, demand: 15 },
+  ],
+  vehicles: [{ capacity: 100 }],
+  depot: { x: 0.0, y: 0.0 },
+  method: "nn"
+});
+```
+
+### Functions
+
+#### `solve_vrp(input) -> VrpOutput`
+
+Solve a capacitated VRP with optional time windows. Four solver methods available.
+
+**Methods:** `"nn"` (Nearest Neighbor), `"savings"` (Clarke-Wright), `"ga"` (Genetic Algorithm + Split DP), `"alns"` (Adaptive Large Neighborhood Search).
+
+**Input:**
+```json
+{
+  "customers": [
+    { "id": 1, "x": 1.0, "y": 2.0, "demand": 10, "service_time": 0.5, "time_window": [8.0, 12.0] }
+  ],
+  "vehicles": [{ "capacity": 100 }],
+  "depot": { "x": 0.0, "y": 0.0 },
+  "method": "ga",
+  "config": {
+    "population_size": 50, "max_generations": 200,
+    "mutation_rate": 0.1, "elite_ratio": 0.1,
+    "max_iterations": 500, "seed": 42
+  }
+}
+```
+
+GA uses `population_size`, `max_generations`, `mutation_rate`, `elite_ratio`. ALNS uses `max_iterations`. Both accept `seed`.
+
+**Output:**
+```json
+{
+  "routes": [[1, 3, 5], [2, 4]],
+  "total_distance": 42.5,
+  "num_vehicles": 2,
+  "method_used": "ga",
+  "computation_time_ms": 120.0
+}
+```
+
 ## Related
 
 - [u-numflow](https://crates.io/crates/u-numflow) — Mathematical optimization primitives

package/package.json

@@ -5,7 +5,7 @@
     "iyulab"
   ],
   "description": "Vehicle routing optimization: TSP, CVRP, VRPTW with constructive heuristics, local search, GA, and ALNS.",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/u_routing.d.ts

@@ -7,8 +7,15 @@
  * # Arguments
  * * `problem_json` — A JS object matching the VRP input schema.
  *
+ * # Supported methods
+ * - `"nn"` — Nearest Neighbor (default, fast)
+ * - `"savings"` — Clarke-Wright Savings
+ * - `"ga"` — Genetic Algorithm with Prins split + local search
+ * - `"alns"` — Adaptive Large Neighborhood Search + local search
+ *
  * # Returns
- * A JS object with `routes`, `total_distance`, and `num_vehicles`.
+ * A JS object with `routes`, `total_distance`, `num_vehicles`,
+ * `method_used`, and `computation_time_ms`.
  *
  * # Errors
  * Returns a `JsValue` string describing the error if input is invalid.

package/u_routing_bg.js

@@ -4,8 +4,15 @@
  * # Arguments
  * * `problem_json` — A JS object matching the VRP input schema.
  *
+ * # Supported methods
+ * - `"nn"` — Nearest Neighbor (default, fast)
+ * - `"savings"` — Clarke-Wright Savings
+ * - `"ga"` — Genetic Algorithm with Prins split + local search
+ * - `"alns"` — Adaptive Large Neighborhood Search + local search
+ *
  * # Returns
- * A JS object with `routes`, `total_distance`, and `num_vehicles`.
+ * A JS object with `routes`, `total_distance`, `num_vehicles`,
+ * `method_used`, and `computation_time_ms`.
  *
  * # Errors
  * Returns a `JsValue` string describing the error if input is invalid.
@@ -106,6 +113,9 @@ export function __wbg_done_08ce71ee07e3bd17(arg0) {
     const ret = arg0.done;
     return ret;
 }
+export function __wbg_getRandomValues_3f44b700395062e5() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
+}, arguments); }
 export function __wbg_get_326e41e095fb2575() { return handleError(function (arg0, arg1) {
     const ret = Reflect.get(arg0, arg1);
     return ret;
@@ -178,6 +188,10 @@ export function __wbg_next_e01a967809d1aa68(arg0) {
     const ret = arg0.next;
     return ret;
 }
+export function __wbg_now_16f0c993d5dd6c27() {
+    const ret = Date.now();
+    return ret;
+}
 export function __wbg_prototypesetcall_d62e5099504357e6(arg0, arg1, arg2) {
     Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
 }