@iyulab/u-metaheur 0.6.3 → 0.8.0

package/README.md

@@ -78,10 +78,10 @@ assert!((result.best - 3.0).abs() < 0.1);
 
 ```toml
 [dependencies]
-u-metaheur = "0.6"
+u-metaheur = "0.8"
 
 # with serde support
-u-metaheur = { version = "0.6", features = ["serde"] }
+u-metaheur = { version = "0.8", features = ["serde"] }
 ```
 
 ## Build & Test
@@ -153,16 +153,16 @@ import { run_sa } from '@iyulab/u-metaheur';
 try {
   run_sa({ nodes: [[0, 0], [1, 0], [1, 1]], cooling_rate: 1 });
 } catch (err) {
-  console.log(err.code, err.parameter, err.min, err.max, err.got); // parameter_out_of_range cooling_rate 0 1 1
+  console.log(err.code, err.parameter, err.exclusive_min, err.exclusive_max, err.got); // parameter_out_of_range cooling_rate 0 1 1
 }
 ```
 
 | `code` | Fields | Meaning |
 |---|---|---|
 | `insufficient_data` | `parameter` (`"nodes"`), `min`, `got` | Fewer than 2 nodes |
-| `parameter_out_of_range` | `parameter`, `min`, `max` (or `null`), `got` | `population_size < 2`, `generations` or `iterations` of 0, `initial_temp ≤ 0`, or `cooling_rate` outside (0, 1) — the message says whether a bound is included |
+| `parameter_out_of_range` | `parameter`, `min`, `max`, `exclusive_min`, `exclusive_max`, `got` | `population_size < 2`, `generations` or `iterations` below 1 (a negative count included: `population_size: -1` is `{ min: 2, max: null, got: -1 }`, the same as `1`), `initial_temp ≤ 0`, or `cooling_rate` outside (0, 1). `min` / `max` are the closed (included) bounds and are always present — `null` on a side that is open or unbounded; `exclusive_min` / `exclusive_max` are the open (excluded) bounds, present only when that end is open: `initial_temp` (> 0) is refused with `min: null, exclusive_min: 0`, `cooling_rate` with `exclusive_min: 0, exclusive_max: 1` |
 | `value_not_finite` | `parameter`, `index` | A NaN or ±Infinity anywhere in an argument — `parameter` is the path to it (`config.nodes[1]`), `index` its position in that array, or `null` |
-| `malformed_input` | `parameter` | An argument of the wrong shape or type (a missing or unknown key), or a JSON string |
+| `malformed_input` | `parameter` | An argument of the wrong shape or type (a missing or unknown key), a count that is not a whole number (`population_size: 2.5` — `parameter` is the field), or a JSON string |
 
 ### TypeScript
 

package/node/u_metaheur.d.cts

@@ -2,7 +2,13 @@
 /* eslint-disable */
 export interface GaConfig {
     nodes: [number, number][];
+    /**
+     * At least 2 (`run_ga` checks it; see [`Whole`] for why it is signed).
+     */
     population_size?: number;
+    /**
+     * At least 1.
+     */
     generations?: number;
     mutation_rate?: number;
 }
@@ -17,6 +23,9 @@ export interface SaConfig {
     nodes: [number, number][];
     initial_temp?: number;
     cooling_rate?: number;
+    /**
+     * At least 1 (`run_sa` checks it; see [`Whole`] for why it is signed).
+     */
     iterations?: number;
 }
 

package/package.json

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

package/u_metaheur.d.ts

@@ -2,7 +2,13 @@
 /* eslint-disable */
 export interface GaConfig {
     nodes: [number, number][];
+    /**
+     * At least 2 (`run_ga` checks it; see [`Whole`] for why it is signed).
+     */
     population_size?: number;
+    /**
+     * At least 1.
+     */
     generations?: number;
     mutation_rate?: number;
 }
@@ -17,6 +23,9 @@ export interface SaConfig {
     nodes: [number, number][];
     initial_temp?: number;
     cooling_rate?: number;
+    /**
+     * At least 1 (`run_sa` checks it; see [`Whole`] for why it is signed).
+     */
     iterations?: number;
 }