runmat 0.4.10-dev.6 → 0.4.10-dev.7

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

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

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

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

package/dist/generated/builtins/print.js

@@ -0,0 +1,112 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "print",
+    "category": "plotting",
+    "keywords": [
+        "print",
+        "figure export",
+        "png",
+        "plotting",
+        "save figure"
+    ],
+    "summary": "Export the active or specified figure to a PNG file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`print` is a figure export sink. It gathers filename and option arguments when needed, then serializes the figure through the plotting renderer. Existing GPU-backed plot geometry can still use the shared WGPU plotting path during export."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 4,
+        "constants": "inline"
+    },
+    "requires_feature": "plot-core",
+    "tested": {
+        "unit": "builtins::plotting::print::tests",
+        "integration": "direct headless Chrome WASM verification of print.json examples"
+    },
+    "description": "`print` exports a figure to a file. RunMat currently supports PNG output with MATLAB-style device and resolution tokens, including `print('name', '-dpng')`, `print('name', '-dpng', '-r300')`, and `print(fig, 'name', '-dpng')`. In browser and WASM hosts the file is written through RunMat's virtual filesystem provider so the host can persist or download it.",
+    "behaviors": [
+        "`print(filename, '-dpng')` writes PNG bytes to `filename`. If the name has no `.png` extension, RunMat appends one.",
+        "`print(filename, '-dpng', '-rN')` scales the export dimensions from the default 800 by 600 canvas using `N` DPI relative to RunMat's 150 DPI default.",
+        "`print(fig, filename, '-dpng')` exports the specified figure handle instead of the active figure.",
+        "Command-style argument order is accepted when RunMat parses command calls into string arguments, such as `print -dpng plot.png`.",
+        "PDF, EPS, and SVG device tokens are recognized but return a clear unsupported-device error until those exporters are implemented."
+    ],
+    "examples": [
+        {
+            "description": "Export the active figure to a PNG file",
+            "input": "x = 0:0.1:2*pi;\nplot(x, sin(x));\nprint(\"sine_plot\", \"-dpng\");"
+        },
+        {
+            "description": "Export at a higher resolution",
+            "input": "x = 0:0.1:1;\nplot(x, x.^2, \"LineWidth\", 2);\nprint(\"quadratic_plot\", \"-dpng\", \"-r300\");"
+        },
+        {
+            "description": "Export a specific figure handle",
+            "input": "fig = figure();\nplot(1:5, [1 4 2 5 3]);\nprint(fig, \"explicit_handle_plot.png\", \"-dpng\");"
+        },
+        {
+            "description": "Command-style device order",
+            "input": "plot(1:4, [1 3 2 4]);\nprint -dpng command_style_plot.png"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Which formats does `print` support?",
+            "answer": "PNG is supported today with `-dpng`. RunMat recognizes PDF, EPS, and SVG device tokens, but they return an unsupported-device error until those exporters are available in the rendering stack."
+        },
+        {
+            "question": "Where does the file go in the browser?",
+            "answer": "The PNG is written through RunMat's filesystem provider. In the sandbox this is usually the in-memory or IndexedDB-backed virtual filesystem, and the host can expose the file as a download artifact."
+        },
+        {
+            "question": "Does `-r300` change the figure data?",
+            "answer": "No. It only changes the pixel dimensions used for export. The plot data and graphics handles remain unchanged."
+        }
+    ],
+    "links": [
+        {
+            "label": "figure",
+            "url": "./figure"
+        },
+        {
+            "label": "gcf",
+            "url": "./gcf"
+        },
+        {
+            "label": "plot",
+            "url": "./plot"
+        },
+        {
+            "label": "Plot replay and export",
+            "url": "/docs/plotting/plot-replay-and-export"
+        },
+        {
+            "label": "Complete plotting guide",
+            "url": "/blog/matlab-plotting-guide"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/print.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/print.rs"
+    },
+    "gpu_residency": "`print` is an I/O sink and returns a host logical status. Filename and option arguments are gathered before parsing. GPU-resident plot data already captured in figure state may still be consumed by the plotting renderer without forcing user-visible gathers when the shared WGPU export path is available.",
+    "gpu_behavior": [
+        "No numeric GPU kernels are launched for `print` itself.",
+        "The PNG exporter first attempts the interactive GPU render path and falls back to CPU rasterization when headless GPU initialization is unavailable.",
+        "The builtin writes PNG bytes through RunMat's filesystem layer, so output storage is host or virtual-filesystem backed."
+    ],
+    "key": "print",
+    "slug": "print",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=print.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"print.js","sourceRoot":"","sources":["../../../src/generated/builtins/print.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,OAAO;QACP,eAAe;QACf,KAAK;QACL,UAAU;QACV,aAAa;KACd;IACD,SAAS,EAAE,sDAAsD;IACjE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,+OAA+O;KACzP;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,WAAW;IAC/B,QAAQ,EAAE;QACR,MAAM,EAAE,kCAAkC;QAC1C,aAAa,EAAE,iEAAiE;KACjF;IACD,aAAa,EAAE,uWAAuW;IACtX,WAAW,EAAE;QACX,qHAAqH;QACrH,uJAAuJ;QACvJ,mGAAmG;QACnG,kIAAkI;QAClI,mIAAmI;KACpI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,qEAAqE;SAC/E;QACD;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,kGAAkG;SAC5G;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,gGAAgG;SAC1G;QACD;YACE,aAAa,EAAE,4BAA4B;YAC3C,OAAO,EAAE,2DAA2D;SACrE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,iMAAiM;SAC5M;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,wMAAwM;SACnN;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,gHAAgH;SAC3H;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,uCAAuC;SAC/C;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,6BAA6B;SACrC;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,4DAA4D;QACrE,KAAK,EAAE,yGAAyG;KACjH;IACD,eAAe,EAAE,iTAAiT;IAClU,cAAc,EAAE;QACd,yDAAyD;QACzD,sJAAsJ;QACtJ,yHAAyH;KAC1H;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins-manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EA8yQjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAqa9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}
+{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EAi0QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAsa9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -5720,6 +5720,25 @@ export const builtinManifest = [
         "summary": "Evaluate a piecewise-polynomial structure.",
         "exampleCount": 1
     },
+    {
+        "key": "print",
+        "title": "print",
+        "slug": "print",
+        "aliases": [],
+        "category": "plotting",
+        "categoryPath": [
+            "plotting"
+        ],
+        "keywords": [
+            "print",
+            "figure export",
+            "png",
+            "plotting",
+            "save figure"
+        ],
+        "summary": "Export the active or specified figure to a PNG file.",
+        "exampleCount": 4
+    },
     {
         "key": "prod",
         "title": "prod",
@@ -8778,6 +8797,7 @@ export const builtinDocLoaders = {
     "pow2": () => import("./builtins/pow2.js").then((mod) => mod.default),
     "power": () => import("./builtins/power.js").then((mod) => mod.default),
     "ppval": () => import("./builtins/ppval.js").then((mod) => mod.default),
+    "print": () => import("./builtins/print.js").then((mod) => mod.default),
     "prod": () => import("./builtins/prod.js").then((mod) => mod.default),
     "pwd": () => import("./builtins/pwd.js").then((mod) => mod.default),
     "qammod": () => import("./builtins/qammod.js").then((mod) => mod.default),