runmat 0.5.7-dev.2 → 0.5.7-dev.3

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

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

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

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

package/dist/generated/builtins/inputParser.js

@@ -0,0 +1,71 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "inputParser",
+    "category": "introspection",
+    "keywords": [
+        "inputParser",
+        "addParameter",
+        "parse",
+        "name-value",
+        "varargin"
+    ],
+    "summary": "Parse MATLAB-style optional name-value arguments.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "inputParser stores host-side metadata and parsed values."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::introspection::input_parser::tests",
+        "integration": "runmat-vm inputParser tests"
+    },
+    "description": "`inputParser` creates a handle object for parsing common MATLAB name-value argument patterns. RunMat supports the minimal workflow used by imported helper functions: create a parser, register parameters with defaults, parse `varargin{:}`, and read values from `p.Results`.",
+    "behaviors": [
+        "`p = inputParser` returns a handle object with an initially empty `Results` struct.",
+        "`addParameter(p, name, default)` registers a case-sensitive name and default value, mutating `p` in place.",
+        "`parse(p, name, value, ...)` starts from the registered defaults and applies exact name matches.",
+        "`p.Results.<name>` reads the parsed value for a registered parameter.",
+        "Duplicate parameter names, odd name-value argument counts, non-text names, and unknown parsed names raise stable RunMat errors.",
+        "This compatibility slice does not yet implement `addRequired`, `addOptional`, validators, `CaseSensitive`, `PartialMatching`, `KeepUnmatched`, or `StructExpand`."
+    ],
+    "examples": [
+        {
+            "description": "Parse an optional scale parameter",
+            "input": "function y = f(varargin)\n  p = inputParser;\n  addParameter(p, 'scale', 2);\n  parse(p, varargin{:});\n  y = p.Results.scale;\nend\n\nf('scale', 4)",
+            "output": "ans =\n     4"
+        },
+        {
+            "description": "Use a registered default when the name is omitted",
+            "input": "p = inputParser;\naddParameter(p, 'scale', 2);\nparse(p);\np.Results.scale",
+            "output": "ans =\n     2"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Are parameter names case-sensitive?",
+            "answer": "Yes. This initial RunMat implementation uses exact case-sensitive name matching."
+        },
+        {
+            "question": "Does RunMat support validators or positional arguments?",
+            "answer": "Not yet. The current support is intentionally limited to optional name-value parameters registered with `addParameter`."
+        }
+    ],
+    "key": "inputparser",
+    "slug": "inputparser",
+    "aliases": [],
+    "categoryPath": [
+        "introspection"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=inputParser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"inputParser.js","sourceRoot":"","sources":["../../../src/generated/builtins/inputParser.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,aAAa;QACb,cAAc;QACd,OAAO;QACP,YAAY;QACZ,UAAU;KACX;IACD,SAAS,EAAE,mDAAmD;IAC9D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,0DAA0D;KACpE;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,8CAA8C;QACtD,aAAa,EAAE,6BAA6B;KAC7C;IACD,aAAa,EAAE,kRAAkR;IACjS,WAAW,EAAE;QACX,qFAAqF;QACrF,4GAA4G;QAC5G,kGAAkG;QAClG,uEAAuE;QACvE,iIAAiI;QACjI,mKAAmK;KACpK;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,sJAAsJ;YAC/J,QAAQ,EAAE,eAAe;SAC1B;QACD;YACE,aAAa,EAAE,mDAAmD;YAClE,OAAO,EAAE,4EAA4E;YACrF,QAAQ,EAAE,eAAe;SAC1B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,kFAAkF;SAC7F;QACD;YACE,UAAU,EAAE,yDAAyD;YACrE,QAAQ,EAAE,yHAAyH;SACpI;KACF;IACD,KAAK,EAAE,aAAa;IACpB,MAAM,EAAE,aAAa;IACrB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,eAAe;KAChB;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,EAoiTjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAke9D,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,EAujTjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAme9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -4038,6 +4038,25 @@ export const builtinManifest = [
         "summary": "Prompt users for interactive input in MATLAB and RunMat.",
         "exampleCount": 1
     },
+    {
+        "key": "inputparser",
+        "title": "inputParser",
+        "slug": "inputparser",
+        "aliases": [],
+        "category": "introspection",
+        "categoryPath": [
+            "introspection"
+        ],
+        "keywords": [
+            "inputParser",
+            "addParameter",
+            "parse",
+            "name-value",
+            "varargin"
+        ],
+        "summary": "Parse MATLAB-style optional name-value arguments.",
+        "exampleCount": 2
+    },
     {
         "key": "int",
         "title": "int",
@@ -9964,6 +9983,7 @@ export const builtinDocLoaders = {
     "ind2sub": () => import("./builtins/ind2sub.js").then((mod) => mod.default),
     "inf": () => import("./builtins/inf.js").then((mod) => mod.default),
     "input": () => import("./builtins/input.js").then((mod) => mod.default),
+    "inputparser": () => import("./builtins/inputParser.js").then((mod) => mod.default),
     "int": () => import("./builtins/int.js").then((mod) => mod.default),
     "integral": () => import("./builtins/integral.js").then((mod) => mod.default),
     "interp1": () => import("./builtins/interp1.js").then((mod) => mod.default),