@iyulab/u-doe 0.7.0 → 0.8.0

package/README.md

@@ -106,7 +106,7 @@ println!("Required replicates: {n}");
 | Design | Function | Use Case |
 |--------|----------|----------|
 | Full Factorial | `full_factorial(k)` | k = 2..7, all factor combinations |
-| Fractional Factorial | `fractional_factorial(k, p)` | Screening, k=3..7, p=1..3 |
+| Fractional Factorial | `fractional_factorial(k, p)` | Screening, k=4..7, p=1..3 |
 | Plackett-Burman | `plackett_burman(k)` | Screening, k ≤ 19, N = 8/12/16/20 |
 | CCD | `ccd(k, alpha, n_center)` | RSM, k = 2..6 |
 | Box-Behnken | `box_behnken(k, n_center)` | RSM, k = 3/4/5 |
@@ -157,6 +157,21 @@ Generate a 2^k full factorial design (k = 1..7).
 
 Generate a 2^(k-p) fractional factorial design (k = 4..7, p = 1..3).
 
+#### `fractional_factorial_info(k, p) -> FractionalInfo`
+
+Metadata for the fraction `fractional_factorial(k, p)` emits: resolution, defining relation, and generator equations. Use it to derive the alias structure of the design you actually received instead of pairing the matrix with an external published table.
+
+**Output:**
+```json
+{
+  "k": 7,
+  "p": 3,
+  "resolution": "IV",
+  "defining_relation": "I=ABCE=BCDF=ACDG=ADEF=BDEG=ABFG=CEFG",
+  "generators": ["E=ABC", "F=BCD", "G=ACD"]
+}
+```
+
 #### `plackett_burman(k) -> DesignMatrix`
 
 Generate a Plackett-Burman screening design (k = 1..19).

package/node/u_doe.cjs

@@ -219,6 +219,33 @@ function fractional_factorial(k, p) {
 }
 exports.fractional_factorial = fractional_factorial;
 
+/**
+ * Metadata for a 2^(k-p) fractional factorial design: resolution, defining
+ * relation, and generator equations of the fraction `fractional_factorial(k, p)`
+ * actually emits — lets consumers derive the alias structure without pairing
+ * the design with an external published table.
+ *
+ * Returns `{ k: usize, p: usize, resolution: "III"|"IV"|"V",
+ * defining_relation: str, generators: [str] }` —
+ * e.g. `{ k: 7, p: 3, resolution: "IV",
+ * defining_relation: "I=ABCE=BCDF=ACDG=ADEF=BDEG=ABFG=CEFG",
+ * generators: ["E=ABC", "F=BCD", "G=ACD"] }`.
+ *
+ * # Errors
+ * Returns an error string if the (k, p) combination is not in the standard table.
+ * @param {number} k
+ * @param {number} p
+ * @returns {any}
+ */
+function fractional_factorial_info(k, p) {
+    const ret = wasm.fractional_factorial_info(k, p);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+exports.fractional_factorial_info = fractional_factorial_info;
+
 /**
  * Generate a 2^k full factorial design.
  *

package/node/u_doe.d.cts

@@ -125,6 +125,23 @@ export function fit_rsm(design: any, responses: Float64Array, factor_names: any)
  */
 export function fractional_factorial(k: number, p: number): any;
 
+/**
+ * Metadata for a 2^(k-p) fractional factorial design: resolution, defining
+ * relation, and generator equations of the fraction `fractional_factorial(k, p)`
+ * actually emits — lets consumers derive the alias structure without pairing
+ * the design with an external published table.
+ *
+ * Returns `{ k: usize, p: usize, resolution: "III"|"IV"|"V",
+ * defining_relation: str, generators: [str] }` —
+ * e.g. `{ k: 7, p: 3, resolution: "IV",
+ * defining_relation: "I=ABCE=BCDF=ACDG=ADEF=BDEG=ABFG=CEFG",
+ * generators: ["E=ABC", "F=BCD", "G=ACD"] }`.
+ *
+ * # Errors
+ * Returns an error string if the (k, p) combination is not in the standard table.
+ */
+export function fractional_factorial_info(k: number, p: number): any;
+
 /**
  * Generate a 2^k full factorial design.
  *

package/package.json

@@ -5,7 +5,7 @@
     "iyulab"
   ],
   "description": "Design of Experiments (DOE) framework: factorial, Plackett-Burman, CCD, Box-Behnken, Taguchi, effects analysis, RSM, and desirability optimization.",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/u_doe.d.ts

@@ -125,6 +125,23 @@ export function fit_rsm(design: any, responses: Float64Array, factor_names: any)
  */
 export function fractional_factorial(k: number, p: number): any;
 
+/**
+ * Metadata for a 2^(k-p) fractional factorial design: resolution, defining
+ * relation, and generator equations of the fraction `fractional_factorial(k, p)`
+ * actually emits — lets consumers derive the alias structure without pairing
+ * the design with an external published table.
+ *
+ * Returns `{ k: usize, p: usize, resolution: "III"|"IV"|"V",
+ * defining_relation: str, generators: [str] }` —
+ * e.g. `{ k: 7, p: 3, resolution: "IV",
+ * defining_relation: "I=ABCE=BCDF=ACDG=ADEF=BDEG=ABFG=CEFG",
+ * generators: ["E=ABC", "F=BCD", "G=ACD"] }`.
+ *
+ * # Errors
+ * Returns an error string if the (k, p) combination is not in the standard table.
+ */
+export function fractional_factorial_info(k: number, p: number): any;
+
 /**
  * Generate a 2^k full factorial design.
  *

package/u_doe.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./u_doe_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    box_behnken, ccd, definitive_screening, desirability, doe_anova, estimate_effects, fit_rsm, fractional_factorial, full_factorial, plackett_burman, signal_to_noise, simplex_centroid, simplex_lattice, steepest_ascent, taguchi_array, two_level_factorial_power
+    box_behnken, ccd, definitive_screening, desirability, doe_anova, estimate_effects, fit_rsm, fractional_factorial, fractional_factorial_info, full_factorial, plackett_burman, signal_to_noise, simplex_centroid, simplex_lattice, steepest_ascent, taguchi_array, two_level_factorial_power
 } from "./u_doe_bg.js";

package/u_doe_bg.js

@@ -209,6 +209,32 @@ export function fractional_factorial(k, p) {
     return takeFromExternrefTable0(ret[0]);
 }
 
+/**
+ * Metadata for a 2^(k-p) fractional factorial design: resolution, defining
+ * relation, and generator equations of the fraction `fractional_factorial(k, p)`
+ * actually emits — lets consumers derive the alias structure without pairing
+ * the design with an external published table.
+ *
+ * Returns `{ k: usize, p: usize, resolution: "III"|"IV"|"V",
+ * defining_relation: str, generators: [str] }` —
+ * e.g. `{ k: 7, p: 3, resolution: "IV",
+ * defining_relation: "I=ABCE=BCDF=ACDG=ADEF=BDEG=ABFG=CEFG",
+ * generators: ["E=ABC", "F=BCD", "G=ACD"] }`.
+ *
+ * # Errors
+ * Returns an error string if the (k, p) combination is not in the standard table.
+ * @param {number} k
+ * @param {number} p
+ * @returns {any}
+ */
+export function fractional_factorial_info(k, p) {
+    const ret = wasm.fractional_factorial_info(k, p);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 /**
  * Generate a 2^k full factorial design.
  *