runmat 0.4.10-dev.1 → 0.4.10-dev.3

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

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

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

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

package/dist/generated/builtins/contour3.js

@@ -0,0 +1,109 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "contour3",
+    "category": "plotting",
+    "keywords": [
+        "contour3",
+        "3d contour",
+        "contour lines",
+        "iso-lines",
+        "level sets",
+        "matlab contour3"
+    ],
+    "summary": "Create 3-D contour line plots where each contour is drawn at its scalar level height.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "single",
+            "double"
+        ],
+        "broadcasting": "none",
+        "notes": "`contour3` uses the shared contour-generation path and can keep GPU-resident Z inputs on device through the WGPU plotting pipeline."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 4,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::contour3::tests"
+    },
+    "description": "`contour3` creates 3-D contour line plots from scalar fields. It accepts the same core inputs as `contour`, but writes each isoline at the corresponding Z level instead of projecting every line onto a flat plane.",
+    "behaviors": [
+        "`contour3(Z)` uses implicit X and Y axes derived from the Z matrix shape.",
+        "`contour3(X, Y, Z)` accepts explicit vector axes or meshgrid-style X and Y matrices.",
+        "A scalar fourth argument selects the number of contour levels; a vector fourth argument selects exact contour levels.",
+        "LineSpec color tokens such as `'k'` and name-value pairs such as `'LineWidth'` are accepted.",
+        "GPU-aware contour generation is used when the shared plotting path can operate directly on GPU-resident scalar fields."
+    ],
+    "options": [
+        "`'LevelList'` / `'Levels'` accepts an explicit, strictly increasing vector of contour values.",
+        "`'LevelStep'` specifies the spacing between generated contour levels.",
+        "`'LineColor'` accepts MATLAB color strings, RGB triples, `'auto'`, and `'none'`.",
+        "`'LineWidth'` controls contour line thickness."
+    ],
+    "examples": [
+        {
+            "description": "Create a basic 3-D contour plot",
+            "input": "[X, Y] = meshgrid(-2:0.25:2, -2:0.25:2);\nZ = X .* exp(-X.^2 - Y.^2);\ncontour3(X, Y, Z);"
+        },
+        {
+            "description": "Use explicit contour levels with high-contrast lines",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 80), linspace(-3, 3, 80));\nZ = sin(X) .* cos(Y);\ncontour3(X, Y, Z, [-0.75 -0.25 0.25 0.75], 'Color', [0.05 0.35 0.95], 'LineWidth', 2.25);\nzlabel('Potential');\nview(45, 30);"
+        },
+        {
+            "description": "Inspect the returned contour handle",
+            "input": "Z = peaks(40);\nh = contour3(Z, 12, 'Color', [0.9 0.2 0.05], 'LineWidth', 2.0);\nget(h, 'Type')",
+            "output": "ans =\n    'contour'"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "How is contour3 different from contour?",
+            "answer": "`contour` draws contour lines on a single flat plane. `contour3` places each contour line at its own scalar level on the Z axis, which makes level height visible in the 3-D camera."
+        },
+        {
+            "question": "Can contour3 be combined with surface plots?",
+            "answer": "Yes. Use `hold on` to overlay `contour3` with `surf`, `mesh`, `plot3`, or `scatter3`. Because `contour3` is camera-aware, it shares the same 3-D axes state as other 3-D plot types."
+        }
+    ],
+    "links": [
+        {
+            "label": "contour",
+            "url": "./contour"
+        },
+        {
+            "label": "contourf",
+            "url": "./contourf"
+        },
+        {
+            "label": "plot3",
+            "url": "./plot3"
+        },
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "Plot replay and export",
+            "url": "/docs/plotting/plot-replay-and-export"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/contour3.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/contour3.rs"
+    },
+    "gpu_residency": "`contour3` preserves GPU residency when the shared WGPU plotting context can consume the Z buffer directly. If that path is unavailable, RunMat gathers once and builds the same contour geometry on the CPU.",
+    "key": "contour3",
+    "slug": "contour3",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=contour3.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contour3.js","sourceRoot":"","sources":["../../../src/generated/builtins/contour3.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,YAAY;QACZ,eAAe;QACf,WAAW;QACX,YAAY;QACZ,iBAAiB;KAClB;IACD,SAAS,EAAE,uFAAuF;IAClG,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,qIAAqI;KAC/I;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;KAC9C;IACD,aAAa,EAAE,sNAAsN;IACrO,WAAW,EAAE;QACX,2EAA2E;QAC3E,sFAAsF;QACtF,uHAAuH;QACvH,8FAA8F;QAC9F,wHAAwH;KACzH;IACD,SAAS,EAAE;QACT,+FAA+F;QAC/F,uEAAuE;QACvE,kFAAkF;QAClF,gDAAgD;KACjD;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,2FAA2F;SACrG;QACD;YACE,aAAa,EAAE,sDAAsD;YACrE,OAAO,EAAE,qNAAqN;SAC/N;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,iGAAiG;YAC1G,QAAQ,EAAE,sBAAsB;SACjC;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,yCAAyC;YACrD,QAAQ,EAAE,sLAAsL;SACjM;QACD;YACE,UAAU,EAAE,8CAA8C;YAC1D,QAAQ,EAAE,sLAAsL;SACjM;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,uCAAuC;SAC/C;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,+DAA+D;QACxE,KAAK,EAAE,4GAA4G;KACpH;IACD,eAAe,EAAE,+MAA+M;IAChO,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/qammod.js

