runmat 0.4.9-dev.1 → 0.4.9-dev.2

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

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

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

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

package/dist/generated/builtins/fgetl.js

@@ -0,0 +1,133 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "fgetl",
+    "category": "io/filetext",
+    "keywords": [
+        "fgetl",
+        "text file",
+        "line input",
+        "newline"
+    ],
+    "summary": "Read the next line from a file, removing newline characters from the result.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/fgetl.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the host CPU. When the file identifier lives on the GPU, RunMat gathers it before performing host I/O."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::filetext::fgetl::tests"
+    },
+    "description": "`fgetl(fid)` returns the next line from the text file associated with `fid`, removing any line terminator from the returned character row vector. It mirrors MATLAB's end-of-file sentinel and file-position semantics so line-oriented scripts can distinguish real empty lines from EOF.",
+    "behaviors": [
+        "`tline = fgetl(fid)` reads from the current file position to the next line terminator or to end-of-file when no terminator is found.",
+        "Line terminators are consumed but not included in the returned character row vector. RunMat recognises `\\n`, `\\r\\n`, and `\\r`.",
+        "When the file is empty or the file position indicator is already at end-of-file, `fgetl` returns the numeric sentinel `-1`.",
+        "An empty line returns an empty character row vector, not `-1`.",
+        "Lines are decoded using the text encoding recorded by `fopen`. UTF-8, US-ASCII, ISO-8859-1 (`latin1`), Windows-1252, Shift_JIS, and binary mode are recognised without additional user work."
+    ],
+    "examples": [
+        {
+            "description": "Read the first line of a file without the newline",
+            "input": "% Browser sandbox: you must be logged in\n% to save files for this example.\nfname = tempname;\nfid = fopen(fname, 'w');\nfprintf(fid, 'RunMat\\nSecond line\\n');\nfclose(fid);\n\nfid = fopen(fname, 'r');\nline = fgetl(fid);\nfclose(fid);\ndelete(fname);\n\nline",
+            "output": "line =\n    'RunMat'"
+        },
+        {
+            "description": "Read a file line by line",
+            "input": "% Browser sandbox: you must be logged in\n% to save files for this example.\nfname = tempname;\nfid = fopen(fname, 'w');\nfprintf(fid, 'one\\n');\nfprintf(fid, 'two\\n');\nfclose(fid);\n\nfid = fopen(fname, 'r');\ntline = fgetl(fid);\nwhile tline ~= -1\n    disp(tline);\n    tline = fgetl(fid);\nend\nfclose(fid);\ndelete(fname)",
+            "output": "one\ntwo"
+        },
+        {
+            "description": "Distinguish an empty line from end of file",
+            "input": "% Browser sandbox: you must be logged in\n% to save files for this example.\nfname = tempname;\nfid = fopen(fname, 'w');\nfprintf(fid, '\\nlast');\nfclose(fid);\n\nfid = fopen(fname, 'r');\nline1 = fgetl(fid);\nline2 = fgetl(fid);\nline3 = fgetl(fid);\nfclose(fid);\ndelete(fname);\n\nisempty(line1)\nline2\nline3",
+            "output": "ans =\n  logical\n   1\nline2 =\n    'last'\nline3 =\n    -1"
+        },
+        {
+            "description": "Read a final line without a trailing newline",
+            "input": "% Browser sandbox: you must be logged in\n% to save files for this example.\nfname = tempname;\nfid = fopen(fname, 'w');\nfprintf(fid, 'last line');\nfclose(fid);\n\nfid = fopen(fname, 'r');\nline1 = fgetl(fid);\nline2 = fgetl(fid);\nfclose(fid);\ndelete(fname);\n\nline1\nline2",
+            "output": "line1 =\n    'last line'\nline2 =\n    -1"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What does `fgetl` return at end-of-file?",
+            "answer": "When no characters can be read because the file position indicator is at end-of-file, `fgetl` returns the numeric value `-1`."
+        },
+        {
+            "question": "How does `fgetl` differ from `fgets`?",
+            "answer": "`fgetl` removes newline characters from the returned line, while `fgets` keeps them. Use `fgetl` for newline-free line processing and `fgets` when terminator bytes matter."
+        },
+        {
+            "question": "What happens for a blank line?",
+            "answer": "A blank line returns an empty character row vector. Only EOF before any characters are read returns `-1`."
+        },
+        {
+            "question": "Can I call `fgetl` on files opened for writing only?",
+            "answer": "No. The file must be opened with read permission (for example `'r'`, `'r+'`, or `'w+'`). Calling `fgetl` on a write-only identifier raises an error."
+        }
+    ],
+    "links": [
+        {
+            "label": "fopen",
+            "url": "./fopen"
+        },
+        {
+            "label": "fclose",
+            "url": "./fclose"
+        },
+        {
+            "label": "feof",
+            "url": "./feof"
+        },
+        {
+            "label": "fgets",
+            "url": "./fgets"
+        },
+        {
+            "label": "fread",
+            "url": "./fread"
+        },
+        {
+            "label": "fileread",
+            "url": "./fileread"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/io/filetext/fgetl.rs",
+        "url": "crates/runmat-runtime/src/builtins/io/filetext/fgetl.rs"
+    },
+    "syntax": {
+        "example": {
+            "description": "Syntax",
+            "input": "line = fgetl(fileID)"
+        },
+        "points": [
+            "`fileID` is a file handle returned by `fopen`. The file must be opened with read permission (`'r'`, `'r+'`, `'w+'`, or `'a+'`).",
+            "`line` is a character row vector without the trailing line terminator. When the file position is already at end-of-file, `fgetl` returns the numeric sentinel `-1`."
+        ]
+    },
+    "gpu_behavior": [
+        "`fgetl` is a host-only operation. File identifiers live in the host registry created by `fopen`, so GPU-resident scalar arguments are gathered back to the CPU before the read occurs."
+    ],
+    "key": "fgetl",
+    "slug": "fgetl",
+    "aliases": [],
+    "categoryPath": [
+        "io",
+        "filetext"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=fgetl.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fgetl.js","sourceRoot":"","sources":["../../../src/generated/builtins/fgetl.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,OAAO;QACP,WAAW;QACX,YAAY;QACZ,SAAS;KACV;IACD,SAAS,EAAE,8EAA8E;IACzF,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,yHAAyH;KACnI;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;KAC/C;IACD,aAAa,EAAE,4RAA4R;IAC3S,WAAW,EAAE;QACX,sIAAsI;QACtI,oIAAoI;QACpI,6HAA6H;QAC7H,gEAAgE;QAChE,8LAA8L;KAC/L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mDAAmD;YAClE,OAAO,EAAE,wQAAwQ;YACjR,QAAQ,EAAE,sBAAsB;SACjC;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,2UAA2U;YACpV,QAAQ,EAAE,UAAU;SACrB;QACD;YACE,aAAa,EAAE,4CAA4C;YAC3D,OAAO,EAAE,2TAA2T;YACpU,QAAQ,EAAE,8DAA8D;SACzE;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,wRAAwR;YACjS,QAAQ,EAAE,2CAA2C;SACtD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,+HAA+H;SAC1I;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,6KAA6K;SACxL;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,2GAA2G;SACtH;QACD;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,sJAAsJ;SACjK;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,yDAAyD;KACjE;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,QAAQ;YACvB,OAAO,EAAE,sBAAsB;SAChC;QACD,QAAQ,EAAE;YACR,iIAAiI;YACjI,qKAAqK;SACtK;KACF;IACD,cAAc,EAAE;QACd,wLAAwL;KACzL;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

package/dist/generated/builtins/fgets.js

@@ -125,6 +125,10 @@ const builtinDoc = {
             "label": "feof",
             "url": "./feof"
         },
+        {
+            "label": "fgetl",
+            "url": "./fgetl"
+        },
         {
             "label": "fread",
             "url": "./fread"

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

@@ -1 +1 @@
-{"version":3,"file":"fgets.js","sourceRoot":"","sources":["../../../src/generated/builtins/fgets.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,OAAO;QACP,WAAW;QACX,YAAY;QACZ,SAAS;KACV;IACD,SAAS,EAAE,2EAA2E;IACtF,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,gHAAgH;KAC1H;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;KAC/C;IACD,aAAa,EAAE,sSAAsS;IACrT,WAAW,EAAE;QACX,4NAA4N;QAC5N,gSAAgS;QAChS,4PAA4P;QAC5P,mIAAmI;QACnI,8LAA8L;KAC/L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,mMAAmM;YAC5M,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,6MAA6M;YACtN,QAAQ,EAAE,wDAAwD;SACnE;QACD;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,oRAAoR;YAC7R,QAAQ,EAAE,4DAA4D;SACvE;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,uNAAuN;YAChO,QAAQ,EAAE,2DAA2D;SACtE;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,yQAAyQ;YAClR,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,mQAAmQ;YAC5Q,QAAQ,EAAE,4EAA4E;SACvF;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,8LAA8L;SACzM;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,2JAA2J;SACtK;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,oRAAoR;SAC/R;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,6OAA6O;SACxP;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,8PAA8P;SACzQ;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,6LAA6L;SACxM;QACD;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,sJAAsJ;SACjK;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,oNAAoN;SAC/N;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,oUAAoU;SAC/U;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,mOAAmO;SAC9O;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,yDAAyD;KACjE;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,QAAQ;YACvB,OAAO,EAAE,+EAA+E;SACzF;QACD,QAAQ,EAAE;YACR,iIAAiI;YACjI,uJAAuJ;YACvJ,uLAAuL;YACvL,mMAAmM;SACpM;KACF;IACD,cAAc,EAAE;QACd,+SAA+S;KAChT;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}
+{"version":3,"file":"fgets.js","sourceRoot":"","sources":["../../../src/generated/builtins/fgets.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,OAAO;QACP,WAAW;QACX,YAAY;QACZ,SAAS;KACV;IACD,SAAS,EAAE,2EAA2E;IACtF,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,gHAAgH;KAC1H;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;KAC/C;IACD,aAAa,EAAE,sSAAsS;IACrT,WAAW,EAAE;QACX,4NAA4N;QAC5N,gSAAgS;QAChS,4PAA4P;QAC5P,mIAAmI;QACnI,8LAA8L;KAC/L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,mMAAmM;YAC5M,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,6MAA6M;YACtN,QAAQ,EAAE,wDAAwD;SACnE;QACD;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,oRAAoR;YAC7R,QAAQ,EAAE,4DAA4D;SACvE;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,uNAAuN;YAChO,QAAQ,EAAE,2DAA2D;SACtE;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,yQAAyQ;YAClR,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,mQAAmQ;YAC5Q,QAAQ,EAAE,4EAA4E;SACvF;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,8LAA8L;SACzM;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,2JAA2J;SACtK;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,oRAAoR;SAC/R;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,6OAA6O;SACxP;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,8PAA8P;SACzQ;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,6LAA6L;SACxM;QACD;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,sJAAsJ;SACjK;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,oNAAoN;SAC/N;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,oUAAoU;SAC/U;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,mOAAmO;SAC9O;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,yDAAyD;KACjE;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,QAAQ;YACvB,OAAO,EAAE,+EAA+E;SACzF;QACD,QAAQ,EAAE;YACR,iIAAiI;YACjI,uJAAuJ;YACvJ,uLAAuL;YACvL,mMAAmM;SACpM;KACF;IACD,cAAc,EAAE;QACd,+SAA+S;KAChT;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/impulse.js

@@ -0,0 +1,123 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "impulse",
+    "category": "control",
+    "keywords": [
+        "impulse",
+        "impulse response",
+        "control system",
+        "transfer function",
+        "tf"
+    ],
+    "summary": "Compute or plot the impulse response of supported dynamic system models.",
+    "references": [
+        "title: \"MATLAB impulse documentation\"",
+        "title: \"Octave control package impulse documentation\""
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`impulse` evaluates host-side control-system metadata and returns host-resident response vectors."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline",
+        "notes": "`impulse` simulates a dynamic system response and terminates fusion chains."
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::control::impulse::tests",
+        "integration": "crates/runmat-vm/tests/control.rs"
+    },
+    "description": "`impulse(sys)` computes the impulse response for real, strictly proper, scalar-input scalar-output `tf` objects. With output arguments it returns numeric response data; when called in a no-output context and plotting is available, it plots the response.",
+    "behaviors": [
+        "Supports real SISO `tf` objects created by `tf(num, den)` or `tf(num, den, Ts)`.",
+        "`impulse(sys)` uses a deterministic default time vector.",
+        "`impulse(sys, tFinal)` generates a deterministic time vector from zero to `tFinal`.",
+        "`impulse(sys, t)` respects an explicit real, finite, non-negative, strictly increasing time vector.",
+        "`[y, t] = impulse(...)` returns `y` and `t` as `N x 1` column vectors for supported SISO systems.",
+        "Continuous-time responses are evaluated from a controllable canonical state-space realization.",
+        "Discrete-time responses respect MATLAB's unit-area impulse convention: the input pulse has height `1/Ts`, and time vectors must use integer multiples of `Ts`.",
+        "Unsupported model classes, delays, complex coefficients, static gains, and non-strictly-proper transfer functions raise clear diagnostics."
+    ],
+    "examples": [
+        {
+            "description": "Compute a first-order impulse response",
+            "input": "H = tf(20, [1 5]);\nt = 0:0.1:1;\n[y, tout] = impulse(H, t);",
+            "output": "y and tout are column vectors."
+        },
+        {
+            "description": "Plot an impulse response",
+            "input": "H = tf(1, [1 3 2]);\nimpulse(H);"
+        },
+        {
+            "description": "Discrete-time impulse response",
+            "input": "H = tf(1, [1 -0.5], 0.1);\n[y, t] = impulse(H, 0:0.1:0.5);"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `impulse` support MIMO systems?",
+            "answer": "Not yet. The current implementation supports real SISO `tf` objects. Broader model-family and MIMO support is tracked separately."
+        },
+        {
+            "question": "Why are non-strictly-proper transfer functions rejected?",
+            "answer": "Those systems include a direct impulse term that is not represented as a finite numeric response vector in the current runtime model."
+        },
+        {
+            "question": "Can I use state-space or zero-pole-gain models?",
+            "answer": "Not yet. `ss`, `zpk`, `frd`, model arrays, and identified-system families are outside this first implementation."
+        }
+    ],
+    "links": [
+        {
+            "label": "tf",
+            "url": "./tf"
+        },
+        {
+            "label": "plot",
+            "url": "./plot"
+        },
+        {
+            "label": "stem",
+            "url": "./stem"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/control/impulse.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/impulse.rs"
+    },
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "impulse(sys)\ny = impulse(sys)\n[y, t] = impulse(sys)\n[y, t] = impulse(sys, tFinal)\n[y, t] = impulse(sys, t)",
+            "output": "Response data is returned when outputs are requested; otherwise a plot is produced when plotting support is available."
+        },
+        "points": [
+            "`sys` must currently be a real, strictly proper SISO `tf` object.",
+            "`tFinal` must be a finite non-negative scalar.",
+            "`t` must be a real vector of finite non-negative strictly increasing times. For discrete systems, values must be integer multiples of `sys.Ts`."
+        ]
+    },
+    "validation": {
+        "summary": "`impulse` validates the model class, coefficient type and shape, delay properties, strict properness, sample time, and time vector before simulation. Tests cover SISO continuous response values, discrete response values, explicit time input, multi-output shapes, and representative diagnostics.",
+        "implementation": {
+            "label": "`crates/runmat-runtime/src/builtins/control/impulse.rs`",
+            "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/impulse.rs"
+        }
+    },
+    "gpu_residency": "`impulse` returns host-resident response vectors. It does not preserve gpuArray residency.",
+    "key": "impulse",
+    "slug": "impulse",
+    "aliases": [],
+    "categoryPath": [
+        "control"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=impulse.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"impulse.js","sourceRoot":"","sources":["../../../src/generated/builtins/impulse.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE;QACV,SAAS;QACT,kBAAkB;QAClB,gBAAgB;QAChB,mBAAmB;QACnB,IAAI;KACL;IACD,SAAS,EAAE,0EAA0E;IACrF,YAAY,EAAE;QACZ,yCAAyC;QACzC,yDAAyD;KAC1D;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,mGAAmG;KAC7G;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,6EAA6E;KACvF;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,mCAAmC;QAC3C,aAAa,EAAE,mCAAmC;KACnD;IACD,aAAa,EAAE,+PAA+P;IAC9Q,WAAW,EAAE;QACX,kFAAkF;QAClF,0DAA0D;QAC1D,qFAAqF;QACrF,qGAAqG;QACrG,mGAAmG;QACnG,gGAAgG;QAChG,gKAAgK;QAChK,4IAA4I;KAC7I;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,8DAA8D;YACvE,QAAQ,EAAE,gCAAgC;SAC3C;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,kCAAkC;SAC5C;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,4DAA4D;SACtE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,mIAAmI;SAC9I;QACD;YACE,UAAU,EAAE,0DAA0D;YACtE,QAAQ,EAAE,uIAAuI;SAClJ;QACD;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,kHAAkH;SAC7H;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,sGAAsG;KAC9G;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,gHAAgH;YACzH,QAAQ,EAAE,wHAAwH;SACnI;QACD,QAAQ,EAAE;YACR,mEAAmE;YACnE,gDAAgD;YAChD,iJAAiJ;SAClJ;KACF;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,wSAAwS;QACnT,gBAAgB,EAAE;YAChB,OAAO,EAAE,yDAAyD;YAClE,KAAK,EAAE,sGAAsG;SAC9G;KACF;IACD,eAAe,EAAE,4FAA4F;IAC7G,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;KACV;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,EAs5PjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAiZ9D,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,EA47PjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAmZ9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -2046,6 +2046,25 @@ export const builtinManifest = [
         "summary": "Shift zero-frequency components to the center of a spectrum.",
         "exampleCount": 5
     },
+    {
+        "key": "fgetl",
+        "title": "fgetl",
+        "slug": "fgetl",
+        "aliases": [],
+        "category": "io/filetext",
+        "categoryPath": [
+            "io",
+            "filetext"
+        ],
+        "keywords": [
+            "fgetl",
+            "text file",
+            "line input",
+            "newline"
+        ],
+        "summary": "Read the next line from a file, removing newline characters from the result.",
+        "exampleCount": 4
+    },
     {
         "key": "fgets",
         "title": "fgets",
@@ -3301,6 +3320,25 @@ export const builtinManifest = [
         "summary": "Filter images or N-D arrays with correlation/convolution kernels and configurable padding.",
         "exampleCount": 5
     },
+    {
+        "key": "impulse",
+        "title": "impulse",
+        "slug": "impulse",
+        "aliases": [],
+        "category": "control",
+        "categoryPath": [
+            "control"
+        ],
+        "keywords": [
+            "impulse",
+            "impulse response",
+            "control system",
+            "transfer function",
+            "tf"
+        ],
+        "summary": "Compute or plot the impulse response of supported dynamic system models.",
+        "exampleCount": 3
+    },
     {
         "key": "imread",
         "title": "imread",
@@ -8189,6 +8227,7 @@ export const builtinDocLoaders = {
     "fft": () => import("./builtins/fft.js").then((mod) => mod.default),
     "fft2": () => import("./builtins/fft2.js").then((mod) => mod.default),
     "fftshift": () => import("./builtins/fftshift.js").then((mod) => mod.default),
+    "fgetl": () => import("./builtins/fgetl.js").then((mod) => mod.default),
     "fgets": () => import("./builtins/fgets.js").then((mod) => mod.default),
     "fieldnames": () => import("./builtins/fieldnames.js").then((mod) => mod.default),
     "figure": () => import("./builtins/figure.js").then((mod) => mod.default),
@@ -8251,6 +8290,7 @@ export const builtinDocLoaders = {
     "image": () => import("./builtins/image.js").then((mod) => mod.default),
     "imagesc": () => import("./builtins/imagesc.js").then((mod) => mod.default),
     "imfilter": () => import("./builtins/imfilter.js").then((mod) => mod.default),
+    "impulse": () => import("./builtins/impulse.js").then((mod) => mod.default),
     "imread": () => import("./builtins/imread.js").then((mod) => mod.default),
     "imshow": () => import("./builtins/imshow.js").then((mod) => mod.default),
     "ind2rgb": () => import("./builtins/ind2rgb.js").then((mod) => mod.default),