runmat 0.3.6 → 0.4.1

package/dist/generated/builtins/colon.js

@@ -0,0 +1,193 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "colon",
+    "category": "array/creation",
+    "keywords": [
+        "colon",
+        "sequence",
+        "range",
+        "step",
+        "gpu"
+    ],
+    "summary": "Generate MATLAB-style arithmetic progressions with optional step size.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "Prefers provider `linspace` kernels when available; otherwise the runtime uploads the host-generated vector so residency stays on device."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::array::creation::colon::tests",
+        "integration": "builtins::array::creation::colon::tests::colon_gpu_roundtrip",
+        "wgpu": "builtins::array::creation::colon::tests::colon_wgpu_matches_cpu"
+    },
+    "description": "`colon(start, stop)` and `colon(start, step, stop)` build row vectors that mirror the MATLAB colon operator. The function returns an arithmetic progression that begins at `start`, advances by `step` (default `+1` or `-1` depending on the bounds), and stops before exceeding `stop`.",
+    "behaviors": [
+        "Inputs must be real scalars (numeric, logical, scalar tensors, or single-character arrays). Imaginary parts must be zero.",
+        "`colon(start, stop)` picks an increment of `+1` when `stop ≥ start`, otherwise `-1`.",
+        "`colon(start, step, stop)` uses the supplied increment. A zero increment raises an error.",
+        "When the endpoints are character scalars, the result is a row vector of characters; otherwise a double-precision row vector. Empty progressions are `1×0`.",
+        "`stop` is included only when it lies on the arithmetic progression; otherwise the sequence stops at the last admissible value before overshooting.",
+        "Arguments may be `gpuArray` scalars; the result stays on the GPU when a provider is active.",
+        "Floating-point tolerance follows MATLAB’s rules, so values that should land on `stop` are preserved even when rounding noise accumulates."
+    ],
+    "examples": [
+        {
+            "description": "Generating consecutive integers",
+            "input": "x = colon(1, 5)",
+            "output": "x = [1 2 3 4 5]"
+        },
+        {
+            "description": "Counting down without specifying a step",
+            "input": "y = colon(5, 1)",
+            "output": "y = [5 4 3 2 1]"
+        },
+        {
+            "description": "Using a custom increment",
+            "input": "z = colon(0, 0.5, 2)",
+            "output": "z = [0 0.5 1.0 1.5 2.0]"
+        },
+        {
+            "description": "Stopping before overshooting the end point",
+            "input": "vals = colon(0, 2, 5)",
+            "output": "vals = [0 2 4]"
+        },
+        {
+            "description": "Working with fractional radians",
+            "input": "theta = colon(-pi, pi/4, pi/2)",
+            "output": "theta = [-3.1416 -2.3562 -1.5708 -0.7854 0.0000 0.7854 1.5708]"
+        },
+        {
+            "description": "Keeping sequences on the GPU",
+            "input": "g = gpuArray(0);\nh = colon(g, 0.25, 1);\nresult = gather(h)",
+            "output": "result = [0 0.25 0.5 0.75 1.0]"
+        },
+        {
+            "description": "Building character ranges",
+            "input": "letters = colon('a', 'f')\nodds    = colon('a', 2, 'g')",
+            "output": "letters = 'abcdef';\nodds    = 'aceg'"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What happens when `start == stop`?",
+            "answer": "The output is a single-element vector containing `start`. With two arguments the implicit step is `+1`, so the result is `[start]`."
+        },
+        {
+            "question": "Why is `stop` sometimes missing from the result?",
+            "answer": "`stop` is included only when it aligns with the arithmetic progression. For example, `colon(0, 2, 5)` produces `[0 2 4]` because `6` would overshoot the upper bound."
+        },
+        {
+            "question": "Can I use zero or complex increments?",
+            "answer": "No. The increment must be a finite, non-zero real scalar. Supplying `0` or a value with a non-zero imaginary part raises an error."
+        },
+        {
+            "question": "Can I generate character sequences?",
+            "answer": "Yes. When both `start` and `stop` are single-character arrays, `colon` returns a character row vector. Step values can still be numeric (for example, `colon('a', 2, 'g')` produces `'aceg'`)."
+        },
+        {
+            "question": "Does the function accept logical inputs?",
+            "answer": "Yes. Logical scalars are promoted to doubles (`true → 1`, `false → 0`) before building the sequence."
+        },
+        {
+            "question": "How does this differ from `linspace`?",
+            "answer": "`linspace(start, stop, n)` lets you pick the number of points directly, whereas `colon` fixes the increment (`start:step:stop`). When `stop` is not exactly reachable, `colon` stops short instead of nudging the final value."
+        }
+    ],
+    "links": [
+        {
+            "label": "linspace",
+            "url": "./linspace"
+        },
+        {
+            "label": "logspace",
+            "url": "./logspace"
+        },
+        {
+            "label": "range",
+            "url": "./range"
+        },
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        },
+        {
+            "label": "eye",
+            "url": "./eye"
+        },
+        {
+            "label": "false",
+            "url": "./false"
+        },
+        {
+            "label": "fill",
+            "url": "./fill"
+        },
+        {
+            "label": "magic",
+            "url": "./magic"
+        },
+        {
+            "label": "meshgrid",
+            "url": "./meshgrid"
+        },
+        {
+            "label": "ones",
+            "url": "./ones"
+        },
+        {
+            "label": "rand",
+            "url": "./rand"
+        },
+        {
+            "label": "randi",
+            "url": "./randi"
+        },
+        {
+            "label": "randn",
+            "url": "./randn"
+        },
+        {
+            "label": "randperm",
+            "url": "./randperm"
+        },
+        {
+            "label": "true",
+            "url": "./true"
+        },
+        {
+            "label": "zeros",
+            "url": "./zeros"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/array/creation/colon.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/array/creation/colon.rs"
+    },
+    "gpu_residency": "RunMat automatically keeps the output on the GPU when any input scalar already resides there and an acceleration provider is active. Providers that implement the `linspace` hook (such as the wgpu backend) generate the progression entirely on device. Other providers still return a GPU tensor by uploading the host-generated vector, so downstream kernels can fuse without an extra gather.",
+    "key": "colon",
+    "slug": "colon",
+    "categoryPath": [
+        "array",
+        "creation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=colon.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"colon.js","sourceRoot":"","sources":["../../../src/generated/builtins/colon.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE;QACV,OAAO;QACP,UAAU;QACV,OAAO;QACP,MAAM;QACN,KAAK;KACN;IACD,SAAS,EAAE,wEAAwE;IACnF,YAAY,EAAE,EAAE;IAChB,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,2IAA2I;KACrJ;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,yCAAyC;QACjD,aAAa,EAAE,8DAA8D;QAC7E,MAAM,EAAE,iEAAiE;KAC1E;IACD,aAAa,EAAE,2RAA2R;IAC1S,WAAW,EAAE;QACX,2HAA2H;QAC3H,sFAAsF;QACtF,2FAA2F;QAC3F,4JAA4J;QAC5J,oJAAoJ;QACpJ,6FAA6F;QAC7F,2IAA2I;KAC5I;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,iBAAiB;YAC1B,QAAQ,EAAE,iBAAiB;SAC5B;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,iBAAiB;YAC1B,QAAQ,EAAE,iBAAiB;SAC5B;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,yBAAyB;SACpC;QACD;YACE,aAAa,EAAE,4CAA4C;YAC3D,OAAO,EAAE,uBAAuB;YAChC,QAAQ,EAAE,gBAAgB;SAC3B;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,gCAAgC;YACzC,QAAQ,EAAE,gEAAgE;SAC3E;QACD;YACE,aAAa,EAAE,8BAA8B;YAC7C,OAAO,EAAE,8DAA8D;YACvE,QAAQ,EAAE,gCAAgC;SAC3C;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,yDAAyD;YAClE,QAAQ,EAAE,uCAAuC;SAClD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,qIAAqI;SAChJ;QACD;YACE,UAAU,EAAE,kDAAkD;YAC9D,QAAQ,EAAE,uKAAuK;SAClL;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,oIAAoI;SAC/I;QACD;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,gMAAgM;SAC3M;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,sGAAsG;SACjH;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,gOAAgO;SAC3O;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,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;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,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,KAAK,EAAE,2GAA2G;KACnH;IACD,eAAe,EAAE,qYAAqY;IACtZ,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,cAAc,EAAE;QACd,OAAO;QACP,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/colorbar.js

@@ -0,0 +1,64 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "colorbar",
+    "category": "plotting",
+    "keywords": [
+        "colorbar",
+        "color scale",
+        "image colorbar",
+        "surface colorbar",
+        "matlab colorbar"
+    ],
+    "summary": "Show or hide colorbars for images, surfaces, contours, and MATLAB `colorbar` workflows.",
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::cmds"
+    },
+    "description": "`colorbar` toggles the visibility of the color scale associated with the current axes. In RunMat it is subplot-local and is most often used with `imagesc`, `image`, `surf`, `contourf`, and related colormap-driven visualizations.",
+    "behaviors": [
+        "`colorbar on` enables the colorbar for the current axes.",
+        "`colorbar off` disables the colorbar for the current axes.",
+        "Calling `colorbar` with no argument toggles the current colorbar state.",
+        "Colorbar visibility is subplot-local and does not automatically affect other axes."
+    ],
+    "examples": [
+        {
+            "description": "Show a colorbar for a scaled image",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 60), linspace(-3, 3, 60));\nA = sin(X) .* cos(Y);\nimagesc(A);\ncolorbar on;"
+        },
+        {
+            "description": "Use colorbars independently across subplots",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 40), linspace(-3, 3, 40));\nZ = sin(X) .* cos(Y);\nsubplot(1, 2, 1);\ncontourf(X, Y, Z);\ncolorbar on;\nsubplot(1, 2, 2);\nsurf(X, Y, Z);\ncolorbar off;"
+        }
+    ],
+    "links": [
+        {
+            "label": "colormap",
+            "url": "./colormap"
+        },
+        {
+            "label": "imagesc",
+            "url": "./imagesc"
+        },
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "contourf",
+            "url": "./contourf"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs"
+    },
+    "key": "colorbar",
+    "slug": "colorbar",
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=colorbar.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"colorbar.js","sourceRoot":"","sources":["../../../src/generated/builtins/colorbar.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,UAAU;QACV,aAAa;QACb,gBAAgB;QAChB,kBAAkB;QAClB,iBAAiB;KAClB;IACD,SAAS,EAAE,yFAAyF;IACpG,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,0BAA0B;KACnC;IACD,aAAa,EAAE,sOAAsO;IACrP,WAAW,EAAE;QACX,0DAA0D;QAC1D,4DAA4D;QAC5D,yEAAyE;QACzE,oFAAoF;KACrF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,gHAAgH;SAC1H;QACD;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,4LAA4L;SACtM;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,wGAAwG;KAChH;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/colormap.js

@@ -0,0 +1,68 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "colormap",
+    "category": "plotting",
+    "keywords": [
+        "colormap",
+        "color palette",
+        "heatmap palette",
+        "surface palette",
+        "matlab colormap"
+    ],
+    "summary": "Set colormaps for images, surfaces, contours, and MATLAB `colormap` workflows.",
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::cmds"
+    },
+    "description": "`colormap` sets the active color palette for the current plotting context. In RunMat it affects colormap-driven visualizations such as `imagesc`, `surf`, `surfc`, `contourf`, and related scalar-field plots while remaining scoped to the active axes state.",
+    "behaviors": [
+        "Supported colormap names include `parula`, `viridis`, `plasma`, `inferno`, `magma`, `turbo`, `jet`, `hot`, `cool`, `spring`, `summer`, `autumn`, `winter`, `gray`, `bone`, `copper`, `pink`, and `lines`.",
+        "Unknown colormap names raise errors rather than silently falling back.",
+        "Colormap state composes naturally with `colorbar`, `imagesc`, `surf`, and filled contour plots.",
+        "Colormap changes apply to the current axes context in the plotting state model."
+    ],
+    "examples": [
+        {
+            "description": "Apply a palette to a scaled image",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 60), linspace(-3, 3, 60));\nA = sin(X) .* cos(Y);\nimagesc(A);\ncolormap('jet');\ncolorbar;"
+        },
+        {
+            "description": "Compare palettes across subplots",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 40), linspace(-3, 3, 40));\nZ = sin(X) .* cos(Y);\nsubplot(1, 2, 1);\nsurf(X, Y, Z);\ncolormap('parula');\nsubplot(1, 2, 2);\ncontourf(X, Y, Z);\ncolormap('turbo');"
+        }
+    ],
+    "links": [
+        {
+            "label": "colorbar",
+            "url": "./colorbar"
+        },
+        {
+            "label": "imagesc",
+            "url": "./imagesc"
+        },
+        {
+            "label": "image",
+            "url": "./image"
+        },
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "contourf",
+            "url": "./contourf"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs"
+    },
+    "key": "colormap",
+    "slug": "colormap",
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=colormap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"colormap.js","sourceRoot":"","sources":["../../../src/generated/builtins/colormap.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,UAAU;QACV,eAAe;QACf,iBAAiB;QACjB,iBAAiB;QACjB,iBAAiB;KAClB;IACD,SAAS,EAAE,gFAAgF;IAC3F,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,0BAA0B;KACnC;IACD,aAAa,EAAE,gQAAgQ;IAC/Q,WAAW,EAAE;QACX,2MAA2M;QAC3M,wEAAwE;QACxE,iGAAiG;QACjG,iFAAiF;KAClF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,+HAA+H;SACzI;QACD;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,wMAAwM;SAClN;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;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;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,wGAAwG;KAChH;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/compose.js

@@ -0,0 +1,184 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "compose",
+    "category": "strings/core",
+    "keywords": [
+        "compose",
+        "format",
+        "string array",
+        "sprintf",
+        "gpu"
+    ],
+    "summary": "Format numeric, logical, and text data into MATLAB string arrays using printf-style placeholders.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/compose.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Formatting runs on the CPU. GPU inputs are gathered to host memory before substitution."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::strings::core::compose::tests",
+        "integration": "builtins::strings::core::compose::tests::compose_gpu_argument"
+    },
+    "description": "`compose(formatSpec, A1, ..., An)` substitutes data into MATLAB-compatible `%` placeholders and returns the result as a string array. It combines `sprintf`-style formatting with string-array broadcasting so you can generate multiple strings in one call.",
+    "behaviors": [
+        "`formatSpec` must be text: a string scalar, string array, character vector, character array, or cell array of character vectors.",
+        "If `formatSpec` is scalar and any argument array has more than one element, RunMat broadcasts the scalar specification over the array dimensions.",
+        "When `formatSpec` is a string or character array with multiple elements, the output has the same shape as the specification. Each element uses the corresponding row or cell during formatting.",
+        "Arguments can be numeric, logical, string, or text-like cell arrays. Non-text arguments are converted using MATLAB-compatible rules (logical values become `1` or `0`, complex numbers use the `a + bi` form).",
+        "When you omit additional arguments, `compose(formatSpec)` simply converts the specification into a string array, preserving the original structure.",
+        "Errors are raised if argument shapes are incompatible with the specification or if format specifiers are incomplete."
+    ],
+    "examples": [
+        {
+            "description": "Formatting A Scalar Value Into A Sentence",
+            "input": "msg = compose(\"The answer is %d.\", 42)",
+            "output": "msg = \"The answer is 42.\""
+        },
+        {
+            "description": "Broadcasting A Scalar Format Spec Over A Vector",
+            "input": "result = compose(\"Trial %d\", 1:4)",
+            "output": "result = 1×4 string\n    \"Trial 1\"    \"Trial 2\"    \"Trial 3\"    \"Trial 4\""
+        },
+        {
+            "description": "Using A String Array Of Formats",
+            "input": "spec = [\"max: %0.2f\", \"min: %0.2f\"];\nvalues = compose(spec, [3.14159, 0.125])",
+            "output": "values = 1×2 string\n    \"max: 3.14\"    \"min: 0.12\""
+        },
+        {
+            "description": "Formatting Each Row Of A Character Array",
+            "input": "C = ['Row %02d'; 'Row %02d'; 'Row %02d'];\nidx = compose(C, (1:3).')",
+            "output": "idx = 3×1 string\n    \"Row 01\"\n    \"Row 02\"\n    \"Row 03\""
+        },
+        {
+            "description": "Combining Real And Imaginary Parts",
+            "input": "Z = [1+2i, 3-4i];\ntxt = compose(\"z = %s\", Z)",
+            "output": "txt = 1×2 string\n    \"z = 1+2i\"    \"z = 3-4i\""
+        },
+        {
+            "description": "Using A Cell Array Of Format Specs",
+            "input": "specs = {'%0.1f volts', '%0.1f amps'};\nreadings = compose(specs, {12.6, 3.4})",
+            "output": "readings = 2×1 string\n    \"12.6 volts\"\n    \"3.4 amps\""
+        },
+        {
+            "description": "Formatting GPU-Resident Data",
+            "input": "G = gpuArray([10 20 30]);\nlabels = compose(\"Value %d\", G)",
+            "output": "labels = 1×3 string\n    \"Value 10\"    \"Value 20\"    \"Value 30\""
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What happens if the number of format arguments does not match the placeholders?",
+            "answer": "RunMat raises `compose: format data arguments must be scalars or match formatSpec size`. Ensure that each placeholder has a corresponding value or broadcast the specification appropriately."
+        },
+        {
+            "question": "Can `compose` handle complex numbers?",
+            "answer": "Yes. Complex numbers use MATLAB's canonical `a + bi` formatting, so `%s` specifiers receive the string form of the complex scalar."
+        },
+        {
+            "question": "How does `compose` treat logical inputs?",
+            "answer": "Logical values are converted to numeric `1` or `0` before formatting so they work with `%d`, `%i`, or `%f` placeholders."
+        },
+        {
+            "question": "Does `compose` modify the shape of the output?",
+            "answer": "No. The output matches the broadcasted size between `formatSpec` and the input arguments. Scalar specifications broadcast across non-scalar arguments."
+        },
+        {
+            "question": "What if I pass GPU arrays?",
+            "answer": "Inputs that reside on the GPU are automatically gathered to host memory before formatting. The resulting string array always lives on the CPU."
+        },
+        {
+            "question": "How do I emit literal percent signs?",
+            "answer": "Use `%%` inside `formatSpec` just like `sprintf`. The formatter converts `%%` into a single `%`."
+        },
+        {
+            "question": "Can I mix scalars and arrays in the arguments list?",
+            "answer": "Yes, as long as non-scalar arguments all share the same number of elements or match the size of `formatSpec`. Scalars broadcast across the target shape."
+        },
+        {
+            "question": "What happens when `formatSpec` is empty?",
+            "answer": "`compose(formatSpec)` returns an empty string array with the same shape as `formatSpec`. When `formatSpec` and arguments have zero elements, the output is `0×0`."
+        }
+    ],
+    "links": [
+        {
+            "label": "string",
+            "url": "./string"
+        },
+        {
+            "label": "sprintf",
+            "url": "./sprintf"
+        },
+        {
+            "label": "strcat",
+            "url": "./strcat"
+        },
+        {
+            "label": "join",
+            "url": "./join"
+        },
+        {
+            "label": "char",
+            "url": "./char"
+        },
+        {
+            "label": "num2str",
+            "url": "./num2str"
+        },
+        {
+            "label": "str2double",
+            "url": "./str2double"
+        },
+        {
+            "label": "strcmp",
+            "url": "./strcmp"
+        },
+        {
+            "label": "strcmpi",
+            "url": "./strcmpi"
+        },
+        {
+            "label": "string.empty",
+            "url": "./string.empty"
+        },
+        {
+            "label": "strings",
+            "url": "./strings"
+        },
+        {
+            "label": "strlength",
+            "url": "./strlength"
+        },
+        {
+            "label": "strncmp",
+            "url": "./strncmp"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/core/compose.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/core/compose.rs"
+    },
+    "gpu_behavior": [
+        "`compose` is a residency sink. When inputs include GPU-resident tensors, RunMat gathers the data back to host memory using the active acceleration provider before performing the formatting logic. All formatted strings live in host memory, so acceleration providers do not need compose-specific kernels."
+    ],
+    "key": "compose",
+    "slug": "compose",
+    "categoryPath": [
+        "strings",
+        "core"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=compose.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"compose.js","sourceRoot":"","sources":["../../../src/generated/builtins/compose.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE;QACV,SAAS;QACT,QAAQ;QACR,cAAc;QACd,SAAS;QACT,KAAK;KACN;IACD,SAAS,EAAE,mGAAmG;IAC9G,YAAY,EAAE;QACZ,wDAAwD;KACzD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,yFAAyF;KACnG;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,yCAAyC;QACjD,aAAa,EAAE,+DAA+D;KAC/E;IACD,aAAa,EAAE,+PAA+P;IAC9Q,WAAW,EAAE;QACX,kIAAkI;QAClI,mJAAmJ;QACnJ,iMAAiM;QACjM,gNAAgN;QAChN,qJAAqJ;QACrJ,sHAAsH;KACvH;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,0CAA0C;YACnD,QAAQ,EAAE,6BAA6B;SACxC;QACD;YACE,aAAa,EAAE,iDAAiD;YAChE,OAAO,EAAE,qCAAqC;YAC9C,QAAQ,EAAE,mFAAmF;SAC9F;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,oFAAoF;YAC7F,QAAQ,EAAE,yDAAyD;SACpE;QACD;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,sEAAsE;YAC/E,QAAQ,EAAE,kEAAkE;SAC7E;QACD;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,iDAAiD;YAC1D,QAAQ,EAAE,oDAAoD;SAC/D;QACD;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,gFAAgF;YACzF,QAAQ,EAAE,6DAA6D;SACxE;QACD;YACE,aAAa,EAAE,8BAA8B;YAC7C,OAAO,EAAE,8DAA8D;YACvE,QAAQ,EAAE,uEAAuE;SAClF;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,iFAAiF;YAC7F,QAAQ,EAAE,+LAA+L;SAC1M;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,oIAAoI;SAC/I;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,0HAA0H;SACrI;QACD;YACE,UAAU,EAAE,gDAAgD;YAC5D,QAAQ,EAAE,wJAAwJ;SACnK;QACD;YACE,UAAU,EAAE,4BAA4B;YACxC,QAAQ,EAAE,gJAAgJ;SAC3J;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,kGAAkG;SAC7G;QACD;YACE,UAAU,EAAE,qDAAqD;YACjE,QAAQ,EAAE,0JAA0J;SACrK;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,mKAAmK;SAC9K;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;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;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,KAAK,EAAE,2GAA2G;KACnH;IACD,cAAc,EAAE;QACd,gTAAgT;KACjT;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,cAAc,EAAE;QACd,SAAS;QACT,MAAM;KACP;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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