@@ -0,0 +1,108 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "qammod",
+    "category": "comms/modulation",
+    "keywords": [
+        "qammod",
+        "qam",
+        "modulation",
+        "communications",
+        "gray",
+        "binary",
+        "constellation",
+        "gpu"
+    ],
+    "summary": "Map integer symbols onto a rectangular QAM complex-baseband constellation.",
+    "references": [
+        "https://www.mathworks.com/help/comm/ref/qammod.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64",
+            "i32",
+            "bool"
+        ],
+        "broadcasting": "none",
+        "notes": "gpuArray inputs are gathered through the active provider and modulated on the host because RunMat does not yet represent complex-valued GPU tensor handles. The result is a host ComplexTensor."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::comms::qammod::tests"
+    },
+    "description": "`qammod(X, M)` maps integer symbols in `X` to complex QAM constellation points for power-of-two modulation order `M`. The default symbol order is Gray-coded. `qammod(X, M, 'bin')` uses binary column-wise ordering, and a custom mapping vector assigns symbols to constellation points from the upper-left point downward by column and then left to right.",
+    "behaviors": [
+        "`X` must contain finite integer values in the inclusive range `[0, M-1]`.",
+        "`M` must be a power-of-two integer greater than one.",
+        "Square QAM orders such as 4, 16, 64, and 256 use symmetric odd integer amplitudes with minimum distance two.",
+        "Non-square power-of-two orders use a rectangular grid with the larger dimension on the in-phase axis.",
+        "The default `'gray'` order applies Gray coding independently to the in-phase and quadrature grid indexes.",
+        "`'UnitAveragePower', true` scales the complete constellation so its average power is one.",
+        "`'OutputDataType', 'single'` rounds the real and imaginary samples through single precision before returning the host complex tensor.",
+        "`'PlotConstellation', true` and `InputType='bit'` are not implemented yet."
+    ],
+    "examples": [
+        {
+            "description": "Default 16-QAM Gray mapping",
+            "input": "y = qammod(0:15, 16)",
+            "output": "y = [-3+3i -3+1i -3-3i -3-1i -1+3i -1+1i -1-3i -1-1i 3+3i 3+1i 3-3i 3-1i 1+3i 1+1i 1-3i 1-1i]"
+        },
+        {
+            "description": "Binary symbol ordering",
+            "input": "y = qammod(0:4, 16, 'bin')",
+            "output": "y = [-3+3i -3+1i -3-1i -3-3i -1+3i]"
+        },
+        {
+            "description": "Unit-average-power 16-QAM",
+            "input": "y = qammod(0:15, 16, 'UnitAveragePower', true);\nmean(abs(y).^2)",
+            "output": "ans = 1"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does qammod execute on the GPU?",
+            "answer": "It accepts gpuArray inputs, but the current runtime gathers them to host memory and returns a host ComplexTensor because complex GPU tensor handles are not yet part of RunMat's value model."
+        },
+        {
+            "question": "Is bit input supported?",
+            "answer": "Not in this first implementation. Use integer symbols or convert bit groups to integer symbols before calling qammod."
+        }
+    ],
+    "links": [
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/comms/qammod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/comms/qammod.rs"
+    },
+    "gpu_residency": "The builtin declares `GatherImmediately` residency. A gpuArray input is downloaded once through the dispatcher and then mapped to complex host output.",
+    "gpu_behavior": [
+        "RunMat's current accelerator API stores real-valued GPU buffers. Since `qammod` necessarily produces complex-valued samples, the GPU-aware implementation preserves correctness by gathering device input and producing a `ComplexTensor` on the host.",
+        "The registered GPU metadata advertises the supported input scalar classes and the provider hook name future accelerators can use once complex GPU outputs are represented."
+    ],
+    "key": "qammod",
+    "slug": "qammod",
+    "aliases": [],
+    "categoryPath": [
+        "comms",
+        "modulation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=qammod.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"qammod.js","sourceRoot":"","sources":["../../../src/generated/builtins/qammod.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,kBAAkB;IAC9B,UAAU,EAAE;QACV,QAAQ;QACR,KAAK;QACL,YAAY;QACZ,gBAAgB;QAChB,MAAM;QACN,QAAQ;QACR,eAAe;QACf,KAAK;KACN;IACD,SAAS,EAAE,4EAA4E;IACvF,YAAY,EAAE;QACZ,qDAAqD;KACtD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;YACL,KAAK;YACL,MAAM;SACP;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iMAAiM;KAC3M;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,gCAAgC;KACzC;IACD,aAAa,EAAE,gWAAgW;IAC/W,WAAW,EAAE;QACX,2EAA2E;QAC3E,sDAAsD;QACtD,8GAA8G;QAC9G,uGAAuG;QACvG,2GAA2G;QAC3G,2FAA2F;QAC3F,uIAAuI;QACvI,4EAA4E;KAC7E;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,6BAA6B;YAC5C,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,+FAA+F;SAC1G;QACD;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,4BAA4B;YACrC,QAAQ,EAAE,qCAAqC;SAChD;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,kEAAkE;YAC3E,QAAQ,EAAE,SAAS;SACpB;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,+LAA+L;SAC1M;QACD;YACE,UAAU,EAAE,yBAAyB;YACrC,QAAQ,EAAE,uHAAuH;SAClI;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,sDAAsD;QAC/D,KAAK,EAAE,mGAAmG;KAC3G;IACD,eAAe,EAAE,wJAAwJ;IACzK,cAAc,EAAE;QACd,wPAAwP;QACxP,4KAA4K;KAC7K;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,YAAY;KACb;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,EAmwQjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAma9D,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,EA8yQjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAqa9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -1000,6 +1000,26 @@ export const builtinManifest = [
         "summary": "Create contour line plots for level sets, iso-lines, and MATLAB `contour` workflows.",
         "exampleCount": 4
     },
+    {
+        "key": "contour3",
+        "title": "contour3",
+        "slug": "contour3",
+        "aliases": [],
+        "category": "plotting",
+        "categoryPath": [
+            "plotting"
+        ],
+        "keywords": [
+            "contour3",
+            "3d contour",
+            "contour lines",
+            "iso-lines",
+            "level sets",
+            "matlab contour3"
+        ],
+        "summary": "Create 3-D contour line plots where each contour is drawn at its scalar level height.",
+        "exampleCount": 3
+    },
     {
         "key": "contourf",
         "title": "contourf",
@@ -5739,6 +5759,29 @@ export const builtinManifest = [
         "summary": "Return the absolute path to the folder where RunMat is currently executing.",
         "exampleCount": 6
     },
+    {
+        "key": "qammod",
+        "title": "qammod",
+        "slug": "qammod",
+        "aliases": [],
+        "category": "comms/modulation",
+        "categoryPath": [
+            "comms",
+            "modulation"
+        ],
+        "keywords": [
+            "qammod",
+            "qam",
+            "modulation",
+            "communications",
+            "gray",
+            "binary",
+            "constellation",
+            "gpu"
+        ],
+        "summary": "Map integer symbols onto a rectangular QAM complex-baseband constellation.",
+        "exampleCount": 3
+    },
     {
         "key": "qr",
         "title": "qr",
@@ -8503,6 +8546,7 @@ export const builtinDocLoaders = {
     "containers.map": () => import("./builtins/containers.Map.js").then((mod) => mod.default),
     "contains": () => import("./builtins/contains.js").then((mod) => mod.default),
     "contour": () => import("./builtins/contour.js").then((mod) => mod.default),
+    "contour3": () => import("./builtins/contour3.js").then((mod) => mod.default),
     "contourf": () => import("./builtins/contourf.js").then((mod) => mod.default),
     "conv": () => import("./builtins/conv.js").then((mod) => mod.default),
     "conv2": () => import("./builtins/conv2.js").then((mod) => mod.default),
@@ -8736,6 +8780,7 @@ export const builtinDocLoaders = {
     "ppval": () => import("./builtins/ppval.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),
     "qr": () => import("./builtins/qr.js").then((mod) => mod.default),
     "quiver": () => import("./builtins/quiver.js").then((mod) => mod.default),
     "rad2deg": () => import("./builtins/rad2deg.js").then((mod) => mod.default),