runmat 0.5.7-dev.2 → 0.5.7-dev.4

package/dist/generated/builtins/dec2hex.js

@@ -0,0 +1,98 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "dec2hex",
+    "category": "comms/conversion",
+    "keywords": [
+        "dec2hex",
+        "decimal",
+        "hexadecimal",
+        "base conversion",
+        "twos complement"
+    ],
+    "summary": "Convert decimal integers to hexadecimal character rows in MATLAB and RunMat.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "gpuArray inputs are gathered to the host for integer validation and text formatting."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "none"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::comms::binary_conversion::tests",
+        "integration": null
+    },
+    "description": "`dec2hex(D)` converts each element of `D` to one uppercase hexadecimal character row. `dec2hex(D, minDigits)` pads rows to at least `minDigits` characters. Numeric arrays are processed in column-major element order and produce one output row per element.",
+    "behaviors": [
+        "`D` may be numeric, integer, logical, character, or gpuArray numeric data.",
+        "Double inputs must be finite integer values.",
+        "Nonnegative values are padded with `0` characters.",
+        "Negative values are represented using the smallest signed two's-complement storage width that can contain the value, with additional padding using `F` characters.",
+        "Signed integer inputs preserve their source integer storage width for negative two's-complement output.",
+        "`minDigits` must be a finite nonnegative integer scalar.",
+        "Outputs larger than RunMat's character-output safety limit are rejected before formatting.",
+        "Complex, non-finite, fractional, and unsupported input values raise an error."
+    ],
+    "examples": [
+        {
+            "description": "Convert a scalar decimal value",
+            "input": "s = dec2hex(1023)",
+            "output": "s = '3FF'"
+        },
+        {
+            "description": "Pad to a minimum width",
+            "input": "s = dec2hex(1023, 6)",
+            "output": "s = '0003FF'"
+        },
+        {
+            "description": "Convert multiple values to padded rows",
+            "input": "s = dec2hex([1023 122 14])",
+            "output": "s = ['3FF'; '07A'; '00E']"
+        },
+        {
+            "description": "Format a negative value as two's complement",
+            "input": "s = dec2hex(-16)",
+            "output": "s = 'F0'"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Are fractional inputs accepted?",
+            "answer": "No. RunMat requires finite integer values for `dec2hex`."
+        },
+        {
+            "question": "Are hexadecimal letters uppercase?",
+            "answer": "Yes. RunMat emits uppercase `A` through `F` characters."
+        }
+    ],
+    "links": [
+        {
+            "label": "hex2dec",
+            "url": "./hex2dec"
+        },
+        {
+            "label": "dec2bin",
+            "url": "./dec2bin"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/comms/binary_conversion.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/comms/binary_conversion.rs"
+    },
+    "key": "dec2hex",
+    "slug": "dec2hex",
+    "aliases": [],
+    "categoryPath": [
+        "comms",
+        "conversion"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=dec2hex.js.map

package/dist/generated/builtins/dec2hex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dec2hex.js","sourceRoot":"","sources":["../../../src/generated/builtins/dec2hex.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,kBAAkB;IAC9B,UAAU,EAAE;QACV,SAAS;QACT,SAAS;QACT,aAAa;QACb,iBAAiB;QACjB,iBAAiB;KAClB;IACD,SAAS,EAAE,8EAA8E;IACzF,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,sFAAsF;KAChG;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,MAAM;KACpB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,2CAA2C;QACnD,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,gQAAgQ;IAC/Q,WAAW,EAAE;QACX,4EAA4E;QAC5E,8CAA8C;QAC9C,oDAAoD;QACpD,oKAAoK;QACpK,yGAAyG;QACzG,0DAA0D;QAC1D,4FAA4F;QAC5F,+EAA+E;KAChF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,mBAAmB;YAC5B,QAAQ,EAAE,WAAW;SACtB;QACD;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,4BAA4B;YACrC,QAAQ,EAAE,2BAA2B;SACtC;QACD;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,kBAAkB;YAC3B,QAAQ,EAAE,UAAU;SACrB;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,0DAA0D;SACrE;QACD;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,yDAAyD;SACpE;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,iEAAiE;QAC1E,KAAK,EAAE,8GAA8G;KACtH;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,YAAY;KACb;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/decomposition.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=decomposition.d.ts.map

package/dist/generated/builtins/decomposition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decomposition.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/decomposition.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UAmIjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/decomposition.js

@@ -0,0 +1,136 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "decomposition",
+    "category": "math/linalg/factor",
+    "keywords": [
+        "decomposition",
+        "linear solve",
+        "factorization",
+        "lu",
+        "qr",
+        "chol",
+        "triangular",
+        "diagonal"
+    ],
+    "summary": "Create MATLAB-compatible matrix decomposition objects for reusable linear solves.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "Construction gathers gpuArray inputs to host object storage. Solving through the object delegates to mldivide or mrdivide, so GPU residency follows those solve builtins when a provider accepts the transformed matrix."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "uniform"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::math::linalg::factor::decomposition::tests"
+    },
+    "description": "`dA = decomposition(A)` creates a decomposition object that can be reused with `dA \\ b` and `b / dA`. RunMat stores a validated coefficient matrix and routes solves through the same MATLAB-compatible `mldivide` and `mrdivide` engines used by ordinary matrix division.",
+    "behaviors": [
+        "The constructor accepts dense real, dense complex, scalar numeric, logical scalar, and integer scalar coefficient matrices. Sparse inputs are rejected until RunMat has a sparse solve path behind the decomposition object.",
+        "Supported type strings are `'auto'`, `'lu'`, `'qr'`, `'chol'`, `'triangular'`, and `'diagonal'`. The default `'auto'` selects `diagonal`, `triangular`, `lu`, or `qr` based on the matrix shape and structure.",
+        "Square-only types reject rectangular matrices. The `diagonal` and `triangular` types validate the corresponding structure. The optional `'upper'` or `'lower'` triangular flag is supported for `decomposition(A, 'triangular', flag)` and ignores the opposite triangle.",
+        "Name-value options include `CheckCondition` and `RankTolerance`. `CheckCondition` is exposed as an object property; `RankTolerance` is accepted and stored for QR compatibility metadata.",
+        "Object properties include `MatrixSize`, `Type`, `CheckCondition`, `Datatype`, `IsConjugateTransposed`, `IsReal`, `IsSparse`, and `ScaleFactor`. Internal coefficient storage is not publicly readable.",
+        "Unary plus returns the same decomposition. Unary minus, scalar multiplication, and scalar division return a new decomposition with an adjusted scale factor.",
+        "Conjugate transpose (`dA'`) toggles `IsConjugateTransposed`, conjugates the scale factor, and solves against the conjugate-transposed coefficient matrix.",
+        "Left division (`dA \\ b`) and right division (`b / dA`) support the same real, complex, square, rectangular, and least-squares behavior as RunMat's `mldivide` and `mrdivide` builtins."
+    ],
+    "examples": [
+        {
+            "description": "Solving a square system with a reusable decomposition",
+            "input": "A = [2 0; 0 4];\ndA = decomposition(A);\nx = dA \\ [8; 12]",
+            "output": "x =\n     4\n     3"
+        },
+        {
+            "description": "Right division through a decomposition object",
+            "input": "A = [2 0; 0 4];\ndA = decomposition(A);\ny = [8 12] / dA",
+            "output": "y =\n     4     3"
+        },
+        {
+            "description": "Declaring a triangular matrix and using only the upper triangle",
+            "input": "A = [2 0; 99 4];\ndA = decomposition(A, 'triangular', 'upper');\nx = dA \\ [8; 12]",
+            "output": "x =\n     4\n     3"
+        },
+        {
+            "description": "Scaling and transposing a decomposition",
+            "input": "A = [1 2; 0 1];\ndA = decomposition(A);\nz = (2*dA)' \\ [3; 1]",
+            "output": "z =\n     1.5\n    -2.5"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `decomposition` expose the raw LU or QR factors?",
+            "answer": "No. MATLAB's `decomposition` object is an opaque solve object, and RunMat follows that surface. Use `lu`, `qr`, `chol`, or `svd` when you need explicit factors."
+        },
+        {
+            "question": "Does RunMat cache native factor arrays internally?",
+            "answer": "The current implementation stores the normalized coefficient matrix plus decomposition metadata and delegates each solve to the shared matrix-division solvers. This preserves MATLAB solve semantics across square, rectangular, and complex cases; dedicated cached factor storage can be added behind the same object surface later."
+        },
+        {
+            "question": "Which object operations are supported?",
+            "answer": "RunMat supports property access, unary plus/minus, conjugate transpose, scalar multiplication, scalar division, left division, and right division for decomposition objects."
+        },
+        {
+            "question": "Are condition warnings emitted?",
+            "answer": "No. The `CheckCondition` property is parsed and preserved, but RunMat does not yet emit MATLAB-compatible condition warnings during decomposition construction or solve."
+        },
+        {
+            "question": "Are sparse decomposition objects supported?",
+            "answer": "Not yet. RunMat rejects sparse coefficient matrices instead of silently densifying them, because large sparse matrices need a dedicated sparse solve path to be safe and MATLAB-compatible."
+        }
+    ],
+    "links": [
+        {
+            "label": "mldivide",
+            "url": "./mldivide"
+        },
+        {
+            "label": "mrdivide",
+            "url": "./mrdivide"
+        },
+        {
+            "label": "lu",
+            "url": "./lu"
+        },
+        {
+            "label": "qr",
+            "url": "./qr"
+        },
+        {
+            "label": "chol",
+            "url": "./chol"
+        },
+        {
+            "label": "svd",
+            "url": "./svd"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/math/linalg/factor/decomposition.rs",
+        "url": "crates/runmat-runtime/src/builtins/math/linalg/factor/decomposition.rs"
+    },
+    "gpu_behavior": [
+        "Constructing a decomposition object gathers any gpuArray coefficient matrix to host storage because the object owns normalized matrix metadata.",
+        "Solves through `dA \\ b` and `b / dA` call the existing `mldivide` and `mrdivide` implementations with the effective coefficient matrix. If a provider accepts that solve, residency follows the same provider behavior as direct matrix division; otherwise RunMat uses the host fallback."
+    ],
+    "key": "decomposition",
+    "slug": "decomposition",
+    "aliases": [],
+    "categoryPath": [
+        "math",
+        "linalg",
+        "factor"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=decomposition.js.map

package/dist/generated/builtins/decomposition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decomposition.js","sourceRoot":"","sources":["../../../src/generated/builtins/decomposition.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,eAAe;IACxB,UAAU,EAAE,oBAAoB;IAChC,UAAU,EAAE;QACV,eAAe;QACf,cAAc;QACd,eAAe;QACf,IAAI;QACJ,IAAI;QACJ,MAAM;QACN,YAAY;QACZ,UAAU;KACX;IACD,SAAS,EAAE,mFAAmF;IAC9F,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,0NAA0N;KACpO;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,SAAS;KACvB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,sDAAsD;KAC/D;IACD,aAAa,EAAE,8QAA8Q;IAC7R,WAAW,EAAE;QACX,8NAA8N;QAC9N,gNAAgN;QAChN,2QAA2Q;QAC3Q,2LAA2L;QAC3L,wMAAwM;QACxM,8JAA8J;QAC9J,2JAA2J;QAC3J,yLAAyL;KAC1L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,uDAAuD;YACtE,OAAO,EAAE,4DAA4D;YACrE,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,+CAA+C;YAC9D,OAAO,EAAE,0DAA0D;YACnE,QAAQ,EAAE,mBAAmB;SAC9B;QACD;YACE,aAAa,EAAE,iEAAiE;YAChF,OAAO,EAAE,oFAAoF;YAC7F,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,gEAAgE;YACzE,QAAQ,EAAE,yBAAyB;SACpC;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,kKAAkK;SAC7K;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,yUAAyU;SACpV;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,8KAA8K;SACzL;QACD;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,0KAA0K;SACrL;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,6LAA6L;SACxM;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,wEAAwE;QACjF,KAAK,EAAE,wEAAwE;KAChF;IACD,cAAc,EAAE;QACd,iJAAiJ;QACjJ,6RAA6R;KAC9R;IACD,KAAK,EAAE,eAAe;IACtB,MAAM,EAAE,eAAe;IACvB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,MAAM;QACN,QAAQ;QACR,QAAQ;KACT;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/degree.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=degree.d.ts.map

package/dist/generated/builtins/degree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"degree.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/degree.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA8BjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/degree.js

@@ -0,0 +1,35 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "degree",
+    "category": "graph",
+    "keywords": [
+        "degree",
+        "graph",
+        "nodes"
+    ],
+    "summary": "Return graph node degree counts.",
+    "status": "implemented",
+    "tested": {
+        "unit": "builtins::graph::tests"
+    },
+    "description": "`degree(G)` returns a column vector of degree counts. For digraphs, it returns total in-degree plus out-degree.",
+    "signatures": [
+        {
+            "label": "d = degree(G)",
+            "description": "Return one degree value per node."
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/graph/mod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/graph/mod.rs"
+    },
+    "key": "degree",
+    "slug": "degree",
+    "aliases": [],
+    "categoryPath": [
+        "graph"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=degree.js.map

package/dist/generated/builtins/degree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"degree.js","sourceRoot":"","sources":["../../../src/generated/builtins/degree.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE;QACV,QAAQ;QACR,OAAO;QACP,OAAO;KACR;IACD,SAAS,EAAE,kCAAkC;IAC7C,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE;QACR,MAAM,EAAE,wBAAwB;KACjC;IACD,aAAa,EAAE,iHAAiH;IAChI,YAAY,EAAE;QACZ;YACE,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE,mCAAmC;SACnD;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/dfsearch.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=dfsearch.d.ts.map

package/dist/generated/builtins/dfsearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dfsearch.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/dfsearch.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA8BjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/dfsearch.js

@@ -0,0 +1,35 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "dfsearch",
+    "category": "graph",
+    "keywords": [
+        "dfsearch",
+        "graph",
+        "depth first search"
+    ],
+    "summary": "Return depth-first search order.",
+    "status": "implemented",
+    "tested": {
+        "unit": "builtins::graph::tests"
+    },
+    "description": "`dfsearch(G,start)` returns the reachable nodes in depth-first order. Directed graphs follow outgoing edges.",
+    "signatures": [
+        {
+            "label": "nodes = dfsearch(G, start)",
+            "description": "Return DFS visit order."
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/graph/mod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/graph/mod.rs"
+    },
+    "key": "dfsearch",
+    "slug": "dfsearch",
+    "aliases": [],
+    "categoryPath": [
+        "graph"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=dfsearch.js.map

package/dist/generated/builtins/dfsearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dfsearch.js","sourceRoot":"","sources":["../../../src/generated/builtins/dfsearch.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE;QACV,UAAU;QACV,OAAO;QACP,oBAAoB;KACrB;IACD,SAAS,EAAE,kCAAkC;IAC7C,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE;QACR,MAAM,EAAE,wBAAwB;KACjC;IACD,aAAa,EAAE,8GAA8G;IAC7H,YAAY,EAAE;QACZ;YACE,OAAO,EAAE,4BAA4B;YACrC,aAAa,EAAE,yBAAyB;SACzC;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/diag.js

@@ -30,7 +30,7 @@ const builtinDoc = {
     "requires_feature": null,
     "tested": {
         "unit": "builtins::array::shape::diag::tests",
-        "integration": "builtins::array::shape::diag::tests::diag_gpu_roundtrip"
+        "integration": "builtins::array::shape::diag::tests::diag_wgpu_rectangular_and_extract_paths_stay_resident"
     },
     "description": "`diag` either constructs a diagonal matrix from a vector or extracts a diagonal from a matrix. Offset handling and supported input classes follow MATLAB semantics.",
     "behaviors": [
@@ -117,7 +117,7 @@ const builtinDoc = {
         },
         {
             "question": "Do GPU results stay on the device?",
-            "answer": "Yes—providers with diag hooks operate entirely on the GPU. Providers without hooks perform a single host gather and upload, so downstream fused expressions still see a GPU handle. When you request `'like'` with a GPU prototype, the result is uploaded back to the device even if a host fallback was required."
+            "answer": "Yes. Real and logical gpuArray inputs use provider hooks for vector placement, explicit rectangular sizes, `'vector'` mode, and matrix diagonal extraction. Complex, character, and conversion-heavy template forms use the host fallback."
         },
         {
             "question": "Is the offset argument required to be an integer?",
@@ -226,9 +226,9 @@ const builtinDoc = {
         "label": "`crates/runmat-runtime/src/builtins/array/shape/diag.rs`",
         "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/array/shape/diag.rs"
     },
-    "gpu_residency": "You usually do NOT need to call `gpuArray` yourself in RunMat (unlike MATLAB).\n\nIn RunMat, the auto-offload planner keeps residency on the GPU when expressions make use of GPU providers. Even when the provider lacks `diag_from_vector` / `diag_extract`, the builtin gathers once on the host, performs the diagonal operation, and re-uploads the result so later GPU-friendly ops can continue without intervention.\n\nTo preserve backwards compatibility with MathWorks MATLAB, and for when you want to explicitly bootstrap GPU residency, you can call `gpuArray` to move data to the GPU. That mirrors MATLAB's behaviour while still allowing RunMat's planner to decide whether the GPU offers an advantage for the surrounding computation.\n\nSince MathWorks MATLAB does not have a fusion planner, and they kept their parallel execution toolbox separate from the core language, as their toolbox is a separate commercial product, MathWorks MATLAB users need to call `gpuArray` to move data to the GPU manually whereas RunMat users can rely on the fusion planner to keep data on the GPU automatically.",
+    "gpu_residency": "You usually do NOT need to call `gpuArray` yourself in RunMat (unlike MATLAB).\n\nIn RunMat, the auto-offload planner keeps residency on the GPU when expressions make use of GPU providers. For `diag`, real and logical GPU inputs stay resident when the active provider exposes the required diagonal hooks. If those hooks are missing, or if the requested class semantics require host conversion, the builtin gathers once and returns the host result unless a GPU `'like'` prototype explicitly requests device residency.\n\nTo preserve backwards compatibility with MathWorks MATLAB, and for when you want to explicitly bootstrap GPU residency, you can call `gpuArray` to move data to the GPU. That mirrors MATLAB's behaviour while still allowing RunMat's planner to decide whether the GPU offers an advantage for the surrounding computation.\n\nSince MathWorks MATLAB does not have a fusion planner, and they kept their parallel execution toolbox separate from the core language, as their toolbox is a separate commercial product, MathWorks MATLAB users need to call `gpuArray` to move data to the GPU manually whereas RunMat users can rely on the fusion planner to keep data on the GPU automatically.",
     "gpu_behavior": [
-        "When the input lives on the GPU, RunMat calls the acceleration provider's `diag_from_vector` or `diag_extract` hook (see the GPU spec). Providers that do not expose these hooks fall back to a host round-trip: the input is gathered once, the diagonal computation runs on the CPU, and the result is uploaded back to the device. Size overrides or the `'vector'` option also trigger the host path because they are not yet exposed through provider hooks. `'like'` requests are honoured regardless of the path: GPU prototypes stay on the device, while logical or complex prototypes adjust the element type accordingly."
+        "When a real or logical input lives on the GPU, RunMat calls the acceleration provider's `diag_from_vector`, `diag_from_vector_sized`, `diag_extract`, or metadata-only `reshape` hook as appropriate. That covers native vector-to-matrix placement, explicit rectangular size overrides, `'vector'` mode, matrix diagonal extraction, and empty out-of-bounds diagonals without gathering. Providers that do not expose these hooks fall back to a host result. Complex, character, and conversion-heavy template forms also use the host path so MATLAB-compatible class conversion semantics remain intact."
     ],
     "key": "diag",
     "slug": "diag",

package/dist/generated/builtins/diag.js.map

@@ -1 +1 @@
-{"version":3,"file":"diag.js","sourceRoot":"","sources":["../../../src/generated/builtins/diag.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,MAAM;QACN,UAAU;QACV,QAAQ;QACR,YAAY;QACZ,KAAK;KACN;IACD,SAAS,EAAE,qEAAqE;IAChF,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,sKAAsK;KAChL;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,yDAAyD;KACzE;IACD,aAAa,EAAE,qKAAqK;IACpL,WAAW,EAAE;QACX,iFAAiF;QACjF,4IAA4I;QAC5I,0FAA0F;QAC1F,4HAA4H;QAC5H,oGAAoG;QACpG,wJAAwJ;QACxJ,gJAAgJ;QAChJ,kHAAkH;QAClH,2HAA2H;QAC3H,kJAAkJ;KACnJ;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,2BAA2B;YACpC,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,6GAA6G;SACxH;QACD;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,6CAA6C;YACtD,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,gDAAgD;YAC/D,OAAO,EAAE,4CAA4C;YACrD,QAAQ,EAAE,6GAA6G;SACxH;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,wEAAwE;YACjF,QAAQ,EAAE,wCAAwC;SACnD;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,6BAA6B;SACxC;QACD;YACE,aAAa,EAAE,kDAAkD;YACjE,OAAO,EAAE,gCAAgC;YACzC,QAAQ,EAAE,yDAAyD;SACpE;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,uDAAuD;SACjE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,uMAAuM;SAClN;QACD;YACE,UAAU,EAAE,iEAAiE;YAC7E,QAAQ,EAAE,iFAAiF;SAC5F;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,uIAAuI;SAClJ;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,qFAAqF;SAChG;QACD;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,mGAAmG;SAC9G;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,+HAA+H;SAC1I;QACD;YACE,UAAU,EAAE,8BAA8B;YAC1C,QAAQ,EAAE,gHAAgH;SAC3H;QACD;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,qTAAqT;SAChU;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,wDAAwD;SACnE;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,iKAAiK;SAC5K;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,2IAA2I;SACtJ;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,uGAAuG;KAC/G;IACD,eAAe,EAAE,ukCAAukC;IACxlC,cAAc,EAAE;QACd,smBAAsmB;KACvmB;IACD,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}
+{"version":3,"file":"diag.js","sourceRoot":"","sources":["../../../src/generated/builtins/diag.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,MAAM;QACN,UAAU;QACV,QAAQ;QACR,YAAY;QACZ,KAAK;KACN;IACD,SAAS,EAAE,qEAAqE;IAChF,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,sKAAsK;KAChL;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,4FAA4F;KAC5G;IACD,aAAa,EAAE,qKAAqK;IACpL,WAAW,EAAE;QACX,iFAAiF;QACjF,4IAA4I;QAC5I,0FAA0F;QAC1F,4HAA4H;QAC5H,oGAAoG;QACpG,wJAAwJ;QACxJ,gJAAgJ;QAChJ,kHAAkH;QAClH,2HAA2H;QAC3H,kJAAkJ;KACnJ;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,2BAA2B;YACpC,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,6GAA6G;SACxH;QACD;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,6CAA6C;YACtD,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,gDAAgD;YAC/D,OAAO,EAAE,4CAA4C;YACrD,QAAQ,EAAE,6GAA6G;SACxH;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,wEAAwE;YACjF,QAAQ,EAAE,wCAAwC;SACnD;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,6BAA6B;SACxC;QACD;YACE,aAAa,EAAE,kDAAkD;YACjE,OAAO,EAAE,gCAAgC;YACzC,QAAQ,EAAE,yDAAyD;SACpE;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,uDAAuD;SACjE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,uMAAuM;SAClN;QACD;YACE,UAAU,EAAE,iEAAiE;YAC7E,QAAQ,EAAE,iFAAiF;SAC5F;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,uIAAuI;SAClJ;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,qFAAqF;SAChG;QACD;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,mGAAmG;SAC9G;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,+HAA+H;SAC1I;QACD;YACE,UAAU,EAAE,8BAA8B;YAC1C,QAAQ,EAAE,gHAAgH;SAC3H;QACD;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,4OAA4O;SACvP;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,wDAAwD;SACnE;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,iKAAiK;SAC5K;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,2IAA2I;SACtJ;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,uGAAuG;KAC/G;IACD,eAAe,EAAE,+qCAA+qC;IAChsC,cAAc,EAAE;QACd,glBAAglB;KACjlB;IACD,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/diary.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=diary.d.ts.map

package/dist/generated/builtins/diary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diary.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/diary.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA0GjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/diary.js

@@ -0,0 +1,111 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "diary",
+    "category": "io",
+    "keywords": [
+        "diary",
+        "log",
+        "command window",
+        "console",
+        "file"
+    ],
+    "summary": "Log command-window text to a file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host. Diary writes use the active filesystem provider and never operate on GPU buffers."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::diary::tests",
+        "integration": "diary_logs_command_window_output_to_file_provider"
+    },
+    "description": "`diary` records command-window stdout and stderr text to an append-only log file. It supports MATLAB function syntax and command syntax for enabling, disabling, toggling, and selecting the diary file.",
+    "behaviors": [
+        "`diary` with no input toggles logging on or off using the current diary file. The default file is `diary`.",
+        "`diary filename` and `diary('filename')` select a file and enable logging. Existing files are appended to rather than replaced.",
+        "`diary on` enables logging to the current file, and `diary off` disables logging.",
+        "The filename/state argument must be a string scalar, string scalar array, or character row. Empty text and nonscalar text values are rejected.",
+        "Diary writes go through the active RunMat filesystem provider, so sandboxed and virtual filesystem hosts receive the same file operations as normal file I/O builtins.",
+        "Command-window text captured by `evalc` is not written to the diary while the capture scope is active.",
+        "`diary` is a side-effecting sink and does not return output arguments. Requesting an output raises `RunMat:diary:TooManyOutputs`."
+    ],
+    "examples": [
+        {
+            "description": "Log command-window output to a file",
+            "input": "diary runmat_session.log\nA = magic(3);\ndisp(A)\ndiary off"
+        },
+        {
+            "description": "Use function syntax to select a diary file",
+            "input": "diary('experiment.log')\ndisp('started')\ndiary off"
+        },
+        {
+            "description": "Toggle the current diary state",
+            "input": "diary\ndisp('this line is logged')\ndiary"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `diary` overwrite an existing file?",
+            "answer": "No. RunMat opens the selected diary file in append mode, matching MATLAB diary behavior."
+        },
+        {
+            "question": "Does `diary` log text captured by `evalc`?",
+            "answer": "No. Text captured by `evalc` is diverted into the returned string and is not written to the normal command stream or diary log."
+        },
+        {
+            "question": "Does `diary` log workspace variables or figure state?",
+            "answer": "No. It logs command-window text only. It does not change variables, figures, or execution state beyond the diary on/off state and selected filename."
+        },
+        {
+            "question": "Can `diary` return an output value?",
+            "answer": "No. Like MATLAB, `diary` is controlled for side effects. Assigning its result raises `RunMat:diary:TooManyOutputs`."
+        },
+        {
+            "question": "Can `diary` write to host-specific filesystems?",
+            "answer": "Yes. It uses the active RunMat filesystem provider, so desktop, sandboxed, and embedded hosts control where the log is created."
+        },
+        {
+            "question": "Does GPU residency matter for `diary`?",
+            "answer": "No. `diary` is a host-side file sink and does not create GPU kernels, participate in fusion, or preserve GPU residency."
+        }
+    ],
+    "links": [
+        {
+            "label": "disp",
+            "url": "./disp"
+        },
+        {
+            "label": "evalc",
+            "url": "./evalc"
+        },
+        {
+            "label": "fprintf",
+            "url": "./fprintf"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/diary.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/diary.rs"
+    },
+    "gpu_behavior": [
+        "`diary` is a host-side logging builtin. It writes command-window text through the filesystem provider and is excluded from GPU execution and fusion planning."
+    ],
+    "key": "diary",
+    "slug": "diary",
+    "aliases": [],
+    "categoryPath": [
+        "io"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=diary.js.map

package/dist/generated/builtins/diary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diary.js","sourceRoot":"","sources":["../../../src/generated/builtins/diary.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE;QACV,OAAO;QACP,KAAK;QACL,gBAAgB;QAChB,SAAS;QACT,MAAM;KACP;IACD,SAAS,EAAE,oCAAoC;IAC/C,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,8GAA8G;KACxH;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,4BAA4B;QACpC,aAAa,EAAE,mDAAmD;KACnE;IACD,aAAa,EAAE,0MAA0M;IACzN,WAAW,EAAE;QACX,4GAA4G;QAC5G,iIAAiI;QACjI,mFAAmF;QACnF,gJAAgJ;QAChJ,wKAAwK;QACxK,wGAAwG;QACxG,mIAAmI;KACpI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,6DAA6D;SACvE;QACD;YACE,aAAa,EAAE,4CAA4C;YAC3D,OAAO,EAAE,qDAAqD;SAC/D;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,2CAA2C;SACrD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,0FAA0F;SACrG;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,iIAAiI;SAC5I;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,sJAAsJ;SACjK;QACD;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,qHAAqH;SAChI;QACD;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,iIAAiI;SAC5I;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,yHAAyH;SACpI;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,kDAAkD;QAC3D,KAAK,EAAE,+FAA+F;KACvG;IACD,cAAc,EAAE;QACd,+JAA+J;KAChK;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;KACL;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/dictionary.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=dictionary.d.ts.map

package/dist/generated/builtins/dictionary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/dictionary.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UAyDjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/dictionary.js

@@ -0,0 +1,62 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "dictionary",
+    "category": "table",
+    "keywords": [
+        "dictionary",
+        "map",
+        "keys",
+        "values",
+        "containers.Map"
+    ],
+    "summary": "Create a key-value dictionary object.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Dictionary objects are host metadata containers."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::table::tests",
+        "integration": "crates/runmat-vm/tests/tables_timetables.rs"
+    },
+    "description": "`dictionary(keys, values)` creates a dictionary object with cell-backed `Keys` and `Values` properties. Alternating key/value pairs are also accepted.",
+    "behaviors": [
+        "Keys and values must have the same number of elements.",
+        "String, numeric, logical, char, and cell collections are expanded into element lists."
+    ],
+    "examples": [
+        {
+            "description": "Create a dictionary",
+            "input": "D = dictionary([\"a\" \"b\"], [1 2])",
+            "output": "D = dictionary object"
+        }
+    ],
+    "links": [
+        {
+            "label": "containers.Map",
+            "url": "./containers.Map"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/table/mod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/table/mod.rs"
+    },
+    "key": "dictionary",
+    "slug": "dictionary",
+    "aliases": [],
+    "categoryPath": [
+        "table"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=dictionary.js.map

package/dist/generated/builtins/dictionary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary.js","sourceRoot":"","sources":["../../../src/generated/builtins/dictionary.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,YAAY;IACrB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE;QACV,YAAY;QACZ,KAAK;QACL,MAAM;QACN,QAAQ;QACR,gBAAgB;KACjB;IACD,SAAS,EAAE,uCAAuC;IAClD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,kDAAkD;KAC5D;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,wBAAwB;QAChC,aAAa,EAAE,6CAA6C;KAC7D;IACD,aAAa,EAAE,wJAAwJ;IACvK,WAAW,EAAE;QACX,wDAAwD;QACxD,uFAAuF;KACxF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,qBAAqB;YACpC,OAAO,EAAE,sCAAsC;YAC/C,QAAQ,EAAE,uBAAuB;SAClC;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,kBAAkB;SAC1B;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins/digitsPattern.d.ts

@@ -0,0 +1,4 @@
+import type { BuiltinDoc } from "../../builtins.js";
+declare const builtinDoc: BuiltinDoc;
+export default builtinDoc;
+//# sourceMappingURL=digitsPattern.d.ts.map

package/dist/generated/builtins/digitsPattern.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"digitsPattern.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/digitsPattern.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,UA0FjB,CAAC;AAEF,eAAe,UAAU,CAAC"}