runmat 0.4.5-dev.3 → 0.4.5-dev.4

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

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

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

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

package/dist/generated/builtins/imshow.js

@@ -0,0 +1,104 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "imshow",
+    "category": "plotting",
+    "keywords": [
+        "imshow",
+        "image display",
+        "grayscale image",
+        "binary image",
+        "rgb image",
+        "matlab imshow"
+    ],
+    "summary": "Display grayscale, binary, truecolor, or file-backed images.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`imshow` is a plotting sink and does not advertise precision-specialized GPU kernels. Grayscale gpuArray inputs may use the image/surface rendering path; filename decoding and truecolor normalization run on the host."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::imshow::tests"
+    },
+    "description": "`imshow` displays image data using MATLAB-familiar defaults. Numeric and logical 2-D arrays render as grayscale images, MxNx3 and MxNx4 arrays render as truecolor images, and filename inputs are decoded through RunMat's filesystem layer before display.",
+    "behaviors": [
+        "`imshow(I)` displays 2-D numeric data with grayscale limits `[0, 1]`, matching MATLAB double-image defaults.",
+        "`imshow(BW)` displays logical image data as black and white using `[0, 1]` limits.",
+        "`imshow(RGB)` displays MxNx3 truecolor data directly.",
+        "`imshow(RGBA)` displays MxNx4 truecolor data with alpha.",
+        "`imshow(I, [low high])` displays grayscale image data using an explicit display range.",
+        "`imshow(I, [])` auto-scales grayscale image data from finite minimum to finite maximum.",
+        "`imshow(filename)` reads and decodes an image file, then displays it as truecolor data."
+    ],
+    "examples": [
+        {
+            "description": "Display a simple grayscale image",
+            "input": "row = 100;\ncol = 100;\nrsm = ones(row, col);\nimshow(rsm);"
+        },
+        {
+            "description": "Auto-scale a matrix for display",
+            "input": "A = peaks(128);\nimshow(A, []);"
+        },
+        {
+            "description": "Display truecolor RGB data",
+            "input": "R = ones(64, 64);\nG = zeros(64, 64);\nB = zeros(64, 64);\nRGB = cat(3, R, G, B);\nimshow(RGB);"
+        },
+        {
+            "description": "Display an image file",
+            "input": "imshow(\"photo.png\");"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What display range does imshow use for doubles?",
+            "answer": "`imshow(I)` uses `[0, 1]` for floating-point grayscale data. Use `imshow(I, [])` when you want RunMat to scale the visible range from the data minimum to maximum."
+        },
+        {
+            "question": "Does imshow support uint8 and uint16 image defaults?",
+            "answer": "File-backed images decode with byte pixel semantics. User-created integer image arrays currently depend on RunMat's broader numeric-class metadata model, so exact MATLAB class-dependent defaults for dense uint8/uint16 tensors are tracked separately."
+        },
+        {
+            "question": "How is imshow different from imagesc?",
+            "answer": "`imshow` is for image display and uses grayscale or truecolor image defaults. `imagesc` is for scaled matrix visualization and maps data through the active colormap."
+        }
+    ],
+    "links": [
+        {
+            "label": "image",
+            "url": "./image"
+        },
+        {
+            "label": "imagesc",
+            "url": "./imagesc"
+        },
+        {
+            "label": "colormap",
+            "url": "./colormap"
+        },
+        {
+            "label": "axis",
+            "url": "./axis"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/imshow.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/imshow.rs"
+    },
+    "key": "imshow",
+    "slug": "imshow",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=imshow.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"imshow.js","sourceRoot":"","sources":["../../../src/generated/builtins/imshow.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,QAAQ;QACR,eAAe;QACf,iBAAiB;QACjB,cAAc;QACd,WAAW;QACX,eAAe;KAChB;IACD,SAAS,EAAE,8DAA8D;IACzE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,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,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,mCAAmC;KAC5C;IACD,aAAa,EAAE,8PAA8P;IAC7Q,WAAW,EAAE;QACX,8GAA8G;QAC9G,oFAAoF;QACpF,uDAAuD;QACvD,0DAA0D;QAC1D,wFAAwF;QACxF,yFAAyF;QACzF,yFAAyF;KAC1F;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,6DAA6D;SACvE;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,iCAAiC;SAC3C;QACD;YACE,aAAa,EAAE,4BAA4B;YAC3C,OAAO,EAAE,iGAAiG;SAC3G;QACD;YACE,aAAa,EAAE,uBAAuB;YACtC,OAAO,EAAE,wBAAwB;SAClC;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,oKAAoK;SAC/K;QACD;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,2PAA2P;SACtQ;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,uKAAuK;SAClL;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;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;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,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,EAq4OjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAuX9D,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,EAy5OjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAwX9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -3117,6 +3117,26 @@ export const builtinManifest = [
         "summary": "Filter images or N-D arrays with correlation/convolution kernels and configurable padding.",
         "exampleCount": 5
     },
+    {
+        "key": "imshow",
+        "title": "imshow",
+        "slug": "imshow",
+        "aliases": [],
+        "category": "plotting",
+        "categoryPath": [
+            "plotting"
+        ],
+        "keywords": [
+            "imshow",
+            "image display",
+            "grayscale image",
+            "binary image",
+            "rgb image",
+            "matlab imshow"
+        ],
+        "summary": "Display grayscale, binary, truecolor, or file-backed images.",
+        "exampleCount": 4
+    },
     {
         "key": "ind2sub",
         "title": "ind2sub",
@@ -7713,6 +7733,7 @@ export const builtinDocLoaders = {
     "image": () => import("./builtins/image.js").then((mod) => mod.default),
     "imagesc": () => import("./builtins/imagesc.js").then((mod) => mod.default),
     "imfilter": () => import("./builtins/imfilter.js").then((mod) => mod.default),
+    "imshow": () => import("./builtins/imshow.js").then((mod) => mod.default),
     "ind2sub": () => import("./builtins/ind2sub.js").then((mod) => mod.default),
     "input": () => import("./builtins/input.js").then((mod) => mod.default),
     "interp1": () => import("./builtins/interp1.js").then((mod) => mod.default),