@iyulab/u-metaheur 0.13.0 → 0.14.1

package/README.md

@@ -78,10 +78,10 @@ assert!((result.best - 3.0).abs() < 0.1);
 
 ```toml
 [dependencies]
-u-metaheur = "0.13"
+u-metaheur = "0.14"
 
 # with serde support
-u-metaheur = { version = "0.13", features = ["serde"] }
+u-metaheur = { version = "0.14", features = ["serde"] }
 ```
 
 ## Build & Test
@@ -143,7 +143,10 @@ console.log(run_ga({ nodes, population_size: 30, generations: 50, seed: 7 }).bes
 ```
 
 `run_ga` also takes `mutation_rate`; `run_sa` takes `initial_temp` and
-`cooling_rate`. Both take `seed` (a whole number from 0 to 2^64 − 1 — a run that
+`cooling_rate`. Without `initial_temp` the annealing starts at a twentieth of the
+typical worsening of a 2-opt move (measured before the run), so the same cities
+in other coordinates anneal the same way; give `initial_temp` for an absolute
+temperature in the unit of the tour length. Both take `seed` (a whole number from 0 to 2^64 − 1 — a run that
 ends on its own budget is reproduced exactly) and `time_limit_ms` (at least 1 —
 the run returns the best tour found by then). `stop_reason` is
 `"iteration_limit"` when the run spent its `generations` / `iterations`,

package/node/u_metaheur.cjs

@@ -54,7 +54,10 @@ exports.run_ga = run_ga;
  * # Arguments
  * `config` — native JS object with fields:
  * - `nodes`: `[[x, y], ...]` (required, at least 2)
- * - `initial_temp`: float (default 1000.0, > 0)
+ * - `initial_temp`: float > 0 (optional) -- an absolute temperature, in the
+ *   unit of the tour length. Left out, the start is the typical worsening of
+ *   a 2-opt move from the nearest-neighbour tour, measured before the run, so
+ *   the same tour in other coordinates anneals the same way
  * - `cooling_rate`: float in (0, 1) (default 0.995)
  * - `iterations`: integer (default 5000, at least 1)
  * - `seed`, `time_limit_ms`: as `run_ga`'s

package/node/u_metaheur.d.cts

@@ -64,7 +64,11 @@ export interface GaResult {
 
 export interface SaConfig {
     nodes: [number, number][];
-    initial_temp?: number;
+    /**
+     * Starting temperature in the unit of the tour length, `> 0`. Left out,
+     * the temperature follows the tour lengths (see `run_sa`).
+     */
+    initial_temp?: number | null;
     cooling_rate?: number;
     /**
      * At least 1 (`run_sa` checks it; see [`Whole`] for why it is signed).
@@ -130,7 +134,10 @@ export function run_ga(config: GaConfig): GaResult;
  * # Arguments
  * `config` — native JS object with fields:
  * - `nodes`: `[[x, y], ...]` (required, at least 2)
- * - `initial_temp`: float (default 1000.0, > 0)
+ * - `initial_temp`: float > 0 (optional) -- an absolute temperature, in the
+ *   unit of the tour length. Left out, the start is the typical worsening of
+ *   a 2-opt move from the nearest-neighbour tour, measured before the run, so
+ *   the same tour in other coordinates anneals the same way
  * - `cooling_rate`: float in (0, 1) (default 0.995)
  * - `iterations`: integer (default 5000, at least 1)
  * - `seed`, `time_limit_ms`: as `run_ga`'s

package/package.json

@@ -5,7 +5,7 @@
     "iyulab"
   ],
   "description": "Domain-agnostic metaheuristic optimization framework: GA, BRKGA, SA, ALNS.",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "license": "MIT",
   "repository": {
     "type": "git",

package/u_metaheur.d.ts

@@ -64,7 +64,11 @@ export interface GaResult {
 
 export interface SaConfig {
     nodes: [number, number][];
-    initial_temp?: number;
+    /**
+     * Starting temperature in the unit of the tour length, `> 0`. Left out,
+     * the temperature follows the tour lengths (see `run_sa`).
+     */
+    initial_temp?: number | null;
     cooling_rate?: number;
     /**
      * At least 1 (`run_sa` checks it; see [`Whole`] for why it is signed).
@@ -130,7 +134,10 @@ export function run_ga(config: GaConfig): GaResult;
  * # Arguments
  * `config` — native JS object with fields:
  * - `nodes`: `[[x, y], ...]` (required, at least 2)
- * - `initial_temp`: float (default 1000.0, > 0)
+ * - `initial_temp`: float > 0 (optional) -- an absolute temperature, in the
+ *   unit of the tour length. Left out, the start is the typical worsening of
+ *   a 2-opt move from the nearest-neighbour tour, measured before the run, so
+ *   the same tour in other coordinates anneals the same way
  * - `cooling_rate`: float in (0, 1) (default 0.995)
  * - `iterations`: integer (default 5000, at least 1)
  * - `seed`, `time_limit_ms`: as `run_ga`'s

package/u_metaheur_bg.js

@@ -50,7 +50,10 @@ export function run_ga(config) {
  * # Arguments
  * `config` — native JS object with fields:
  * - `nodes`: `[[x, y], ...]` (required, at least 2)
- * - `initial_temp`: float (default 1000.0, > 0)
+ * - `initial_temp`: float > 0 (optional) -- an absolute temperature, in the
+ *   unit of the tour length. Left out, the start is the typical worsening of
+ *   a 2-opt move from the nearest-neighbour tour, measured before the run, so
+ *   the same tour in other coordinates anneals the same way
  * - `cooling_rate`: float in (0, 1) (default 0.995)
  * - `iterations`: integer (default 5000, at least 1)
  * - `seed`, `time_limit_ms`: as `run_ga`'s