runmat 0.4.10-dev.7 → 0.4.10-dev.8

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

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

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

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

package/dist/generated/builtins/scatterplot.js

@@ -0,0 +1,115 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "scatterplot",
+    "category": "communications/plotting",
+    "keywords": [
+        "scatterplot",
+        "constellation diagram",
+        "communications toolbox",
+        "complex baseband",
+        "qam",
+        "psk",
+        "scatter"
+    ],
+    "summary": "Plot complex-baseband samples as a 2-D constellation diagram.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "single",
+            "double"
+        ],
+        "broadcasting": "none",
+        "notes": "`scatterplot` is a rendering sink. When GPU-resident samples can be split into real and imaginary buffers without decimation, RunMat forwards those buffers to the existing GPU scatter renderer. Decimated or unsupported inputs gather once and render through the same scatter semantics."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::scatterplot::tests",
+        "integration": "scatter GPU/rendering coverage is inherited from builtins::plotting::scatter and runmat-plot renderer tests"
+    },
+    "description": "`scatterplot` visualizes complex-baseband samples by plotting `real(x)` on the x-axis and `imag(x)` on the y-axis. It mirrors the MATLAB Communications Toolbox call forms for decimation, offset, marker styling, and target axes while using RunMat's shared `scatter` renderer and graphics-handle model.",
+    "behaviors": [
+        "`scatterplot(x)` plots every complex sample using a constellation-friendly default marker.",
+        "`scatterplot(x, n)` plots every `n`-th sample.",
+        "`scatterplot(x, n, offset)` starts at the zero-based offset before applying decimation, matching MATLAB's `x(offset+1:n:end)` behavior.",
+        "`scatterplot(x, n, offset, marker)` forwards the marker LineSpec to `scatter`.",
+        "`scatterplot(x, n, offset, marker, ax)` targets an existing axes handle.",
+        "The generated plot uses equal x/y scaling and grid lines so constellation geometry is not visually distorted."
+    ],
+    "examples": [
+        {
+            "description": "Plot a simple QPSK constellation",
+            "input": "x = [1+1i; -1+1i; -1-1i; 1-1i];\nscatterplot(x);"
+        },
+        {
+            "description": "Plot every fourth received sample with a custom marker",
+            "input": "rx = randn(1000, 1) + 1i*randn(1000, 1);\nscatterplot(rx, 4, 0, 'gx');"
+        },
+        {
+            "description": "Target a subplot axes",
+            "input": "ax = subplot(1, 2, 1);\nx = [1+1i; 1-1i; -1+1i; -1-1i];\nscatterplot(x, 1, 0, 'b.', ax);"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "How is scatterplot different from scatter?",
+            "answer": "`scatterplot` is specialized for complex symbols. It derives x/y coordinates from the real and imaginary parts of one input vector, applies Communications Toolbox decimation/offset arguments, and configures the axes for constellation viewing. `scatter` expects explicit x and y coordinate arrays."
+        },
+        {
+            "question": "Does scatterplot support gpuArray inputs?",
+            "answer": "Yes. For the no-decimation case, RunMat asks the acceleration provider for real and imaginary GPU buffers and forwards them to the GPU scatter renderer. When decimation is requested or the provider cannot expose those buffers, RunMat gathers the samples once and renders the same visible plot."
+        }
+    ],
+    "links": [
+        {
+            "label": "scatter",
+            "url": "./scatter"
+        },
+        {
+            "label": "plot",
+            "url": "./plot"
+        },
+        {
+            "label": "real",
+            "url": "./real"
+        },
+        {
+            "label": "imag",
+            "url": "./imag"
+        },
+        {
+            "label": "Styling plots and axes",
+            "url": "/docs/plotting/styling-plots-and-axes"
+        },
+        {
+            "label": "GPU plotting and residency",
+            "url": "/docs/plotting/gpu-plotting-and-residency"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/scatterplot.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/scatterplot.rs"
+    },
+    "gpu_residency": "`scatterplot` preserves GPU residency for the common `scatterplot(x)` path when the active provider can materialize real and imaginary buffers on device. Decimation and provider gaps fall back to one host gather, after which the same `scatter` handle and axes behavior apply.",
+    "gpu_behavior": [
+        "The direct path reuses the existing 2-D scatter WGPU renderer and avoids an extra host round-trip for supported GPU inputs.",
+        "Decimated sample selection is currently performed on the host to preserve MATLAB-compatible offset semantics.",
+        "Marker styling, axes targeting, grid, and equal-axis behavior are consistent between GPU and host fallback rendering."
+    ],
+    "key": "scatterplot",
+    "slug": "scatterplot",
+    "aliases": [],
+    "categoryPath": [
+        "communications",
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=scatterplot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scatterplot.js","sourceRoot":"","sources":["../../../src/generated/builtins/scatterplot.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,yBAAyB;IACrC,UAAU,EAAE;QACV,aAAa;QACb,uBAAuB;QACvB,wBAAwB;QACxB,kBAAkB;QAClB,KAAK;QACL,KAAK;QACL,SAAS;KACV;IACD,SAAS,EAAE,+DAA+D;IAC1E,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,QAAQ;YACR,QAAQ;SACT;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,8RAA8R;KACxS;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,wCAAwC;QAChD,aAAa,EAAE,6GAA6G;KAC7H;IACD,aAAa,EAAE,8SAA8S;IAC7T,WAAW,EAAE;QACX,4FAA4F;QAC5F,gDAAgD;QAChD,yIAAyI;QACzI,gFAAgF;QAChF,0EAA0E;QAC1E,+GAA+G;KAChH;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,kDAAkD;SAC5D;QACD;YACE,aAAa,EAAE,wDAAwD;YACvE,OAAO,EAAE,wEAAwE;SAClF;QACD;YACE,aAAa,EAAE,uBAAuB;YACtC,OAAO,EAAE,0FAA0F;SACpG;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,0SAA0S;SACrT;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,uSAAuS;SAClT;KACF;IACD,OAAO,EAAE;QACP;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,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,uCAAuC;SAC/C;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,2CAA2C;SACnD;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,kEAAkE;QAC3E,KAAK,EAAE,+GAA+G;KACvH;IACD,eAAe,EAAE,qRAAqR;IACtS,cAAc,EAAE;QACd,6HAA6H;QAC7H,+GAA+G;QAC/G,uHAAuH;KACxH;IACD,KAAK,EAAE,aAAa;IACpB,MAAM,EAAE,aAAa;IACrB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,gBAAgB;QAChB,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,EAi0QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAsa9D,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,EAu1QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAua9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -6598,6 +6598,28 @@ export const builtinManifest = [
         "summary": "Create 3-D scatter plots for spatial point clouds, encoded markers, and MATLAB `scatter3` workflows.",
         "exampleCount": 4
     },
+    {
+        "key": "scatterplot",
+        "title": "scatterplot",
+        "slug": "scatterplot",
+        "aliases": [],
+        "category": "communications/plotting",
+        "categoryPath": [
+            "communications",
+            "plotting"
+        ],
+        "keywords": [
+            "scatterplot",
+            "constellation diagram",
+            "communications toolbox",
+            "complex baseband",
+            "qam",
+            "psk",
+            "scatter"
+        ],
+        "summary": "Plot complex-baseband samples as a 2-D constellation diagram.",
+        "exampleCount": 3
+    },
     {
         "key": "second",
         "title": "second",
@@ -8840,6 +8862,7 @@ export const builtinDocLoaders = {
     "sawtooth": () => import("./builtins/sawtooth.js").then((mod) => mod.default),
     "scatter": () => import("./builtins/scatter.js").then((mod) => mod.default),
     "scatter3": () => import("./builtins/scatter3.js").then((mod) => mod.default),
+    "scatterplot": () => import("./builtins/scatterplot.js").then((mod) => mod.default),
     "second": () => import("./builtins/second.js").then((mod) => mod.default),
     "semilogx": () => import("./builtins/semilogx.js").then((mod) => mod.default),
     "semilogy": () => import("./builtins/semilogy.js").then((mod) => mod.default),