runmat 0.3.6 → 0.4.0

package/dist/generated/builtins/webwrite.js

@@ -0,0 +1,155 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "webwrite",
+    "category": "io/http",
+    "keywords": [
+        "webwrite",
+        "http post",
+        "rest client",
+        "json upload",
+        "form post",
+        "binary upload"
+    ],
+    "summary": "Send data to web services using HTTP POST/PUT requests and return the response.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/webwrite.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "webwrite gathers gpuArray inputs and executes entirely on the CPU networking stack."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::http::webwrite::tests",
+        "integration": [
+            "builtins::io::http::webwrite::tests::webwrite_posts_form_data_by_default",
+            "builtins::io::http::webwrite::tests::webwrite_sends_json_when_media_type_json",
+            "builtins::io::http::webwrite::tests::webwrite_applies_basic_auth_and_custom_headers",
+            "builtins::io::http::webwrite::tests::webwrite_supports_query_parameters",
+            "builtins::io::http::webwrite::tests::webwrite_binary_payload_respected"
+        ]
+    },
+    "description": "`webwrite` sends data to an HTTP or HTTPS endpoint using methods such as `POST`, `PUT`, `PATCH`, or `DELETE`. It mirrors MATLAB behaviour: request bodies are created from MATLAB values (structs, cells, strings, numeric tensors), request headers come from `weboptions` style arguments, and the response is decoded the same way as `webread`.",
+    "behaviors": [
+        "The first input is an absolute URL supplied as a character vector or string scalar.",
+        "The second input supplies the request body. Structs and two-column cell arrays become `application/x-www-form-urlencoded` payloads. Character vectors / strings are sent as UTF-8 text, and other MATLAB values default to JSON encoding via `jsonencode`.",
+        "Name-value arguments (or an options struct) accept the same fields as MATLAB `weboptions`: `ContentType`, `MediaType`, `Timeout`, `HeaderFields`, `Username`, `Password`, `UserAgent`, `RequestMethod`, and `QueryParameters`.",
+        "`ContentType` controls how the response is parsed (`\"auto\"` by default). Set it to `\"json\"`, `\"text\"`, or `\"binary\"` to force JSON decoding, text return, or raw byte vectors.",
+        "`MediaType` sets the outbound `Content-Type` header. When omitted, RunMat chooses a sensible default (`application/x-www-form-urlencoded`, `application/json`, `text/plain; charset=utf-8`, or `application/octet-stream`) based on the payload.",
+        "Query parameters can be appended through the `QueryParameters` option or by including additional, unrecognised name-value pairs. Parameter values follow MATLAB scalar rules.",
+        "HTTP errors, timeouts, TLS verification problems, and JSON encoding issues raise MATLAB-style errors with descriptive text."
+    ],
+    "examples": [
+        {
+            "description": "Posting form fields to a REST endpoint",
+            "input": "payload = struct(\"name\", \"Ada\", \"score\", 42);\nopts = struct(\"ContentType\", \"json\");          % expect JSON response\nreply = webwrite(\"https://api.example.com/submit\", payload, opts);\ndisp(reply.status)",
+            "output": "    \"ok\""
+        },
+        {
+            "description": "Sending JSON payloads",
+            "input": "body = struct(\"title\", \"RunMat\", \"stars\", 5);\nopts = struct(\"MediaType\", \"application/json\", \"ContentType\", \"json\");\nresp = webwrite(\"https://api.example.com/projects\", body, opts)"
+        },
+        {
+            "description": "Uploading plain text",
+            "input": "message = \"Hello from RunMat!\";\nreply = webwrite(\"https://api.example.com/echo\", message, ...\n                 \"MediaType\", \"text/plain\", \"ContentType\", \"text\")"
+        },
+        {
+            "description": "Uploading raw binary data",
+            "input": "bytes = uint8([1 2 3 4 5]);\nwebwrite(\"https://api.example.com/upload\", bytes, ...\n         \"ContentType\", \"binary\", \"MediaType\", \"application/octet-stream\")"
+        },
+        {
+            "description": "Supplying credentials, custom headers, and query parameters",
+            "input": "headers = struct(\"X-Client\", \"RunMat\", \"Accept\", \"application/json\");\nopts = struct(\"Username\", \"ada\", \"Password\", \"lovelace\", ...\n              \"HeaderFields\", headers, ...\n              \"QueryParameters\", struct(\"verbose\", true));\nprofile = webwrite(\"https://api.example.com/me\", struct(), opts)"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Which HTTP methods are supported?",
+            "answer": "`webwrite` defaults to `POST`. Supply `\"RequestMethod\",\"put\"` (or `\"patch\"`, `\"delete\"`) to use other verbs."
+        },
+        {
+            "question": "How do I send JSON?",
+            "answer": "Set `\"MediaType\",\"application/json\"` (optionally via a struct) or `\"ContentType\",\"json\"`. RunMat serialises the payload with `jsonencode` and sets the appropriate `Content-Type`."
+        },
+        {
+            "question": "How are form posts encoded?",
+            "answer": "Struct inputs and two-column cell arrays are turned into `application/x-www-form-urlencoded` bodies. Field values must be scalar text or numbers."
+        },
+        {
+            "question": "Can I post binary data?",
+            "answer": "Yes. Provide numeric tensors (`double`, integer, or logical) and set `\"ContentType\",\"binary\"` or `\"MediaType\",\"application/octet-stream\"`. Values must be in the 0–255 range."
+        },
+        {
+            "question": "What controls the response decoding?",
+            "answer": "`ContentType` mirrors `webread`: `\"auto\"` inspects response headers, while `\"json\"`, `\"text\"`, and `\"binary\"` force the output format."
+        },
+        {
+            "question": "How do I add custom headers?",
+            "answer": "Use `\"HeaderFields\", struct(\"Header-Name\",\"value\",...)` or a two-column cell array. Header names must be valid HTTP tokens."
+        },
+        {
+            "question": "Does `webwrite` follow redirects?",
+            "answer": "Yes. The underlying `reqwest` client follows redirects with the same credentials and headers."
+        },
+        {
+            "question": "Can I send query parameters and a body simultaneously?",
+            "answer": "Yes. Provide a `QueryParameters` struct/cell in the options. Parameters are percent-encoded and appended to the URL before the request is issued."
+        },
+        {
+            "question": "How do timeouts work?",
+            "answer": "`Timeout` accepts a scalar number of seconds. The default is 60 s. Requests exceeding the limit raise `webwrite: request to <url> timed out`."
+        },
+        {
+            "question": "What happens with GPU inputs?",
+            "answer": "They are gathered before serialisation. The function is marked as a sink to break fusion graphs and ensure residency is released."
+        }
+    ],
+    "links": [
+        {
+            "label": "webread",
+            "url": "./webread"
+        },
+        {
+            "label": "jsonencode",
+            "url": "./jsonencode"
+        },
+        {
+            "label": "jsondecode",
+            "url": "./jsondecode"
+        },
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "weboptions",
+            "url": "./weboptions"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/http/webwrite.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/http/webwrite.rs"
+    },
+    "gpu_residency": "No. `webwrite` executes on the CPU. Any GPU values are automatically gathered before serialising the payload, and results are created on the host. Manually gathering is unnecessary.",
+    "gpu_behavior": [
+        "`webwrite` is a sink in the execution graph. Any GPU-resident inputs (for example tensors inside structs or cell arrays) are gathered to host memory before encoding the request body. Network I/O always runs on the CPU; fusion plans are terminated with `ResidencyPolicy::GatherImmediately`."
+    ],
+    "key": "webwrite",
+    "slug": "webwrite",
+    "categoryPath": [
+        "io",
+        "http"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=webwrite.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webwrite.js","sourceRoot":"","sources":["../../../src/generated/builtins/webwrite.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE;QACV,UAAU;QACV,WAAW;QACX,aAAa;QACb,aAAa;QACb,WAAW;QACX,eAAe;KAChB;IACD,SAAS,EAAE,iFAAiF;IAC5F,YAAY,EAAE;QACZ,yDAAyD;KAC1D;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,qFAAqF;KAC/F;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;QAC7C,aAAa,EAAE;YACb,0EAA0E;YAC1E,+EAA+E;YAC/E,qFAAqF;YACrF,yEAAyE;YACzE,wEAAwE;SACzE;KACF;IACD,aAAa,EAAE,qVAAqV;IACpW,WAAW,EAAE;QACX,qFAAqF;QACrF,4PAA4P;QAC5P,gOAAgO;QAChO,wLAAwL;QACxL,kPAAkP;QAClP,+KAA+K;QAC/K,6HAA6H;KAC9H;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,0NAA0N;YACnO,QAAQ,EAAE,YAAY;SACvB;QACD;YACE,aAAa,EAAE,uBAAuB;YACtC,OAAO,EAAE,wMAAwM;SAClN;QACD;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,gLAAgL;SAC1L;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,0KAA0K;SACpL;QACD;YACE,aAAa,EAAE,6DAA6D;YAC5E,OAAO,EAAE,uUAAuU;SACjV;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,sHAAsH;SACjI;QACD;YACE,UAAU,EAAE,qBAAqB;YACjC,QAAQ,EAAE,4LAA4L;SACvM;QACD;YACE,UAAU,EAAE,6BAA6B;YACzC,QAAQ,EAAE,mJAAmJ;SAC9J;QACD;YACE,UAAU,EAAE,yBAAyB;YACrC,QAAQ,EAAE,uLAAuL;SAClM;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,gJAAgJ;SAC3J;QACD;YACE,UAAU,EAAE,8BAA8B;YAC1C,QAAQ,EAAE,mIAAmI;SAC9I;QACD;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,+FAA+F;SAC1G;QACD;YACE,UAAU,EAAE,wDAAwD;YACpE,QAAQ,EAAE,mJAAmJ;SAC9J;QACD;YACE,UAAU,EAAE,uBAAuB;YACnC,QAAQ,EAAE,+IAA+I;SAC1J;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,mIAAmI;SAC9I;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,uGAAuG;KAC/G;IACD,eAAe,EAAE,uLAAuL;IACxM,cAAc,EAAE;QACd,mSAAmS;KACpS;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,IAAI;QACJ,MAAM;KACP;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/which.js

@@ -0,0 +1,171 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "which",
+    "category": "introspection",
+    "keywords": [
+        "which",
+        "search path",
+        "builtin lookup",
+        "script path",
+        "variable shadowing"
+    ],
+    "summary": "Identify which variable, builtin, script, class, or folder RunMat will execute for a given name.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/which.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host CPU. Arguments that live on the GPU are gathered before evaluating the search."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::introspection::which::tests",
+        "integration": "builtins::introspection::which::tests::which_variable_search_respects_workspace"
+    },
+    "description": "`which name` reports exactly which entity RunMat will call when you invoke `name`. It follows MATLAB's search order:\n\n1. Variables in the current workspace 2. Builtin functions 3. Class folders and classdef files 4. MATLAB files on the RunMat path (`.m`, `.mlx`, etc.) 5. Folders\n\nThe builtin accepts the same flags as MATLAB: `-all`, `-builtin`, `-var`, and `-file`.",
+    "behaviors": [
+        "Names can be supplied as character vectors or string scalars. Calling `which` with no name raises `which: not enough input arguments`.",
+        "`which name` without options returns the first match respecting MATLAB's precedence rules.",
+        "`which(name, \"-all\")` (or `which(\"-all\", name)`) returns a cell array with every match on the search path, in discovery order, without duplicates.",
+        "`which(..., \"-builtin\")` restricts the search to builtin functions. `\"-var\"` restricts to workspace variables, and `\"-file\"` restricts the search to files, classes, and folders.",
+        "Package-qualified names like `pkg.func` automatically map to `+pkg` folders. Class lookups recognise both `@ClassName` folders and `.m` files containing `classdef`.",
+        "Relative paths are resolved against the current working directory. Absolute paths and paths beginning with `~` or drive letters are honoured directly."
+    ],
+    "examples": [
+        {
+            "description": "Finding a built-in function's implementation",
+            "input": "which(\"sin\")",
+            "output": "built-in (RunMat builtin: sin)"
+        },
+        {
+            "description": "Checking if a workspace variable shadows a builtin",
+            "input": "answer = 42;\nwhich(\"answer\")",
+            "output": "'answer' is a variable."
+        },
+        {
+            "description": "Listing all matches on the path",
+            "input": "which(\"sum\", \"-all\")",
+            "output": "{\n    [1,1] = built-in (RunMat builtin: sum)\n    [2,1] = //runmat/stdlib/sum.m\n}"
+        },
+        {
+            "description": "Locating a script or function file",
+            "input": "which(\"helpers/process_data\")",
+            "output": "//projects/runmat/helpers/process_data.m"
+        },
+        {
+            "description": "Restricting the search to variables",
+            "input": "which(\"-var\", \"velocity\")",
+            "output": "'velocity' is a variable."
+        },
+        {
+            "description": "Restricting the search to files",
+            "input": "which(\"fft\", \"-file\")",
+            "output": "//runmat/overrides/fft.m"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What happens when nothing is found?",
+            "answer": "`which` returns the character vector `'<name>' not found.` just like MATLAB."
+        },
+        {
+            "question": "Are method lookups supported?",
+            "answer": "Methods defined via `@Class` folders or `classdef` files are discovered through the class search. Package-qualified methods are supported."
+        },
+        {
+            "question": "Does `which` canonicalise paths?",
+            "answer": "Yes. RunMat reports canonical absolute paths where possible; when canonicalisation fails, the original path is returned."
+        },
+        {
+            "question": "Can I combine `-all` with other options?",
+            "answer": "Yes. For example, `which(\"plot\", \"-all\", \"-file\")` lists every file-based implementation without reporting builtins or variables."
+        },
+        {
+            "question": "Does the search respect `RUNMAT_PATH` / `MATLABPATH`?",
+            "answer": "Yes. The directory list mirrors the logic used by other REPL filesystem builtins."
+        },
+        {
+            "question": "What about Simulink models or Java classes?",
+            "answer": "File-based matches with supported extensions (`.slx`, `.mdl`, `.class`, etc.) are reported when present on the path."
+        },
+        {
+            "question": "Are duplicate results filtered?",
+            "answer": "Yes. The first occurrence of each unique path is returned."
+        },
+        {
+            "question": "Is the lookup case sensitive?",
+            "answer": "No. Matching is case-insensitive on all platforms, following MATLAB semantics."
+        },
+        {
+            "question": "Does `which` gather GPU values?",
+            "answer": "Yes. GPU-resident arguments are automatically gathered before the search begins."
+        }
+    ],
+    "links": [
+        {
+            "label": "exist",
+            "url": "./exist"
+        },
+        {
+            "label": "ls",
+            "url": "./ls"
+        },
+        {
+            "label": "dir",
+            "url": "./dir"
+        },
+        {
+            "label": "copyfile",
+            "url": "./copyfile"
+        },
+        {
+            "label": "class",
+            "url": "./class"
+        },
+        {
+            "label": "isa",
+            "url": "./isa"
+        },
+        {
+            "label": "ischar",
+            "url": "./ischar"
+        },
+        {
+            "label": "isstring",
+            "url": "./isstring"
+        },
+        {
+            "label": "who",
+            "url": "./who"
+        },
+        {
+            "label": "whos",
+            "url": "./whos"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/introspection/which.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/introspection/which.rs"
+    },
+    "gpu_residency": "No. `which` gathers GPU arguments implicitly and never produces device-resident output. There is no benefit in moving strings to the GPU before calling `which`.",
+    "gpu_behavior": [
+        "`which` performs string parsing and filesystem inspection on the host CPU. If you pass GPU-resident strings (for example, `gpuArray(\"sin\")`), RunMat gathers them automatically before evaluating the request. Results are always host-resident character arrays or cell arrays. Acceleration providers do not implement kernels for this builtin."
+    ],
+    "key": "which",
+    "slug": "which",
+    "categoryPath": [
+        "introspection"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=which.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"which.js","sourceRoot":"","sources":["../../../src/generated/builtins/which.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,OAAO;QACP,aAAa;QACb,gBAAgB;QAChB,aAAa;QACb,oBAAoB;KACrB;IACD,SAAS,EAAE,kGAAkG;IAC7G,YAAY,EAAE;QACZ,sDAAsD;KACvD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,0GAA0G;KACpH;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,uCAAuC;QAC/C,aAAa,EAAE,iFAAiF;KACjG;IACD,aAAa,EAAE,qXAAqX;IACpY,WAAW,EAAE;QACX,wIAAwI;QACxI,4FAA4F;QAC5F,wJAAwJ;QACxJ,yLAAyL;QACzL,sKAAsK;QACtK,wJAAwJ;KACzJ;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,gBAAgB;YACzB,QAAQ,EAAE,gCAAgC;SAC3C;QACD;YACE,aAAa,EAAE,oDAAoD;YACnE,OAAO,EAAE,iCAAiC;YAC1C,QAAQ,EAAE,yBAAyB;SACpC;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,0BAA0B;YACnC,QAAQ,EAAE,qFAAqF;SAChG;QACD;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,iCAAiC;YAC1C,QAAQ,EAAE,0CAA0C;SACrD;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,+BAA+B;YACxC,QAAQ,EAAE,2BAA2B;SACtC;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,2BAA2B;YACpC,QAAQ,EAAE,0BAA0B;SACrC;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,8EAA8E;SACzF;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,4IAA4I;SACvJ;QACD;YACE,UAAU,EAAE,kCAAkC;YAC9C,QAAQ,EAAE,0HAA0H;SACrI;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,yIAAyI;SACpJ;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,mFAAmF;SAC9F;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,sHAAsH;SACjI;QACD;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,4DAA4D;SACvE;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,gFAAgF;SAC3F;QACD;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,kFAAkF;SAC7F;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;IACD,eAAe,EAAE,kKAAkK;IACnL,cAAc,EAAE;QACd,sVAAsV;KACvV;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/who.js

@@ -0,0 +1,154 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "who",
+    "category": "introspection",
+    "keywords": [
+        "who",
+        "workspace",
+        "variables",
+        "introspection",
+        "mat-file"
+    ],
+    "summary": "List the names of variables in the workspace or MAT-files (MATLAB-compatible).",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/who.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host. GPU arrays remain on the device; RunMat inspects metadata without gathering buffers."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::introspection::who::tests",
+        "integration": null
+    },
+    "description": "`who` returns the names of variables that are visible in the active workspace. You can filter the result using wildcard patterns, regular expressions, or by reading directly from MAT-files without loading the data.",
+    "behaviors": [
+        "`who` with no arguments lists every variable in the current workspace, sorted alphabetically.",
+        "`who pattern1 pattern2 ...` accepts character vectors or string scalars with MATLAB wildcard syntax (`*`, `?`, `[abc]`). Any variable name that matches at least one pattern is returned.",
+        "`who('-regexp', expr1, expr2, ...)` keeps names that match any of the supplied regular expressions.",
+        "`who('global')` lists only global variables in the active workspace.",
+        "`who('-file', filename, ...)` inspects the variables stored in a MAT-file. You can combine this option with explicit names or `-regexp` selectors.",
+        "The result is a column cell array of character vectors (consistent with MATLAB). Empty results return a `0×1` cell array so that idioms like `isempty(who(...))` work as expected."
+    ],
+    "examples": [
+        {
+            "description": "List All Workspace Variables",
+            "input": "a = 42;\nb = rand(3, 2);\nnames = who",
+            "output": "names =\n  2×1 cell array\n    {\"a\"}\n    {\"b\"}"
+        },
+        {
+            "description": "Filter With Wildcard Patterns",
+            "input": "alpha = 1;\nbeta = 2;\nnames = who(\"a*\")",
+            "output": "names =\n  1×1 cell array\n    {\"alpha\"}"
+        },
+        {
+            "description": "Use Regular Expressions",
+            "input": "x1 = rand;\nx2 = rand;\nmatches = who('-regexp', '^x\\d$')",
+            "output": "matches =\n  2×1 cell array\n    {\"x1\"}\n    {\"x2\"}"
+        },
+        {
+            "description": "Inspect Variables Stored In A MAT-File",
+            "input": "save('snapshot.mat', 'alpha', 'beta')\nfile_names = who('-file', 'snapshot.mat')",
+            "output": "file_names =\n  2×1 cell array\n    {\"alpha\"}\n    {\"beta\"}"
+        },
+        {
+            "description": "List Only Global Variables",
+            "input": "global shared;\nlocal = 1;\nglobals = who('global')",
+            "output": "globals =\n  1×1 cell array\n    {\"shared\"}"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What type does `who` return?",
+            "answer": "A column cell array of character vectors, matching MATLAB behaviour."
+        },
+        {
+            "question": "Are the names sorted?",
+            "answer": "Yes. Results are sorted alphabetically so that diffs are deterministic."
+        },
+        {
+            "question": "Can I mix wildcard patterns and `-regexp`?",
+            "answer": "Yes. The final result includes any name matched by either the wildcard selectors or the regular expressions."
+        },
+        {
+            "question": "What happens if no variables match?",
+            "answer": "You receive a `0×1` cell array. You can call `isempty` on it to check for an empty result."
+        },
+        {
+            "question": "Can I call `who('-file', ...)` on large MAT-files?",
+            "answer": "Yes. The builtin reads just enough metadata to enumerate variable names; it does not load the data into the workspace."
+        }
+    ],
+    "links": [
+        {
+            "label": "whos",
+            "url": "./whos"
+        },
+        {
+            "label": "which",
+            "url": "./which"
+        },
+        {
+            "label": "class",
+            "url": "./class"
+        },
+        {
+            "label": "size",
+            "url": "./size"
+        },
+        {
+            "label": "load",
+            "url": "./load"
+        },
+        {
+            "label": "save",
+            "url": "./save"
+        },
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        },
+        {
+            "label": "isa",
+            "url": "./isa"
+        },
+        {
+            "label": "ischar",
+            "url": "./ischar"
+        },
+        {
+            "label": "isstring",
+            "url": "./isstring"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/introspection/who.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/introspection/who.rs"
+    },
+    "gpu_residency": "No. `who` never requires you to gather data or move arrays between the host and GPU. It simply reports variable names, regardless of residency. Use `gpuArray` or `gather` only when you explicitly need to control where data lives.",
+    "gpu_behavior": [
+        "`who` is a pure introspection builtin that runs on the CPU. When a variable is a `gpuArray`, RunMat leaves it resident on the device and reports its name without triggering any device-to-host copies. Only scalar selector arguments are gathered if they are stored on the GPU."
+    ],
+    "key": "who",
+    "slug": "who",
+    "categoryPath": [
+        "introspection"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=who.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"who.js","sourceRoot":"","sources":["../../../src/generated/builtins/who.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,KAAK;QACL,WAAW;QACX,WAAW;QACX,eAAe;QACf,UAAU;KACX;IACD,SAAS,EAAE,gFAAgF;IAC3F,YAAY,EAAE;QACZ,oDAAoD;KACrD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iHAAiH;KAC3H;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;QAC7C,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,wNAAwN;IACvO,WAAW,EAAE;QACX,+FAA+F;QAC/F,2LAA2L;QAC3L,qGAAqG;QACrG,sEAAsE;QACtE,oJAAoJ;QACpJ,oLAAoL;KACrL;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,8BAA8B;YAC7C,OAAO,EAAE,uCAAuC;YAChD,QAAQ,EAAE,qDAAqD;SAChE;QACD;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,4CAA4C;YACrD,QAAQ,EAAE,4CAA4C;SACvD;QACD;YACE,aAAa,EAAE,yBAAyB;YACxC,OAAO,EAAE,4DAA4D;YACrE,QAAQ,EAAE,yDAAyD;SACpE;QACD;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,kFAAkF;YAC3F,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,aAAa,EAAE,4BAA4B;YAC3C,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,+CAA+C;SAC1D;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,8BAA8B;YAC1C,QAAQ,EAAE,sEAAsE;SACjF;QACD;YACE,UAAU,EAAE,uBAAuB;YACnC,QAAQ,EAAE,yEAAyE;SACpF;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,8GAA8G;SACzH;QACD;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,4FAA4F;SACvG;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,wHAAwH;SACnI;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,wGAAwG;KAChH;IACD,eAAe,EAAE,uOAAuO;IACxP,cAAc,EAAE;QACd,oRAAoR;KACrR;IACD,KAAK,EAAE,KAAK;IACZ,MAAM,EAAE,KAAK;IACb,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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