runmat 0.5.7-dev.2 → 0.5.7-dev.4

package/dist/generated/builtins/wordcloud.js

@@ -0,0 +1,110 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "wordcloud",
+    "category": "plotting",
+    "keywords": [
+        "wordcloud",
+        "WordCloudChart",
+        "text analytics",
+        "tokenizedDocument",
+        "bagOfWords",
+        "bagOfNgrams",
+        "categorical"
+    ],
+    "summary": "Create a word cloud chart from text, tokenized documents, bag models, categorical arrays, tables, or word-size data.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`wordcloud` is a chart/annotation rendering sink. Text, bag, table, and categorical inputs are materialized on the host to compute word labels and sizes, then rendered through the plotting annotation path."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::wordcloud::tests"
+    },
+    "description": "`wordcloud` creates a `WordCloudChart` compatibility handle. RunMat supports the common MATLAB forms for raw text, `tokenizedDocument`, `bagOfWords`, `bagOfNgrams`, `categorical`, `words` with `sizeData`, and table word/size variables.",
+    "behaviors": [
+        "`wordcloud(str)` tokenizes string, character, string-array, or cellstr input, removes common English stop words, counts words, and renders the most frequent words.",
+        "`wordcloud(documents)` accepts RunMat `tokenizedDocument` compatibility objects and counts tokens from their `Documents` property.",
+        "`wordcloud(bag)` accepts RunMat `bagOfWords` and `bagOfNgrams` compatibility objects and sums each column of `Counts`; n-gram labels are joined with spaces.",
+        "`wordcloud(words,sizeData)` accepts a word vector and a numeric vector with the same element count. Duplicate words are aggregated and zero-sized entries are omitted.",
+        "`wordcloud(tbl,wordVar,sizeVar)` accepts RunMat table/timetable compatibility objects where `wordVar` and `sizeVar` are variable names or scalar variable indices.",
+        "`wordcloud(C)` accepts RunMat categorical compatibility objects and uses category counts as word sizes.",
+        "`wordcloud(parent,...)` accepts a leading RunMat figure parent and uses that figure's active axes for rendering. Encoded axes handles are also accepted as a RunMat plotting compatibility extension.",
+        "Supported name-value options are `MaxDisplayWords`, `Color`, `HighlightColor`, `Shape` (`oval` or `rectangle`), `LayoutNum`, `SizePower`, `Title`, `TitleFontName`, `Visible`, `FontName`, `Box`, `Units`, `Position`, `HandleVisibility`, `DisplayName`, and `Tag`.",
+        "`MaxDisplayWords` is capped at 1000 rendered annotation slots in RunMat to keep chart creation bounded.",
+        "`get` supports `Type`, `Parent`, `Children`, `WordData`, `SizeData`, `WordVariable`, `SizeVariable`, `SourceTable`, `MaxDisplayWords`, `Color`, `HighlightColor`, `Shape`, `LayoutNum`, `SizePower`, `Title`, `TitleFontName`, `FontName`, `Visible`, `Box`, `Units`, `Position`, `HandleVisibility`, `DisplayName`, and `Tag`.",
+        "`set` supports `WordData`, `SizeData`, `MaxDisplayWords`, `Color`, `HighlightColor`, `Shape`, `LayoutNum`, `SizePower`, `Title`, `TitleFontName`, `FontName`, `Visible`, `Box`, `Units`, `Position`, `HandleVisibility`, `DisplayName`, and `Tag`; `WordData` and `SizeData` assignments must preserve matching lengths.",
+        "RunMat uses a deterministic annotation layout rather than MATLAB's exact proprietary word-placement algorithm. `FontName`, `TitleFontName`, `Units`, `Position`, and `HandleVisibility` are stored as chart metadata; the current plotting renderer does not yet expose a separate chart-container layout or font-family path. LDA topic word clouds remain unsupported until `ldaModel` compatibility exists and raise an explicit tracked-gap error."
+    ],
+    "examples": [
+        {
+            "description": "Create a word cloud from text",
+            "input": "txt = \"runmat computes fast math and runmat plots math\";\nwc = wordcloud(txt);"
+        },
+        {
+            "description": "Create a word cloud from explicit word sizes",
+            "input": "words = [\"alpha\" \"beta\" \"gamma\"];\nsizes = [5 9 2];\nwc = wordcloud(words, sizes, 'MaxDisplayWords', 2, 'Shape', 'rectangle');\nget(wc, 'WordData')"
+        },
+        {
+            "description": "Create a word cloud from a table",
+            "input": "tbl = table([\"alpha\";\"beta\"], [10;4], 'VariableNames', {'Word','Count'});\nwc = wordcloud(tbl, 'Word', 'Count');"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does wordcloud return a graphics object?",
+            "answer": "Yes. RunMat returns a first-class `wordcloud` chart handle with readable and mutable chart properties through `get` and `set`."
+        },
+        {
+            "question": "Does RunMat match MATLAB's exact word placement?",
+            "answer": "No. RunMat computes MATLAB-compatible word labels, sizes, and chart properties, then uses a deterministic annotation layout. Exact MATLAB layout parity remains tracked by the Text Analytics umbrella."
+        },
+        {
+            "question": "Can wordcloud preserve gpuArray residency?",
+            "answer": "No. Word clouds are text/chart rendering sinks over host text, table, categorical, and bag metadata, so provider-resident numeric kernels are not applicable to this slice."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        },
+        {
+            "label": "bagOfWords",
+            "url": "./bagOfWords"
+        },
+        {
+            "label": "bagOfNgrams",
+            "url": "./bagOfNgrams"
+        },
+        {
+            "label": "get",
+            "url": "./get"
+        },
+        {
+            "label": "set",
+            "url": "./set"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/wordcloud.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/wordcloud.rs"
+    },
+    "key": "wordcloud",
+    "slug": "wordcloud",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=wordcloud.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wordcloud.js","sourceRoot":"","sources":["../../../src/generated/builtins/wordcloud.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,WAAW;QACX,gBAAgB;QAChB,gBAAgB;QAChB,mBAAmB;QACnB,YAAY;QACZ,aAAa;QACb,aAAa;KACd;IACD,SAAS,EAAE,sHAAsH;IACjI,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,+MAA+M;KACzN;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,6OAA6O;IAC5P,WAAW,EAAE;QACX,qKAAqK;QACrK,oIAAoI;QACpI,8JAA8J;QAC9J,wKAAwK;QACxK,oKAAoK;QACpK,yGAAyG;QACzG,uMAAuM;QACvM,sQAAsQ;QACtQ,yGAAyG;QACzG,iUAAiU;QACjU,0TAA0T;QAC1T,wbAAwb;KACzb;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,kFAAkF;SAC5F;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,2JAA2J;SACrK;QACD;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,sHAAsH;SAChI;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,gIAAgI;SAC3I;QACD;YACE,UAAU,EAAE,kDAAkD;YAC9D,QAAQ,EAAE,yMAAyM;SACpN;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,6KAA6K;SACxL;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,eAAe;SACvB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,gEAAgE;QACzE,KAAK,EAAE,6GAA6G;KACrH;IACD,KAAK,EAAE,WAAW;IAClB,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/writeWordEmbedding.js

@@ -0,0 +1,115 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "writeWordEmbedding",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "writeWordEmbedding",
+        "wordEmbedding",
+        "text analytics",
+        "word2vec",
+        "write"
+    ],
+    "summary": "Write a word embedding model to a UTF-8 word2vec text file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`writeWordEmbedding` serializes host wordEmbedding metadata and writes a file; it does not use provider kernels."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::strings::text_analytics::embeddings::tests",
+        "integration": null
+    },
+    "description": "`writeWordEmbedding(emb, filename)` writes a RunMat `wordEmbedding` compatibility object to a UTF-8 text file in word2vec text format.",
+    "behaviors": [
+        "`emb` must be a `wordEmbedding` compatibility object with `Dimension`, `Vocabulary`, and vector storage created by `readWordEmbedding`, `trainWordEmbedding`, or `fastTextWordEmbedding`.",
+        "`filename` may be a string scalar, character vector, or a 1-by-1 cell array containing a character vector.",
+        "The output file starts with a `numWords dimension` header followed by one row per vocabulary word and its vector values.",
+        "The target file is created or overwritten. Parent directories must already exist.",
+        "Vocabulary entries containing whitespace and non-finite vector values are rejected because word2vec text rows cannot represent them unambiguously.",
+        "Binary word2vec output, zip output, append mode, and format-selection options are not part of MATLAB's documented `writeWordEmbedding` syntax and are not accepted."
+    ],
+    "examples": [
+        {
+            "description": "Write a trained embedding",
+            "input": "documents = tokenizedDocument([\"red blue red\"; \"green blue\"]);\nemb = trainWordEmbedding(documents, 'Dimension', 8, 'MinCount', 1);\nwriteWordEmbedding(emb, \"colors.vec\")",
+            "output": "`colors.vec` contains UTF-8 word2vec text embedding data."
+        },
+        {
+            "description": "Round-trip an embedding file",
+            "input": "writeWordEmbedding(emb, \"model.vec\");\ncopy = readWordEmbedding(\"model.vec\");\ncopy.Dimension",
+            "output": "`copy` is a `wordEmbedding` compatibility object with the same vocabulary and vectors."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What file format does `writeWordEmbedding` use?",
+            "answer": "It writes UTF-8 word2vec text format with a header row and one word-vector row per vocabulary entry."
+        },
+        {
+            "question": "Does `writeWordEmbedding` create folders?",
+            "answer": "No. Create the parent folder first with `mkdir` if needed."
+        },
+        {
+            "question": "Does `writeWordEmbedding` execute on the GPU?",
+            "answer": "No. It is host object serialization and file I/O."
+        }
+    ],
+    "links": [
+        {
+            "label": "readWordEmbedding",
+            "url": "./readWordEmbedding"
+        },
+        {
+            "label": "trainWordEmbedding",
+            "url": "./trainWordEmbedding"
+        },
+        {
+            "label": "word2vec",
+            "url": "./word2vec"
+        },
+        {
+            "label": "vec2word",
+            "url": "./vec2word"
+        },
+        {
+            "label": "doc2sequence",
+            "url": "./doc2sequence"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported form",
+            "input": "writeWordEmbedding(emb, filename)",
+            "output": "The embedding is written to `filename`."
+        },
+        "points": [
+            "`emb` must be a RunMat `wordEmbedding` object.",
+            "`filename` must identify a writable host filesystem path as a scalar text value or 1-by-1 cell containing a character vector.",
+            "The output text is UTF-8 and can be read back with `readWordEmbedding`."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/embeddings.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/embeddings.rs"
+    },
+    "gpu_residency": "`writeWordEmbedding` is a file-I/O sink. Any GPU-resident filename input is gathered before serialization; wordEmbedding objects are host metadata objects, and no provider kernels are launched.",
+    "key": "writewordembedding",
+    "slug": "writewordembedding",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=writeWordEmbedding.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"writeWordEmbedding.js","sourceRoot":"","sources":["../../../src/generated/builtins/writeWordEmbedding.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,oBAAoB;IAC7B,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,oBAAoB;QACpB,eAAe;QACf,gBAAgB;QAChB,UAAU;QACV,OAAO;KACR;IACD,SAAS,EAAE,6DAA6D;IACxE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,kHAAkH;KAC5H;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,sDAAsD;QAC9D,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,wIAAwI;IACvJ,WAAW,EAAE;QACX,2LAA2L;QAC3L,4GAA4G;QAC5G,0HAA0H;QAC1H,mFAAmF;QACnF,oJAAoJ;QACpJ,qKAAqK;KACtK;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,kLAAkL;YAC3L,QAAQ,EAAE,2DAA2D;SACtE;QACD;YACE,aAAa,EAAE,8BAA8B;YAC7C,OAAO,EAAE,mGAAmG;YAC5G,QAAQ,EAAE,wFAAwF;SACnG;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,sGAAsG;SACjH;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,4DAA4D;SACvE;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,mDAAmD;SAC9D;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,sBAAsB;SAC9B;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE,mCAAmC;YAC5C,QAAQ,EAAE,yCAAyC;SACpD;QACD,QAAQ,EAAE;YACR,gDAAgD;YAChD,+HAA+H;YAC/H,yEAAyE;SAC1E;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2EAA2E;QACpF,KAAK,EAAE,wHAAwH;KAChI;IACD,eAAe,EAAE,mMAAmM;IACpN,KAAK,EAAE,oBAAoB;IAC3B,MAAM,EAAE,oBAAoB;IAC5B,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/writelines.js

@@ -0,0 +1,46 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "writelines",
+    "category": "io/filetext",
+    "keywords": [
+        "writelines"
+    ],
+    "summary": "Write text lines to a file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Host-side compatibility builtin; GPU-resident inputs are gathered before execution."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": null,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::filetext::lines::tests",
+        "integration": null
+    },
+    "description": "Write text lines to a file.",
+    "behaviors": [
+        "Accepts MATLAB text inputs such as string scalars and character row vectors for path, name, or URL arguments where applicable.",
+        "Runs on the host using the active RunMat filesystem, environment, or HTTP abstraction as appropriate.",
+        "Reports MATLAB-style runtime errors for unsupported argument shapes or unavailable host capabilities."
+    ],
+    "examples": [],
+    "faqs": [],
+    "links": [],
+    "key": "writelines",
+    "slug": "writelines",
+    "aliases": [],
+    "categoryPath": [
+        "io",
+        "filetext"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=writelines.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"writelines.js","sourceRoot":"","sources":["../../../src/generated/builtins/writelines.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,YAAY;IACrB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,YAAY;KACb;IACD,SAAS,EAAE,6BAA6B;IACxC,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,IAAI;QAClB,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,sCAAsC;QAC9C,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,6BAA6B;IAC5C,WAAW,EAAE;QACX,gIAAgI;QAChI,uGAAuG;QACvG,uGAAuG;KACxG;IACD,UAAU,EAAE,EAAE;IACd,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/writetable.js

@@ -0,0 +1,67 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "writetable",
+    "category": "io/tabular",
+    "keywords": [
+        "writetable",
+        "table",
+        "csv",
+        "delimited text",
+        "WriteVariableNames"
+    ],
+    "summary": "Write a table to a delimited text file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Table data is serialized on the host."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::table::tests"
+    },
+    "description": "`writetable(T, filename)` writes table variables to a delimited text file.",
+    "behaviors": [
+        "`\"Delimiter\"` controls the field separator and defaults to comma.",
+        "`\"WriteVariableNames\"` controls header emission and defaults to true.",
+        "Fields containing delimiters, quotes, or newlines are CSV-quoted."
+    ],
+    "examples": [
+        {
+            "description": "Write CSV",
+            "input": "bytes = writetable(T, 'out.csv')",
+            "output": "bytes = number of bytes written"
+        }
+    ],
+    "links": [
+        {
+            "label": "readtable",
+            "url": "./readtable"
+        },
+        {
+            "label": "writetimetable",
+            "url": "./writetimetable"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/table/mod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/table/mod.rs"
+    },
+    "key": "writetable",
+    "slug": "writetable",
+    "aliases": [],
+    "categoryPath": [
+        "io",
+        "tabular"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=writetable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"writetable.js","sourceRoot":"","sources":["../../../src/generated/builtins/writetable.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,YAAY;IACrB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,YAAY;QACZ,OAAO;QACP,KAAK;QACL,gBAAgB;QAChB,oBAAoB;KACrB;IACD,SAAS,EAAE,yCAAyC;IACpD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,uCAAuC;KACjD;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,wBAAwB;KACjC;IACD,aAAa,EAAE,4EAA4E;IAC3F,WAAW,EAAE;QACX,qEAAqE;QACrE,yEAAyE;QACzE,mEAAmE;KACpE;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,WAAW;YAC1B,OAAO,EAAE,kCAAkC;YAC3C,QAAQ,EAAE,iCAAiC;SAC5C;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,kBAAkB;SAC1B;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/writetimetable.js

@@ -0,0 +1,65 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "writetimetable",
+    "category": "io/tabular",
+    "keywords": [
+        "writetimetable",
+        "timetable",
+        "csv",
+        "RowTimes"
+    ],
+    "summary": "Write a timetable to a delimited text file.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Timetable data is serialized on the host."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::table::tests"
+    },
+    "description": "`writetimetable(TT, filename)` writes timetable row times and variables to a delimited text file.",
+    "behaviors": [
+        "Row times are emitted as a leading `Time` field.",
+        "`\"Delimiter\"` and `\"WriteVariableNames\"` are supported."
+    ],
+    "examples": [
+        {
+            "description": "Write timetable",
+            "input": "bytes = writetimetable(TT, 'out.csv')",
+            "output": "bytes = number of bytes written"
+        }
+    ],
+    "links": [
+        {
+            "label": "writetable",
+            "url": "./writetable"
+        },
+        {
+            "label": "readtimetable",
+            "url": "./readtimetable"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/table/mod.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/table/mod.rs"
+    },
+    "key": "writetimetable",
+    "slug": "writetimetable",
+    "aliases": [],
+    "categoryPath": [
+        "io",
+        "tabular"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=writetimetable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"writetimetable.js","sourceRoot":"","sources":["../../../src/generated/builtins/writetimetable.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,gBAAgB;IACzB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,gBAAgB;QAChB,WAAW;QACX,KAAK;QACL,UAAU;KACX;IACD,SAAS,EAAE,6CAA6C;IACxD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,2CAA2C;KACrD;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,wBAAwB;KACjC;IACD,aAAa,EAAE,mGAAmG;IAClH,WAAW,EAAE;QACX,kDAAkD;QAClD,6DAA6D;KAC9D;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,uCAAuC;YAChD,QAAQ,EAAE,iCAAiC;SAC5C;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,cAAc;SACtB;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,iBAAiB;SACzB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/xlswrite.js

@@ -0,0 +1,119 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "xlswrite",
+    "category": "io/tabular",
+    "keywords": [
+        "xlswrite",
+        "xls",
+        "xlsx",
+        "spreadsheet",
+        "excel",
+        "legacy export"
+    ],
+    "summary": "Write numeric, logical, string, character, or cell data to Excel-compatible spreadsheet files.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Spreadsheet files are written on the host. gpuArray inputs are gathered before serialization."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::tabular::xlswrite::tests",
+        "integration": [
+            "builtins::io::tabular::xlswrite::tests::xlswrite_writes_numeric_matrix_with_sheet_and_range",
+            "builtins::io::tabular::xlswrite::tests::xlswrite_preserves_existing_cells_outside_overlay",
+            "builtins::io::tabular::xlswrite::tests::xlswrite_preserves_other_sheets_and_uses_numeric_sheet_ordinal",
+            "runmat-vm/tests/xlswrite.rs"
+        ]
+    },
+    "description": "`xlswrite` provides MATLAB's legacy spreadsheet export forms for older scripts. It writes an OOXML workbook payload for `.xlsx` and legacy `.xls` filenames, accepts worksheet and range selectors, preserves supported cells in workbooks previously created by RunMat `xlswrite`, and returns status/message outputs when requested.",
+    "behaviors": [
+        "`xlswrite(filename, A)` writes `A` to the first worksheet starting at `A1`. If the filename has no extension, `.xlsx` is appended.",
+        "`xlswrite(filename, A, sheet)` selects a worksheet by name or one-based numeric index.",
+        "`xlswrite(filename, A, range)` writes to an A1-style range start such as `\"B2\"` on the default worksheet.",
+        "`xlswrite(filename, A, sheet, range)` combines worksheet and range selection.",
+        "When the destination workbook already exists and was created by RunMat `xlswrite`, `xlswrite` preserves supported existing worksheets and cells outside the overwritten range.",
+        "Existing unmarked Excel workbooks are rejected instead of being flattened into RunMat's minimal workbook representation; this avoids silently discarding formulas, macros, styles, charts, images, or workbook metadata.",
+        "Numeric sheet selectors are one-based worksheet ordinals. Missing ordinal sheets are created as `SheetN` placeholders so later `xlsread(filename, N, ...)` calls address the same worksheet.",
+        "Numeric, sparse, logical, string, character, and heterogeneous cell inputs are supported. Cell contents must be scalar spreadsheet values.",
+        "A1 ranges may use absolute markers such as `$B$2:$C$3`; malformed range endpoints are rejected.",
+        "The legacy `'-basic'` mode flag is accepted as a no-op because RunMat writes spreadsheets directly rather than using Excel COM automation.",
+        "`status = xlswrite(...)` returns true on success. `[status,message] = xlswrite(...)` captures write failures as false plus a diagnostic struct with `message` and `identifier` fields."
+    ],
+    "examples": [
+        {
+            "description": "Write a numeric matrix",
+            "input": "status = xlswrite('measurements.xlsx', [1 2 3; 4 5 6]);"
+        },
+        {
+            "description": "Write to a named worksheet and range",
+            "input": "status = xlswrite('measurements.xlsx', {'Voltage', 1.5, true}, 'Data', 'B2');"
+        },
+        {
+            "description": "Capture a failure message",
+            "input": "[status, message] = xlswrite('out.xlsx', 1+2i);\nif ~status\n    disp(message.message)\nend"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `xlswrite` use Microsoft Excel?",
+            "answer": "No. RunMat writes workbook files directly on the host. The `'-basic'` flag is accepted for compatibility, but COM automation is not used."
+        },
+        {
+            "question": "What happens with `.xls` filenames?",
+            "answer": "RunMat accepts legacy `.xls` filenames and writes the same OOXML workbook payload used for `.xlsx`. This keeps old scripts running in RunMat and remains readable by RunMat's content-based spreadsheet reader."
+        },
+        {
+            "question": "Can `xlswrite` update an existing Excel workbook created elsewhere?",
+            "answer": "No. RunMat rejects unmarked existing workbooks rather than rewriting them as a minimal value-only workbook and losing formulas, macros, formatting, charts, images, comments, or metadata."
+        },
+        {
+            "question": "What should I use for new code?",
+            "answer": "`xlswrite` exists for legacy MATLAB compatibility. For new code, prefer `writematrix`, `writecell`, or table-oriented export APIs where available."
+        }
+    ],
+    "links": [
+        {
+            "label": "xlsread",
+            "url": "./xlsread"
+        },
+        {
+            "label": "writematrix",
+            "url": "./writematrix"
+        },
+        {
+            "label": "writecell",
+            "url": "./writecell"
+        },
+        {
+            "label": "readtable",
+            "url": "./readtable"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/tabular/xlswrite.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/tabular/xlswrite.rs"
+    },
+    "gpu_residency": "`xlswrite` consumes host-side file data. gpuArray inputs are gathered before writing; outputs are CPU-resident status/message values.",
+    "gpu_behavior": [
+        "`xlswrite` performs file I/O and spreadsheet serialization on the CPU. It is not fusible and does not call acceleration provider hooks."
+    ],
+    "key": "xlswrite",
+    "slug": "xlswrite",
+    "aliases": [],
+    "categoryPath": [
+        "io",
+        "tabular"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=xlswrite.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"xlswrite.js","sourceRoot":"","sources":["../../../src/generated/builtins/xlswrite.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,UAAU;QACV,KAAK;QACL,MAAM;QACN,aAAa;QACb,OAAO;QACP,eAAe;KAChB;IACD,SAAS,EAAE,gGAAgG;IAC3G,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,+FAA+F;KACzG;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,wCAAwC;QAChD,aAAa,EAAE;YACb,6FAA6F;YAC7F,2FAA2F;YAC3F,wGAAwG;YACxG,6BAA6B;SAC9B;KACF;IACD,aAAa,EAAE,wUAAwU;IACvV,WAAW,EAAE;QACX,oIAAoI;QACpI,wFAAwF;QACxF,6GAA6G;QAC7G,+EAA+E;QAC/E,gLAAgL;QAChL,0NAA0N;QAC1N,8LAA8L;QAC9L,4IAA4I;QAC5I,iGAAiG;QACjG,4IAA4I;QAC5I,wLAAwL;KACzL;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,yDAAyD;SACnE;QACD;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,+EAA+E;SACzF;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,6FAA6F;SACvG;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,2IAA2I;SACtJ;QACD;YACE,UAAU,EAAE,qCAAqC;YACjD,QAAQ,EAAE,iNAAiN;SAC5N;QACD;YACE,UAAU,EAAE,qEAAqE;YACjF,QAAQ,EAAE,4LAA4L;SACvM;QACD;YACE,UAAU,EAAE,iCAAiC;YAC7C,QAAQ,EAAE,oJAAoJ;SAC/J;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,eAAe;SACvB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;IACD,eAAe,EAAE,uIAAuI;IACxJ,cAAc,EAAE;QACd,yIAAyI;KAC1I;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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