runmat 0.3.6 → 0.4.0

package/dist/generated/builtins/setenv.js

@@ -0,0 +1,212 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "setenv",
+    "category": "io/repl_fs",
+    "keywords": [
+        "setenv",
+        "environment variable",
+        "status",
+        "message",
+        "unset"
+    ],
+    "summary": "Set or clear environment variables with MATLAB-compatible status outputs.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/setenv.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Host-only operation. RunMat gathers GPU-resident inputs before mutating the process environment; providers do not expose hooks for this builtin."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::repl_fs::setenv::tests",
+        "integration": "builtins::io::repl_fs::setenv::tests::setenv_reports_failure_for_illegal_name"
+    },
+    "description": "`setenv` updates the process environment. Provide a variable name and value to create or modify an entry, or pass an empty value to remove the variable. The builtin mirrors MATLAB by returning a status code and optional diagnostic message instead of throwing for platform-defined failures.",
+    "behaviors": [
+        "`status = setenv(name, value)` returns `0` when the update succeeds and `1` when the operating system rejects the request. The status output is a double scalar, matching MATLAB.",
+        "`[status, message] = setenv(name, value)` returns the status plus a character vector describing failures. On success, `message` is an empty `1×0` character array.",
+        "Set `value` to an empty string (`\"\"`) or empty character vector (`''`) to remove the variable from the current process environment.",
+        "Names must be string scalars or character vectors containing only valid environment variable characters. MATLAB raises an error when `name` is not text; RunMat mirrors this check.",
+        "Character vector inputs trim trailing padding spaces (common with MATLAB character matrices). To retain trailing spaces, pass a string scalar instead.",
+        "Environment updates apply to the RunMat process and any child processes it spawns. They do not modify the parent shell."
+    ],
+    "examples": [
+        {
+            "description": "Set a new environment variable for the current session",
+            "input": "status = setenv(\"RUNMAT_MODE\", \"development\")",
+            "output": "status =\n     0"
+        },
+        {
+            "description": "Update an existing environment variable",
+            "input": "status = setenv(\"PATH\", string(getenv(\"PATH\")) + \":~/runmat/bin\")",
+            "output": "status =\n     0"
+        },
+        {
+            "description": "Remove an environment variable with an empty value",
+            "input": "[status, message] = setenv(\"OLD_SETTING\", \"\")",
+            "output": "status =\n     0\n\nmessage ="
+        },
+        {
+            "description": "Capture diagnostic messages when a name is invalid",
+            "input": "[status, message] = setenv(\"INVALID=NAME\", \"value\")",
+            "output": "status =\n     1\n\nmessage =\nEnvironment variable names must not contain '='."
+        },
+        {
+            "description": "Use character vectors from legacy code",
+            "input": "status = setenv('RUNMAT_LEGACY', 'enabled')",
+            "output": "status =\n     0"
+        },
+        {
+            "description": "Combine `setenv` with child process launches",
+            "input": "setenv(\"RUNMAT_DATASET\", \"demo\");\nstatus = system(\"runmat-cli process-data\")",
+            "output": "status =\n     0"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What status codes does `setenv` return?",
+            "answer": "`0` means success; `1` means the operating system rejected the request (for example, due to an invalid name or an oversized value on Windows)."
+        },
+        {
+            "question": "Does `setenv` throw errors?",
+            "answer": "Only when the inputs are the wrong type (non-text). Platform failures are reported through the status and message outputs so scripts can handle them programmatically."
+        },
+        {
+            "question": "How do I remove a variable?",
+            "answer": "Pass an empty string or empty character vector as the value."
+        },
+        {
+            "question": "Are names case-sensitive?",
+            "answer": "RunMat defers to the operating system: case-sensitive on Unix-like systems and case-insensitive on Windows."
+        },
+        {
+            "question": "Can I include trailing spaces in the value?",
+            "answer": "Use string scalars to preserve trailing spaces. Character vector inputs trim trailing padding spaces by design."
+        },
+        {
+            "question": "Does `setenv` affect the parent shell?",
+            "answer": "No. Changes are limited to the current RunMat process and any child processes launched afterwards."
+        },
+        {
+            "question": "What characters are disallowed in names?",
+            "answer": "`setenv` rejects names containing `=` or null characters. Additional platform-specific restrictions are enforced by the operating system and reported through the status/message outputs."
+        },
+        {
+            "question": "Can I call `setenv` from GPU-enabled code?",
+            "answer": "Yes. Arguments are gathered from the GPU before updating the environment; the operation itself always runs on the CPU."
+        },
+        {
+            "question": "How can I check whether the update succeeded?",
+            "answer": "Inspect the returned `status`. When it is `1`, read the accompanying message to determine why the operation failed."
+        },
+        {
+            "question": "Will the variable persist after I exit RunMat?",
+            "answer": "No. Environment modifications are scoped to the current process."
+        }
+    ],
+    "links": [
+        {
+            "label": "getenv",
+            "url": "./getenv"
+        },
+        {
+            "label": "mkdir",
+            "url": "./mkdir"
+        },
+        {
+            "label": "pwd",
+            "url": "./pwd"
+        },
+        {
+            "label": "addpath",
+            "url": "./addpath"
+        },
+        {
+            "label": "cd",
+            "url": "./cd"
+        },
+        {
+            "label": "copyfile",
+            "url": "./copyfile"
+        },
+        {
+            "label": "delete",
+            "url": "./delete"
+        },
+        {
+            "label": "dir",
+            "url": "./dir"
+        },
+        {
+            "label": "exist",
+            "url": "./exist"
+        },
+        {
+            "label": "fullfile",
+            "url": "./fullfile"
+        },
+        {
+            "label": "genpath",
+            "url": "./genpath"
+        },
+        {
+            "label": "ls",
+            "url": "./ls"
+        },
+        {
+            "label": "movefile",
+            "url": "./movefile"
+        },
+        {
+            "label": "path",
+            "url": "./path"
+        },
+        {
+            "label": "rmdir",
+            "url": "./rmdir"
+        },
+        {
+            "label": "rmpath",
+            "url": "./rmpath"
+        },
+        {
+            "label": "savepath",
+            "url": "./savepath"
+        },
+        {
+            "label": "tempdir",
+            "url": "./tempdir"
+        },
+        {
+            "label": "tempname",
+            "url": "./tempname"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/repl_fs/setenv.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/repl_fs/setenv.rs"
+    },
+    "gpu_residency": "No. `setenv` is a host-side operation. GPU residency offers no benefit, and RunMat gathers GPU-backed values automatically if they appear as inputs.",
+    "gpu_behavior": [
+        "`setenv` always runs on the CPU. If a caller stores the arguments on the GPU—for instance via an accelerated string builtin—RunMat gathers them to host memory automatically before mutating the environment. Acceleration providers do not implement hooks for this builtin."
+    ],
+    "key": "setenv",
+    "slug": "setenv",
+    "categoryPath": [
+        "io",
+        "repl_fs"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=setenv.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setenv.js","sourceRoot":"","sources":["../../../src/generated/builtins/setenv.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,QAAQ;QACR,sBAAsB;QACtB,QAAQ;QACR,SAAS;QACT,OAAO;KACR;IACD,SAAS,EAAE,2EAA2E;IACtF,YAAY,EAAE;QACZ,uDAAuD;KACxD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,kJAAkJ;KAC5J;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,sCAAsC;QAC9C,aAAa,EAAE,+EAA+E;KAC/F;IACD,aAAa,EAAE,mSAAmS;IAClT,WAAW,EAAE;QACX,mLAAmL;QACnL,oKAAoK;QACpK,uIAAuI;QACvI,qLAAqL;QACrL,wJAAwJ;QACxJ,yHAAyH;KAC1H;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wDAAwD;YACvE,OAAO,EAAE,mDAAmD;YAC5D,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,yEAAyE;YAClF,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,oDAAoD;YACnE,OAAO,EAAE,mDAAmD;YAC5D,QAAQ,EAAE,+BAA+B;SAC1C;QACD;YACE,aAAa,EAAE,oDAAoD;YACnE,OAAO,EAAE,yDAAyD;YAClE,QAAQ,EAAE,iFAAiF;SAC5F;QACD;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,6CAA6C;YACtD,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,qFAAqF;YAC9F,QAAQ,EAAE,kBAAkB;SAC7B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,yCAAyC;YACrD,QAAQ,EAAE,gJAAgJ;SAC3J;QACD;YACE,UAAU,EAAE,6BAA6B;YACzC,QAAQ,EAAE,wKAAwK;SACnL;QACD;YACE,UAAU,EAAE,6BAA6B;YACzC,QAAQ,EAAE,8DAA8D;SACzE;QACD;YACE,UAAU,EAAE,2BAA2B;YACvC,QAAQ,EAAE,6GAA6G;SACxH;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,iHAAiH;SAC5H;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,oGAAoG;SAC/G;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,2LAA2L;SACtM;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,wHAAwH;SACnI;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,qHAAqH;SAChI;QACD;YACE,UAAU,EAAE,gDAAgD;YAC5D,QAAQ,EAAE,kEAAkE;SAC7E;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;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,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;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,sJAAsJ;IACvK,cAAc,EAAE;QACd,+QAA+Q;KAChR;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/setfield.js

@@ -0,0 +1,145 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "setfield",
+    "category": "structs/core",
+    "keywords": [
+        "setfield",
+        "struct",
+        "assignment",
+        "struct array",
+        "object property"
+    ],
+    "summary": "Assign into struct fields, struct arrays, or MATLAB-style object properties.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Assignments run on the host. GPU tensors or handles embedded in structs are gathered to host memory before mutation."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::structs::core::setfield::tests",
+        "integration": "runmat_ignition::tests::functions::member_get_set_and_method_call_skeleton"
+    },
+    "description": "`S = setfield(S, field, value)` returns a copy of the struct (or object) with `field` assigned to `value`. Additional field names and index cells let you update nested structures, struct arrays, and array elements contained within fields.",
+    "behaviors": [
+        "Field names must be character vectors or string scalars. Provide as many field names as needed; each additional name drills deeper into nested structs, so `setfield(S,\"outer\",\"inner\",value)` mirrors `S.outer.inner = value`.",
+        "Missing struct fields are created automatically. If intermediary structs do not exist, RunMat allocates them so that the assignment completes successfully.",
+        "Struct arrays require a leading cell array of one-based indices, e.g. `setfield(S,{2},\"field\",value)` or `setfield(S,{1,3},\"field\",value)`, and accept the keyword `end`.",
+        "You can index into a field's contents before traversing deeper by placing a cell array of indices immediately after the field name: `setfield(S,\"values\",{1,2},\"leaf\",x)` matches `S.values{1,2}.leaf = x`.",
+        "MATLAB-style objects honour property metadata: private setters raise access errors, static properties cannot be written through instances, and dependent properties forward to `set.<name>` methods when available.",
+        "The function returns the updated struct or object. For value types the result is a new copy; handle objects still point at the same instance, and the handle is returned for chaining."
+    ],
+    "examples": [
+        {
+            "description": "Assigning a new field in a scalar struct",
+            "input": "s = struct();\ns = setfield(s, \"answer\", 42);\ndisp(s.answer)",
+            "output": "    42"
+        },
+        {
+            "description": "Creating nested structs automatically",
+            "input": "cfg = struct();\ncfg = setfield(cfg, \"solver\", \"name\", \"cg\");\ncfg = setfield(cfg, \"solver\", \"tolerance\", 1e-6);\ndisp(cfg.solver.tolerance)",
+            "output": "  1.0000e-06"
+        },
+        {
+            "description": "Updating an element of a struct array",
+            "input": "people = struct(\"name\", {\"Ada\", \"Grace\"}, \"id\", {101, 102});\npeople = setfield(people, {2}, \"id\", 999);\ndisp(people(2).id)",
+            "output": "   999"
+        },
+        {
+            "description": "Assigning through a field that contains a cell array",
+            "input": "data = struct(\"samples\", {{struct(\"value\", 1), struct(\"value\", 2)}} );\ndata = setfield(data, \"samples\", {2}, \"value\", 10);\ndisp(data.samples{2}.value)",
+            "output": "    10"
+        },
+        {
+            "description": "Setting an object property that honours access attributes",
+            "input": "classdef Point\n    properties\n        x double = 0;\n    end\nend",
+            "output": "    3"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `setfield` modify the input in-place?",
+            "answer": "No. Like MATLAB, it returns a new struct (or object) with the requested update. In Rust this entails cloning the source value and mutating the clone."
+        },
+        {
+            "question": "Can I create nested structs in a single call?",
+            "answer": "Yes. Missing intermediate structs are created automatically when you provide multiple field names, e.g. `setfield(S,\"outer\",\"inner\",value)` builds `outer` when needed."
+        },
+        {
+            "question": "How do I update a specific element of a struct array?",
+            "answer": "Supply an index cell before the first field name: `setfield(S,{row,col},\"field\",value)` is the same as `S(row,col).field = value`."
+        },
+        {
+            "question": "Does `setfield` work with handle objects?",
+            "answer": "Yes. Valid handle objects forward the assignment to the underlying instance. Deleted or invalid handles raise the standard MATLAB-style error."
+        },
+        {
+            "question": "Can I index into field contents before continuing?",
+            "answer": "Yes. Place a cell array of indices immediately after the field name. Each set of indices uses MATLAB's one-based semantics and supports the keyword `end`."
+        },
+        {
+            "question": "Why are GPU tensors gathered to the host?",
+            "answer": "Assignments require host-side mutation. Providers can re-upload the updated tensor on subsequent GPU-aware operations; `setfield` itself never launches kernels."
+        }
+    ],
+    "links": [
+        {
+            "label": "getfield",
+            "url": "./getfield"
+        },
+        {
+            "label": "fieldnames",
+            "url": "./fieldnames"
+        },
+        {
+            "label": "struct",
+            "url": "./struct"
+        },
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        },
+        {
+            "label": "isfield",
+            "url": "./isfield"
+        },
+        {
+            "label": "orderfields",
+            "url": "./orderfields"
+        },
+        {
+            "label": "rmfield",
+            "url": "./rmfield"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/structs/core/setfield.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/structs/core/setfield.rs"
+    },
+    "gpu_residency": "You do not have to move data explicitly when assigning into structs. If a field contains a GPU tensor, `setfield` gathers it to host memory so the mutation can be performed safely. Subsequent operations decide whether to migrate it back to the GPU.",
+    "gpu_behavior": [
+        "`setfield` executes entirely on the host. When fields contain GPU-resident tensors, RunMat gathers those tensors to host memory before mutating them and stores the resulting host tensor back into the struct or object. No GPU kernels are launched for these assignments."
+    ],
+    "key": "setfield",
+    "slug": "setfield",
+    "categoryPath": [
+        "structs",
+        "core"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=setfield.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setfield.js","sourceRoot":"","sources":["../../../src/generated/builtins/setfield.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE;QACV,UAAU;QACV,QAAQ;QACR,YAAY;QACZ,cAAc;QACd,iBAAiB;KAClB;IACD,SAAS,EAAE,8EAA8E;IACzF,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,sHAAsH;KAChI;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,0CAA0C;QAClD,aAAa,EAAE,4EAA4E;KAC5F;IACD,aAAa,EAAE,gPAAgP;IAC/P,WAAW,EAAE;QACX,qOAAqO;QACrO,6JAA6J;QAC7J,+KAA+K;QAC/K,iNAAiN;QACjN,qNAAqN;QACrN,wLAAwL;KACzL;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,iEAAiE;YAC1E,QAAQ,EAAE,QAAQ;SACnB;QACD;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,wJAAwJ;YACjK,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,uCAAuC;YACtD,OAAO,EAAE,wIAAwI;YACjJ,QAAQ,EAAE,QAAQ;SACnB;QACD;YACE,aAAa,EAAE,sDAAsD;YACrE,OAAO,EAAE,oKAAoK;YAC7K,QAAQ,EAAE,QAAQ;SACnB;QACD;YACE,aAAa,EAAE,2DAA2D;YAC1E,OAAO,EAAE,qEAAqE;YAC9E,QAAQ,EAAE,OAAO;SAClB;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,uJAAuJ;SAClK;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,6KAA6K;SACxL;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,sIAAsI;SACjJ;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,gJAAgJ;SAC3J;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,4JAA4J;SACvK;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,kKAAkK;SAC7K;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,eAAe;SACvB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,+DAA+D;QACxE,KAAK,EAAE,4GAA4G;KACpH;IACD,eAAe,EAAE,0PAA0P;IAC3Q,cAAc,EAAE;QACd,8QAA8Q;KAC/Q;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,SAAS;QACT,MAAM;KACP;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/shading.js

@@ -0,0 +1,64 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "shading",
+    "category": "plotting",
+    "keywords": [
+        "shading",
+        "surface shading",
+        "shading interp",
+        "shading flat",
+        "matlab shading"
+    ],
+    "summary": "Control flat, interpolated, or faceted surface shading with MATLAB `shading` workflows.",
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::cmds"
+    },
+    "description": "`shading` controls how surfaces and related scalar-field plots interpolate or facet their color/geometry presentation. In RunMat it is most relevant for the surface family (`surf`, `mesh`, `surfc`, `meshc`) and complements colormap-driven visualization workflows with the standard MATLAB `shading flat`, `shading interp`, and `shading faceted` styles.",
+    "behaviors": [
+        "`shading flat` uses flat shading across faces.",
+        "`shading interp` enables interpolated/smooth shading across the rendered surface.",
+        "`shading faceted` restores faceted surface presentation.",
+        "Shading state is subplot-local through the shared plotting metadata model."
+    ],
+    "examples": [
+        {
+            "description": "Apply interpolated shading to a surface",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 50), linspace(-3, 3, 50));\nZ = sin(X) .* cos(Y);\nsurf(X, Y, Z);\nshading interp;"
+        },
+        {
+            "description": "Compare flat and faceted shading across subplots",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 40), linspace(-3, 3, 40));\nZ = sin(X) .* cos(Y);\nsubplot(1, 2, 1);\nsurf(X, Y, Z);\nshading flat;\nsubplot(1, 2, 2);\nsurf(X, Y, Z);\nshading faceted;"
+        }
+    ],
+    "links": [
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "mesh",
+            "url": "./mesh"
+        },
+        {
+            "label": "colormap",
+            "url": "./colormap"
+        },
+        {
+            "label": "colorbar",
+            "url": "./colorbar"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/cmds.rs"
+    },
+    "key": "shading",
+    "slug": "shading",
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=shading.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shading.js","sourceRoot":"","sources":["../../../src/generated/builtins/shading.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,iBAAiB;QACjB,gBAAgB;QAChB,cAAc;QACd,gBAAgB;KACjB;IACD,SAAS,EAAE,yFAAyF;IACpG,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,0BAA0B;KACnC;IACD,aAAa,EAAE,iWAAiW;IAChX,WAAW,EAAE;QACX,gDAAgD;QAChD,mFAAmF;QACnF,0DAA0D;QAC1D,4EAA4E;KAC7E;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,sHAAsH;SAChI;QACD;YACE,aAAa,EAAE,kDAAkD;YACjE,OAAO,EAAE,4LAA4L;SACtM;KACF;IACD,OAAO,EAAE;QACP;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,wGAAwG;KAChH;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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