@iyulab/u-metaheur 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 iyulab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# u-metaheur
+
+**Domain-agnostic metaheuristic optimization framework**
+
+[![Crates.io](https://img.shields.io/crates/v/u-metaheur.svg)](https://crates.io/crates/u-metaheur)
+[![docs.rs](https://docs.rs/u-metaheur/badge.svg)](https://docs.rs/u-metaheur)
+[![CI](https://github.com/iyulab/u-metaheur/actions/workflows/ci.yml/badge.svg)](https://github.com/iyulab/u-metaheur/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+## Overview
+
+u-metaheur provides generic implementations of common metaheuristic algorithms. It contains no domain-specific concepts — scheduling, nesting, routing, etc. are defined by the user through trait implementations.
+
+## Algorithms
+
+| Module | Algorithm | Description |
+|--------|-----------|-------------|
+| `ga` | Genetic Algorithm | Population-based evolutionary optimization with pluggable selection, crossover, and mutation operators |
+| `brkga` | BRKGA | Biased Random-Key GA — user implements only a decoder; all evolutionary mechanics are handled generically |
+| `sa` | Simulated Annealing | Single-solution trajectory optimization with pluggable cooling schedules |
+| `alns` | ALNS | Adaptive Large Neighborhood Search — destroy/repair operators with adaptive weight selection |
+| `cp` | Constraint Programming | Domain-agnostic modeling layer for constrained optimization with interval, integer, and boolean variables |
+| `dispatching` | Dispatching | Generic priority rule composition engine for multi-rule item ranking |
+
+## Key Traits
+
+```rust
+// GA — implement these for your domain
+trait Chromosome: Clone + Send + Sync {
+    fn fitness(&self) -> f64;
+}
+trait Crossover<C: Chromosome> {
+    fn crossover(&self, parent1: &C, parent2: &C, rng: &mut Rng) -> C;
+}
+trait Mutation<C: Chromosome> {
+    fn mutate(&self, chromosome: &mut C, rng: &mut Rng);
+}
+
+// BRKGA — implement only the decoder
+trait BrkgaDecoder: Send + Sync {
+    type Solution;
+    fn decode(&self, keys: &[f64]) -> Self::Solution;
+    fn fitness(&self, solution: &Self::Solution) -> f64;
+}
+
+// ALNS — implement destroy and repair operators
+trait DestroyOperator<S> {
+    fn destroy(&self, solution: &S, rng: &mut Rng) -> S;
+}
+trait RepairOperator<S> {
+    fn repair(&self, solution: &S, rng: &mut Rng) -> S;
+}
+```
+
+## Features
+
+- **`serde`** — Enable serde serialization for algorithm parameters
+
+## Quick Start
+
+```toml
+[dependencies]
+u-metaheur = { git = "https://github.com/iyulab/u-metaheur" }
+
+# with serde support
+u-metaheur = { git = "https://github.com/iyulab/u-metaheur", features = ["serde"] }
+```
+
+## Build & Test
+
+```bash
+cargo build
+cargo test
+cargo bench  # criterion benchmarks
+```
+
+## Dependencies
+
+- [u-numflow](https://github.com/iyulab/u-numflow) — Mathematical primitives (statistics, RNG)
+- `rand` 0.9 — Random number generation
+- `rayon` 1.10 — Parallel computation
+- `serde` 1.0 — Serialization (optional)
+
+## License
+
+MIT License — see [LICENSE](LICENSE).
+
+## Related
+
+- [u-numflow](https://github.com/iyulab/u-numflow) — Mathematical primitives
+- [u-geometry](https://github.com/iyulab/u-geometry) — Computational geometry
+- [u-schedule](https://github.com/iyulab/u-schedule) — Scheduling framework
+- [u-nesting](https://github.com/iyulab/U-Nesting) — 2D/3D nesting and bin packing

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@iyulab/u-metaheur",
+  "type": "module",
+  "collaborators": [
+    "iyulab"
+  ],
+  "description": "Domain-agnostic metaheuristic optimization framework: GA, BRKGA, SA, ALNS.",
+  "version": "0.1.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iyulab/u-metaheur"
+  },
+  "files": [
+    "u_metaheur_bg.wasm",
+    "u_metaheur.js",
+    "u_metaheur_bg.js",
+    "u_metaheur.d.ts"
+  ],
+  "main": "u_metaheur.js",
+  "types": "u_metaheur.d.ts",
+  "sideEffects": [
+    "./u_metaheur.js",
+    "./snippets/*"
+  ],
+  "keywords": [
+    "optimization",
+    "genetic-algorithm",
+    "metaheuristic",
+    "evolutionary"
+  ]
+}

package/u_metaheur.d.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Runs a Genetic Algorithm for TSP.
+ *
+ * # Arguments
+ * `config_json` — JS object with fields:
+ * - `nodes`: `[[x, y], ...]` (required)
+ * - `population_size`: integer (default 100)
+ * - `generations`: integer (default 200)
+ * - `mutation_rate`: float 0–1 (default 0.05)
+ *
+ * # Returns
+ * JS object with `best_distance`, `best_tour`, `generations_run`.
+ */
+export function run_ga(config_json: any): any;
+
+/**
+ * Runs Simulated Annealing for TSP.
+ *
+ * Uses geometric cooling (`T *= cooling_rate` per iteration).
+ * Neighbour move: 2-opt segment reversal between two random positions.
+ *
+ * # Arguments
+ * `config_json` — JS object with fields:
+ * - `nodes`: `[[x, y], ...]` (required)
+ * - `initial_temp`: float (default 1000.0)
+ * - `cooling_rate`: float in (0, 1) (default 0.995)
+ * - `iterations`: integer (default 5000)
+ *
+ * # Returns
+ * JS object with `best_distance`, `best_tour`, `iterations_run`.
+ */
+export function run_sa(config_json: any): any;

package/u_metaheur.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./u_metaheur.d.ts" */
+
+import * as wasm from "./u_metaheur_bg.wasm";
+import { __wbg_set_wasm } from "./u_metaheur_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    run_ga, run_sa
+} from "./u_metaheur_bg.js";

package/u_metaheur_bg.js

@@ -0,0 +1,434 @@
+/**
+ * Runs a Genetic Algorithm for TSP.
+ *
+ * # Arguments
+ * `config_json` — JS object with fields:
+ * - `nodes`: `[[x, y], ...]` (required)
+ * - `population_size`: integer (default 100)
+ * - `generations`: integer (default 200)
+ * - `mutation_rate`: float 0–1 (default 0.05)
+ *
+ * # Returns
+ * JS object with `best_distance`, `best_tour`, `generations_run`.
+ * @param {any} config_json
+ * @returns {any}
+ */
+export function run_ga(config_json) {
+    const ret = wasm.run_ga(config_json);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Runs Simulated Annealing for TSP.
+ *
+ * Uses geometric cooling (`T *= cooling_rate` per iteration).
+ * Neighbour move: 2-opt segment reversal between two random positions.
+ *
+ * # Arguments
+ * `config_json` — JS object with fields:
+ * - `nodes`: `[[x, y], ...]` (required)
+ * - `initial_temp`: float (default 1000.0)
+ * - `cooling_rate`: float in (0, 1) (default 0.995)
+ * - `iterations`: integer (default 5000)
+ *
+ * # Returns
+ * JS object with `best_distance`, `best_tour`, `iterations_run`.
+ * @param {any} config_json
+ * @returns {any}
+ */
+export function run_sa(config_json) {
+    const ret = wasm.run_sa(config_json);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+export function __wbg_Error_8c4e43fe74559d73(arg0, arg1) {
+    const ret = Error(getStringFromWasm0(arg0, arg1));
+    return ret;
+}
+export function __wbg_Number_04624de7d0e8332d(arg0) {
+    const ret = Number(arg0);
+    return ret;
+}
+export function __wbg_String_8f0eb39a4a4c2f66(arg0, arg1) {
+    const ret = String(arg1);
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+}
+export function __wbg___wbindgen_bigint_get_as_i64_8fcf4ce7f1ca72a2(arg0, arg1) {
+    const v = arg1;
+    const ret = typeof(v) === 'bigint' ? v : undefined;
+    getDataViewMemory0().setBigInt64(arg0 + 8 * 1, isLikeNone(ret) ? BigInt(0) : ret, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
+}
+export function __wbg___wbindgen_boolean_get_bbbb1c18aa2f5e25(arg0) {
+    const v = arg0;
+    const ret = typeof(v) === 'boolean' ? v : undefined;
+    return isLikeNone(ret) ? 0xFFFFFF : ret ? 1 : 0;
+}
+export function __wbg___wbindgen_debug_string_0bc8482c6e3508ae(arg0, arg1) {
+    const ret = debugString(arg1);
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+}
+export function __wbg___wbindgen_in_47fa6863be6f2f25(arg0, arg1) {
+    const ret = arg0 in arg1;
+    return ret;
+}
+export function __wbg___wbindgen_is_bigint_31b12575b56f32fc(arg0) {
+    const ret = typeof(arg0) === 'bigint';
+    return ret;
+}
+export function __wbg___wbindgen_is_function_0095a73b8b156f76(arg0) {
+    const ret = typeof(arg0) === 'function';
+    return ret;
+}
+export function __wbg___wbindgen_is_object_5ae8e5880f2c1fbd(arg0) {
+    const val = arg0;
+    const ret = typeof(val) === 'object' && val !== null;
+    return ret;
+}
+export function __wbg___wbindgen_is_undefined_9e4d92534c42d778(arg0) {
+    const ret = arg0 === undefined;
+    return ret;
+}
+export function __wbg___wbindgen_jsval_eq_11888390b0186270(arg0, arg1) {
+    const ret = arg0 === arg1;
+    return ret;
+}
+export function __wbg___wbindgen_jsval_loose_eq_9dd77d8cd6671811(arg0, arg1) {
+    const ret = arg0 == arg1;
+    return ret;
+}
+export function __wbg___wbindgen_number_get_8ff4255516ccad3e(arg0, arg1) {
+    const obj = arg1;
+    const ret = typeof(obj) === 'number' ? obj : undefined;
+    getDataViewMemory0().setFloat64(arg0 + 8 * 1, isLikeNone(ret) ? 0 : ret, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
+}
+export function __wbg___wbindgen_string_get_72fb696202c56729(arg0, arg1) {
+    const obj = arg1;
+    const ret = typeof(obj) === 'string' ? obj : undefined;
+    var ptr1 = isLikeNone(ret) ? 0 : passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    var len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+}
+export function __wbg___wbindgen_throw_be289d5034ed271b(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+}
+export function __wbg_call_389efe28435a9388() { return handleError(function (arg0, arg1) {
+    const ret = arg0.call(arg1);
+    return ret;
+}, arguments); }
+export function __wbg_done_57b39ecd9addfe81(arg0) {
+    const ret = arg0.done;
+    return ret;
+}
+export function __wbg_getRandomValues_1c61fac11405ffdc() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
+}, arguments); }
+export function __wbg_get_9b94d73e6221f75c(arg0, arg1) {
+    const ret = arg0[arg1 >>> 0];
+    return ret;
+}
+export function __wbg_get_b3ed3ad4be2bc8ac() { return handleError(function (arg0, arg1) {
+    const ret = Reflect.get(arg0, arg1);
+    return ret;
+}, arguments); }
+export function __wbg_get_with_ref_key_1dc361bd10053bfe(arg0, arg1) {
+    const ret = arg0[arg1];
+    return ret;
+}
+export function __wbg_instanceof_ArrayBuffer_c367199e2fa2aa04(arg0) {
+    let result;
+    try {
+        result = arg0 instanceof ArrayBuffer;
+    } catch (_) {
+        result = false;
+    }
+    const ret = result;
+    return ret;
+}
+export function __wbg_instanceof_Uint8Array_9b9075935c74707c(arg0) {
+    let result;
+    try {
+        result = arg0 instanceof Uint8Array;
+    } catch (_) {
+        result = false;
+    }
+    const ret = result;
+    return ret;
+}
+export function __wbg_isArray_d314bb98fcf08331(arg0) {
+    const ret = Array.isArray(arg0);
+    return ret;
+}
+export function __wbg_isSafeInteger_bfbc7332a9768d2a(arg0) {
+    const ret = Number.isSafeInteger(arg0);
+    return ret;
+}
+export function __wbg_iterator_6ff6560ca1568e55() {
+    const ret = Symbol.iterator;
+    return ret;
+}
+export function __wbg_length_32ed9a279acd054c(arg0) {
+    const ret = arg0.length;
+    return ret;
+}
+export function __wbg_length_35a7bace40f36eac(arg0) {
+    const ret = arg0.length;
+    return ret;
+}
+export function __wbg_new_361308b2356cecd0() {
+    const ret = new Object();
+    return ret;
+}
+export function __wbg_new_3eb36ae241fe6f44() {
+    const ret = new Array();
+    return ret;
+}
+export function __wbg_new_dd2b680c8bf6ae29(arg0) {
+    const ret = new Uint8Array(arg0);
+    return ret;
+}
+export function __wbg_next_3482f54c49e8af19() { return handleError(function (arg0) {
+    const ret = arg0.next();
+    return ret;
+}, arguments); }
+export function __wbg_next_418f80d8f5303233(arg0) {
+    const ret = arg0.next;
+    return ret;
+}
+export function __wbg_prototypesetcall_bdcdcc5842e4d77d(arg0, arg1, arg2) {
+    Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
+}
+export function __wbg_set_3f1d0b984ed272ed(arg0, arg1, arg2) {
+    arg0[arg1] = arg2;
+}
+export function __wbg_set_f43e577aea94465b(arg0, arg1, arg2) {
+    arg0[arg1 >>> 0] = arg2;
+}
+export function __wbg_value_0546255b415e96c1(arg0) {
+    const ret = arg0.value;
+    return ret;
+}
+export function __wbindgen_cast_0000000000000001(arg0) {
+    // Cast intrinsic for `F64 -> Externref`.
+    const ret = arg0;
+    return ret;
+}
+export function __wbindgen_cast_0000000000000002(arg0, arg1) {
+    // Cast intrinsic for `Ref(String) -> Externref`.
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+}
+export function __wbindgen_cast_0000000000000003(arg0) {
+    // Cast intrinsic for `U64 -> Externref`.
+    const ret = BigInt.asUintN(64, arg0);
+    return ret;
+}
+export function __wbindgen_init_externref_table() {
+    const table = wasm.__wbindgen_externrefs;
+    const offset = table.grow(4);
+    table.set(0, undefined);
+    table.set(offset + 0, undefined);
+    table.set(offset + 1, null);
+    table.set(offset + 2, true);
+    table.set(offset + 3, false);
+}
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_externrefs.set(idx, obj);
+    return idx;
+}
+
+function debugString(val) {
+    // primitive types
+    const type = typeof val;
+    if (type == 'number' || type == 'boolean' || val == null) {
+        return  `${val}`;
+    }
+    if (type == 'string') {
+        return `"${val}"`;
+    }
+    if (type == 'symbol') {
+        const description = val.description;
+        if (description == null) {
+            return 'Symbol';
+        } else {
+            return `Symbol(${description})`;
+        }
+    }
+    if (type == 'function') {
+        const name = val.name;
+        if (typeof name == 'string' && name.length > 0) {
+            return `Function(${name})`;
+        } else {
+            return 'Function';
+        }
+    }
+    // objects
+    if (Array.isArray(val)) {
+        const length = val.length;
+        let debug = '[';
+        if (length > 0) {
+            debug += debugString(val[0]);
+        }
+        for(let i = 1; i < length; i++) {
+            debug += ', ' + debugString(val[i]);
+        }
+        debug += ']';
+        return debug;
+    }
+    // Test for built-in
+    const builtInMatches = /\[object ([^\]]+)\]/.exec(toString.call(val));
+    let className;
+    if (builtInMatches && builtInMatches.length > 1) {
+        className = builtInMatches[1];
+    } else {
+        // Failed to match the standard '[object ClassName]'
+        return toString.call(val);
+    }
+    if (className == 'Object') {
+        // we're a user defined class or Object
+        // JSON.stringify avoids problems with cycles, and is generally much
+        // easier than looping through ownProperties of `val`.
+        try {
+            return 'Object(' + JSON.stringify(val) + ')';
+        } catch (_) {
+            return 'Object';
+        }
+    }
+    // errors
+    if (val instanceof Error) {
+        return `${val.name}: ${val.message}\n${val.stack}`;
+    }
+    // TODO we could test for more things here, like `Set`s and `Map`s.
+    return className;
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}