runmat 0.4.6-dev.2 → 0.4.6-dev.3

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

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

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

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

package/dist/generated/builtins/clearvars.js

@@ -0,0 +1,119 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "clearvars",
+    "category": "introspection",
+    "keywords": [
+        "clearvars",
+        "clear variables",
+        "workspace",
+        "variables",
+        "-except"
+    ],
+    "summary": "Clear variables from the active workspace, with optional exclusions.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/clearvars.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs on the host CPU because it mutates the session workspace rather than array contents."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 16,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": null,
+        "integration": "command_controls::clearvars_command_clears_workspace_state"
+    },
+    "description": "`clearvars` removes variables from the active RunMat workspace. RunMat supports MATLAB-style command forms such as `clearvars x y`, whole-workspace exclusion forms such as `clearvars -except keep`, and selected-variable exclusion forms such as `clearvars a b -except b`, updating the session snapshot so hosts can drop cleared bindings.",
+    "behaviors": [
+        "`clearvars` with no inputs clears all workspace variables created in the current session.",
+        "`clearvars x` removes the variable `x` while leaving other workspace bindings intact.",
+        "Multiple names can be supplied as separate inputs or command-form tokens, for example `clearvars x y z`.",
+        "`clearvars -except x y` removes all active workspace variables except `x` and `y`.",
+        "`clearvars a b c -except b` removes only selected variables `a` and `c`, preserves selected exclusion `b`, and leaves variables outside the selected clear set untouched.",
+        "Function-call forms accept variable names as string scalars, row character vectors, or string arrays.",
+        "Clearing a name that does not exist is a no-op.",
+        "`clearvars` is a sink builtin and does not produce a meaningful output value."
+    ],
+    "examples": [
+        {
+            "description": "Clear the entire interactive workspace",
+            "input": "x = 1;\ny = magic(3);\nclearvars",
+            "output": "% x and y are removed from the workspace"
+        },
+        {
+            "description": "Clear selected variables",
+            "input": "a = 1;\nb = 2;\nc = 3;\nclearvars a b",
+            "output": "% a and b are removed; c remains defined"
+        },
+        {
+            "description": "Keep selected variables while clearing the rest",
+            "input": "raw = 1;\nanswer = 42;\ntmp = 3;\nclearvars -except answer",
+            "output": "% answer remains defined; raw and tmp are removed"
+        },
+        {
+            "description": "Clear selected variables while preserving exclusions",
+            "input": "a = 1;\nb = 2;\nc = 3;\nuntouched = 4;\nclearvars a b c -except b",
+            "output": "% a and c are removed; b and untouched remain defined"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "How is `clearvars` different from `clear`?",
+            "answer": "`clearvars` focuses on workspace variables and supports the `-except` option for preserving named bindings while clearing the rest."
+        },
+        {
+            "question": "Can I clear only one variable?",
+            "answer": "Yes. Use `clearvars x` or `clearvars(\"x\")` to remove one variable, and pass multiple names to clear more than one binding in a single call."
+        },
+        {
+            "question": "Does `clearvars -except x` clear figures or the console?",
+            "answer": "No. It only mutates workspace variables. Use `close all` for figures and `clc` for the visible console."
+        },
+        {
+            "question": "Does GPU residency matter?",
+            "answer": "No. `clearvars` operates on session bookkeeping, not on array kernels or provider-managed computations."
+        }
+    ],
+    "links": [
+        {
+            "label": "clear",
+            "url": "./clear"
+        },
+        {
+            "label": "who",
+            "url": "./who"
+        },
+        {
+            "label": "whos",
+            "url": "./whos"
+        },
+        {
+            "label": "clc",
+            "url": "./clc"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/introspection/clearvars.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/introspection/clearvars.rs"
+    },
+    "gpu_behavior": [
+        "`clearvars` performs host-side workspace mutation only. It does not launch GPU kernels, does not participate in fusion, and does not depend on acceleration providers."
+    ],
+    "key": "clearvars",
+    "slug": "clearvars",
+    "aliases": [],
+    "categoryPath": [
+        "introspection"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=clearvars.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clearvars.js","sourceRoot":"","sources":["../../../src/generated/builtins/clearvars.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,WAAW;QACX,iBAAiB;QACjB,WAAW;QACX,WAAW;QACX,SAAS;KACV;IACD,SAAS,EAAE,sEAAsE;IACjF,YAAY,EAAE;QACZ,0DAA0D;KAC3D;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,2FAA2F;KACrG;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,IAAI;QACZ,aAAa,EAAE,4DAA4D;KAC5E;IACD,aAAa,EAAE,kVAAkV;IACjW,WAAW,EAAE;QACX,2FAA2F;QAC3F,uFAAuF;QACvF,0GAA0G;QAC1G,oFAAoF;QACpF,2KAA2K;QAC3K,uGAAuG;QACvG,iDAAiD;QACjD,+EAA+E;KAChF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,kCAAkC;YAC3C,QAAQ,EAAE,0CAA0C;SACrD;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,uCAAuC;YAChD,QAAQ,EAAE,0CAA0C;SACrD;QACD;YACE,aAAa,EAAE,iDAAiD;YAChE,OAAO,EAAE,4DAA4D;YACrE,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,aAAa,EAAE,sDAAsD;YACrE,OAAO,EAAE,mEAAmE;YAC5E,QAAQ,EAAE,uDAAuD;SAClE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,qIAAqI;SAChJ;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,+IAA+I;SAC1J;QACD;YACE,UAAU,EAAE,0DAA0D;YACtE,QAAQ,EAAE,yGAAyG;SACpH;QACD;YACE,UAAU,EAAE,4BAA4B;YACxC,QAAQ,EAAE,yGAAyG;SACpH;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,iEAAiE;QAC1E,KAAK,EAAE,8GAA8G;KACtH;IACD,cAAc,EAAE;QACd,wKAAwK;KACzK;IACD,KAAK,EAAE,WAAW;IAClB,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/heatmap.js

@@ -0,0 +1,87 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "heatmap",
+    "category": "plotting",
+    "keywords": [
+        "heatmap",
+        "HeatmapChart",
+        "matrix visualization",
+        "colormap",
+        "plotting"
+    ],
+    "summary": "Create heatmap charts from matrix data with optional row and column labels.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "single",
+            "double"
+        ],
+        "broadcasting": "none",
+        "notes": "`heatmap` is a plotting sink. Inputs are gathered to build labeled chart state, then rendered through the scaled-image surface path."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::heatmap::tests"
+    },
+    "description": "`heatmap` creates a heatmap-style chart from numeric matrix data. RunMat supports `heatmap(CData)` and `heatmap(XValues, YValues, CData)`, returns a heatmap graphics handle, and supports common chart properties such as `Title`, `XLabel`, `YLabel`, `ColorbarVisible`, and `Colormap` through `get`, `set`, and dot-property assignment.",
+    "behaviors": [
+        "`heatmap(CData)` displays matrix values using default row and column labels.",
+        "`heatmap(XValues, YValues, CData)` uses text, string-array, cell-array, or numeric labels for the displayed columns and rows.",
+        "The returned heatmap handle participates in RunMat's plotting property system.",
+        "Color rendering uses the shared scaled-image and colormap path."
+    ],
+    "examples": [
+        {
+            "description": "Create a labeled heatmap chart",
+            "input": "cdata = [45 60 32; 43 54 76; 32 94 68; 23 95 58];\nxvalues = {'Small','Medium','Large'};\nyvalues = {'Green','Red','Blue','Gray'};\nh = heatmap(xvalues,yvalues,cdata);\nh.Title = 'T-Shirt Orders';\nh.XLabel = 'Sizes';\nh.YLabel = 'Colors';"
+        },
+        {
+            "description": "Create a heatmap from matrix data",
+            "input": "A = magic(5);\nh = heatmap(A);\nh.Colormap = 'hot';\nh.ColorbarVisible = true;"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does heatmap support table inputs?",
+            "answer": "Not yet. RunMat currently supports matrix CData inputs with optional row and column labels. Table-based MATLAB signatures will be added once table values are represented in the runtime."
+        }
+    ],
+    "links": [
+        {
+            "label": "imagesc",
+            "url": "./imagesc"
+        },
+        {
+            "label": "colormap",
+            "url": "./colormap"
+        },
+        {
+            "label": "colorbar",
+            "url": "./colorbar"
+        },
+        {
+            "label": "Styling plots and axes",
+            "url": "/docs/plotting/styling-plots-and-axes"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/heatmap.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/heatmap.rs"
+    },
+    "key": "heatmap",
+    "slug": "heatmap",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=heatmap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"heatmap.js","sourceRoot":"","sources":["../../../src/generated/builtins/heatmap.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,SAAS;QACT,cAAc;QACd,sBAAsB;QACtB,UAAU;QACV,UAAU;KACX;IACD,SAAS,EAAE,6EAA6E;IACxF,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,sIAAsI;KAChJ;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,oCAAoC;KAC7C;IACD,aAAa,EAAE,8UAA8U;IAC7V,WAAW,EAAE;QACX,8EAA8E;QAC9E,+HAA+H;QAC/H,gFAAgF;QAChF,iEAAiE;KAClE;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,iPAAiP;SAC3P;QACD;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,gFAAgF;SAC1F;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,2LAA2L;SACtM;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,uCAAuC;SAC/C;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,KAAK,EAAE,2GAA2G;KACnH;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,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,EA4vPjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAyY9D,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,EAkyPjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA2Y9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -743,6 +743,25 @@ export const builtinManifest = [
         "summary": "Clear variables from the active workspace.",
         "exampleCount": 5
     },
+    {
+        "key": "clearvars",
+        "title": "clearvars",
+        "slug": "clearvars",
+        "aliases": [],
+        "category": "introspection",
+        "categoryPath": [
+            "introspection"
+        ],
+        "keywords": [
+            "clearvars",
+            "clear variables",
+            "workspace",
+            "variables",
+            "-except"
+        ],
+        "summary": "Clear variables from the active workspace, with optional exclusions.",
+        "exampleCount": 4
+    },
     {
         "key": "clf",
         "title": "clf",
@@ -2858,6 +2877,25 @@ export const builtinManifest = [
         "summary": "Generate a Hann window as an N-by-1 real column vector.",
         "exampleCount": 3
     },
+    {
+        "key": "heatmap",
+        "title": "heatmap",
+        "slug": "heatmap",
+        "aliases": [],
+        "category": "plotting",
+        "categoryPath": [
+            "plotting"
+        ],
+        "keywords": [
+            "heatmap",
+            "HeatmapChart",
+            "matrix visualization",
+            "colormap",
+            "plotting"
+        ],
+        "summary": "Create heatmap charts from matrix data with optional row and column labels.",
+        "exampleCount": 2
+    },
     {
         "key": "hist",
         "title": "hist",
@@ -7971,6 +8009,7 @@ export const builtinDocLoaders = {
     "class": () => import("./builtins/class.js").then((mod) => mod.default),
     "clc": () => import("./builtins/clc.js").then((mod) => mod.default),
     "clear": () => import("./builtins/clear.js").then((mod) => mod.default),
+    "clearvars": () => import("./builtins/clearvars.js").then((mod) => mod.default),
     "clf": () => import("./builtins/clf.js").then((mod) => mod.default),
     "close": () => import("./builtins/close.js").then((mod) => mod.default),
     "colon": () => import("./builtins/colon.js").then((mod) => mod.default),
@@ -8075,6 +8114,7 @@ export const builtinDocLoaders = {
     "gt": () => import("./builtins/gt.js").then((mod) => mod.default),
     "hamming": () => import("./builtins/hamming.js").then((mod) => mod.default),
     "hann": () => import("./builtins/hann.js").then((mod) => mod.default),
+    "heatmap": () => import("./builtins/heatmap.js").then((mod) => mod.default),
     "hist": () => import("./builtins/hist.js").then((mod) => mod.default),
     "histcounts": () => import("./builtins/histcounts.js").then((mod) => mod.default),
     "histcounts2": () => import("./builtins/histcounts2.js").then((mod) => mod.default),