runmat 0.3.5 → 0.4.0

package/dist/generated/builtins/repmat.js

@@ -0,0 +1,205 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "repmat",
+    "category": "array/shape",
+    "keywords": [
+        "repmat",
+        "tile",
+        "replicate",
+        "array",
+        "gpu"
+    ],
+    "summary": "Replicate arrays by tiling an input across one or more dimensions.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "Uses provider tiling hooks when available; otherwise gathers to host memory and re-uploads to preserve GPU residency."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::array::shape::repmat::tests",
+        "integration": "builtins::array::shape::repmat::tests::repmat_gpu_roundtrip"
+    },
+    "description": "`repmat(A, reps)` tiles the array `A` so that it repeats according to `reps`. RunMat mirrors MATLAB semantics, supporting scalars, matrices, tensors, logical, string, char, cell, and GPU-resident arrays.",
+    "behaviors": [
+        "`repmat(A, m, n)` or `repmat(A, [m n])` repeats `A` `m` times along rows and `n` times along columns.",
+        "A size vector `[r1 r2 … rN]` can be given as a row or column; trailing dimensions default to `1`, letting you replicate only the axes you care about.",
+        "Supplying a scalar replication factor (e.g., `repmat(A, k)`) duplicates `A` across every dimension, ensuring the first two dimensions are replicated even when the input is a row vector.",
+        "Zero replication factors produce empty dimensions, e.g., `repmat(A, 0, 3)` yields an empty array with shape `[0 size(A,2)]`.",
+        "Char and cell arrays follow MATLAB by supporting row/column tiling; additional dimensions must be `1`, while numeric, logical, complex, and string arrays support full N-D replication.",
+        "Replication factors must be finite, non-negative integers; RunMat raises descriptive errors for negative, fractional, or excessively large sizes.",
+        "GPU arrays remain on the device when the acceleration provider implements the tiling hook; otherwise, RunMat gathers to host memory, tiles in software, and re-uploads the replicated tensor so downstream GPU work keeps residency."
+    ],
+    "examples": [
+        {
+            "description": "Tiling a matrix across rows and columns",
+            "input": "A = [1 2; 3 4];\nB = repmat(A, 2, 3)",
+            "output": "B =\n     1     2     1     2     1     2\n     3     4     3     4     3     4\n     1     2     1     2     1     2\n     3     4     3     4     3     4"
+        },
+        {
+            "description": "Using a scalar replication factor",
+            "input": "row = 1:4;\nTiled = repmat(row, 3);\nsize(Tiled)",
+            "output": "ans =\n     3    12"
+        },
+        {
+            "description": "Replicating into three dimensions",
+            "input": "A = reshape(1:6, [1 3 2]);\nT = repmat(A, [2 1 4]);\nsize(T)",
+            "output": "ans =\n     2     3     8"
+        },
+        {
+            "description": "Repeating logical masks with zero dimensions",
+            "input": "mask = logical([1 0 1]);\nemptyMask = repmat(mask, 0, 3);\nsize(emptyMask)",
+            "output": "ans =\n     0     3"
+        },
+        {
+            "description": "Replicating string scalars into string arrays",
+            "input": "name = \"runmat\";\nnames = repmat(name, 2, 2)",
+            "output": "names =\n  2x2 string array\n    \"runmat\"    \"runmat\"\n    \"runmat\"    \"runmat\""
+        },
+        {
+            "description": "Replicating data that lives on the GPU",
+            "input": "G = gpuArray(magic(3));\nT = repmat(G, [2 1]);\nresult = gather(T)"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Are replication factors required to be integers?",
+            "answer": "Yes. RunMat follows MATLAB and requires every replication factor to be a non-negative integer. Non-integers raise the descriptive error `repmat: replication factor <n> must be an integer`."
+        },
+        {
+            "question": "What happens when I pass a scalar replication factor?",
+            "answer": "RunMat duplicates the input along every dimension, ensuring at least the first two dimensions receive the factor so matrices tile both rows and columns."
+        },
+        {
+            "question": "Can I request zero replication along a dimension?",
+            "answer": "Yes. Zero factors produce empty dimensions while preserving the remaining sizes, which is useful when constructing placeholder tensors or short-circuiting loops."
+        },
+        {
+            "question": "Does `repmat` work with char, string, or cell arrays?",
+            "answer": "Yes. Char arrays and cell arrays tile across rows and columns (extra dimensions must currently be `1`), while string arrays, numeric tensors, logical arrays, and complex tensors support full N-D replication."
+        },
+        {
+            "question": "How does `repmat` handle GPU tensors today?",
+            "answer": "The runtime asks the provider for a device implementation. If none exists (for example, the in-process test provider), RunMat gathers to the host, tiles there, and re-uploads the result so downstream GPU kernels still see the replicated tensor."
+        },
+        {
+            "question": "Does the result reuse backing storage from the input?",
+            "answer": "No. `repmat` always creates a new array so modifying the result never mutates the original input."
+        },
+        {
+            "question": "Can replication overflow memory?",
+            "answer": "RunMat checks for overflow when multiplying shape dimensions. If the requested size cannot fit in native address space, the builtin raises a descriptive error before attempting allocation."
+        },
+        {
+            "question": "Does `repmat` preserve data ordering?",
+            "answer": "Yes. Column-major ordering is maintained for numeric, logical, string, and complex arrays, while char and cell arrays respect their row-major storage conventions within RunMat."
+        }
+    ],
+    "links": [
+        {
+            "label": "reshape",
+            "url": "./reshape"
+        },
+        {
+            "label": "permute",
+            "url": "./permute"
+        },
+        {
+            "label": "squeeze",
+            "url": "./squeeze"
+        },
+        {
+            "label": "zeros",
+            "url": "./zeros"
+        },
+        {
+            "label": "gpuArray",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        },
+        {
+            "label": "cat",
+            "url": "./cat"
+        },
+        {
+            "label": "circshift",
+            "url": "./circshift"
+        },
+        {
+            "label": "diag",
+            "url": "./diag"
+        },
+        {
+            "label": "flip",
+            "url": "./flip"
+        },
+        {
+            "label": "fliplr",
+            "url": "./fliplr"
+        },
+        {
+            "label": "flipud",
+            "url": "./flipud"
+        },
+        {
+            "label": "horzcat",
+            "url": "./horzcat"
+        },
+        {
+            "label": "ipermute",
+            "url": "./ipermute"
+        },
+        {
+            "label": "kron",
+            "url": "./kron"
+        },
+        {
+            "label": "rot90",
+            "url": "./rot90"
+        },
+        {
+            "label": "tril",
+            "url": "./tril"
+        },
+        {
+            "label": "triu",
+            "url": "./triu"
+        },
+        {
+            "label": "vertcat",
+            "url": "./vertcat"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/array/shape/repmat.rs",
+        "url": "crates/runmat-runtime/src/builtins/array/shape/repmat.rs"
+    },
+    "gpu_residency": "You usually do **not** need to call `gpuArray` directly. RunMat's planner keeps values on the GPU when it detects that further operations benefit from staying there. Explicit `gpuArray` calls remain available for compatibility with legacy MATLAB code and when you want to steer residency manually.",
+    "gpu_behavior": [
+        "RunMat first calls `AccelProvider::repmat`, giving the backend a chance to tile directly on the device. Providers that have not yet implemented this hook fall back to a safe path that gathers the tensor, performs tiling on the host, and uploads the replicated data back to the GPU. The fallback preserves correct behaviour today while enabling backend authors to drop in optimized kernels as they become available."
+    ],
+    "key": "repmat",
+    "slug": "repmat",
+    "categoryPath": [
+        "array",
+        "shape"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=repmat.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repmat.js","sourceRoot":"","sources":["../../../src/generated/builtins/repmat.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,QAAQ;QACR,MAAM;QACN,WAAW;QACX,OAAO;QACP,KAAK;KACN;IACD,SAAS,EAAE,oEAAoE;IAC/E,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,uHAAuH;KACjI;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,uCAAuC;QAC/C,aAAa,EAAE,6DAA6D;KAC7E;IACD,aAAa,EAAE,6MAA6M;IAC5N,WAAW,EAAE;QACX,uGAAuG;QACvG,uJAAuJ;QACvJ,2LAA2L;QAC3L,8HAA8H;QAC9H,yLAAyL;QACzL,mJAAmJ;QACnJ,sOAAsO;KACvO;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,sCAAsC;YAC/C,QAAQ,EAAE,6JAA6J;SACxK;QACD;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,kDAAkD;YAC3D,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,8DAA8D;YACvE,QAAQ,EAAE,2BAA2B;SACtC;QACD;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,4EAA4E;YACrF,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,+CAA+C;YAC9D,OAAO,EAAE,gDAAgD;YACzD,QAAQ,EAAE,yFAAyF;SACpG;QACD;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,oEAAoE;SAC9E;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,kDAAkD;YAC9D,QAAQ,EAAE,8LAA8L;SACzM;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,0JAA0J;SACrK;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,mKAAmK;SAC9K;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,iNAAiN;SAC5N;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,sPAAsP;SACjQ;QACD;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,mGAAmG;SAC9G;QACD;YACE,UAAU,EAAE,kCAAkC;YAC9C,QAAQ,EAAE,8LAA8L;SACzM;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,kLAAkL;SAC7L;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;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,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;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,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,0DAA0D;KAClE;IACD,eAAe,EAAE,2SAA2S;IAC5T,cAAc,EAAE;QACd,gaAAga;KACja;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE;QACd,OAAO;QACP,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/reshape.js

@@ -0,0 +1,178 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "reshape",
+    "category": "array/shape",
+    "keywords": [
+        "reshape",
+        "resize",
+        "dimensions",
+        "gpu",
+        "auto dimension"
+    ],
+    "summary": "Rearrange the dimensions of an array without changing its data.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "Providers update GPU tensor shape metadata in place; no kernels are dispatched."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::array::shape::reshape::tests",
+        "integration": "builtins::array::shape::reshape::tests::reshape_gpu_preserves_handle_shape"
+    },
+    "description": "`reshape(A, newSize)` returns the elements of `A` with a different dimensional layout while preserving column-major ordering. The total number of elements must remain unchanged.",
+    "behaviors": [
+        "Accepts either a size vector `reshape(A, [m n …])` or individual dimensions `reshape(A, m, n, …)`.",
+        "Exactly one dimension may be specified as `[]`; RunMat infers its value from `numel(A)`.",
+        "Dimensions must be nonnegative integers. Zero-sized dimensions are allowed when `numel(A) == 0`.",
+        "Works on numeric, logical, complex, string, char, GPU, and cell arrays (cell/char currently support up to 2-D).",
+        "Reshaping never copies data; it only reinterprets layout metadata.",
+        "Scalar inputs follow MATLAB semantics: `reshape(5, 1, 1)` yields the scalar `5`, while larger shapes return dense arrays."
+    ],
+    "examples": [
+        {
+            "description": "Reshaping a row vector into a matrix",
+            "input": "A = 1:12;\nB = reshape(A, [3, 4])",
+            "output": "B =\n    1     4     7    10\n    2     5     8    11\n    3     6     9    12"
+        },
+        {
+            "description": "Using an automatically inferred dimension",
+            "input": "A = 1:18;\nB = reshape(A, 3, [])",
+            "output": "size(B)  % => [3 6]"
+        },
+        {
+            "description": "Reshaping into three dimensions",
+            "input": "A = 1:24;\nC = reshape(A, [2, 3, 4])",
+            "output": "size(C)  % => [2 3 4]"
+        },
+        {
+            "description": "Reshaping logical arrays preserves type",
+            "input": "mask = logical([1 0 1 0 1 0]);\ngrid = reshape(mask, 2, 3)",
+            "output": "grid =\n     1     1     1\n     0     0     0"
+        },
+        {
+            "description": "Reshaping GPU data without gathering",
+            "input": "G = gpuArray(1:1000);\nH = reshape(G, 10, 100)"
+        },
+        {
+            "description": "Handling zero-sized dimensions",
+            "input": "E = reshape([], 0, 3)",
+            "output": "size(E)  % => [0 3]"
+        }
+    ],
+    "faqs": [],
+    "links": [
+        {
+            "label": "`size`",
+            "url": "./size"
+        },
+        {
+            "label": "`ndims`",
+            "url": "./ndims"
+        },
+        {
+            "label": "`numel`",
+            "url": "./numel"
+        },
+        {
+            "label": "`gpuArray`",
+            "url": "./gpuarray"
+        },
+        {
+            "label": "`gather`",
+            "url": "./gather"
+        },
+        {
+            "label": "cat",
+            "url": "./cat"
+        },
+        {
+            "label": "circshift",
+            "url": "./circshift"
+        },
+        {
+            "label": "diag",
+            "url": "./diag"
+        },
+        {
+            "label": "flip",
+            "url": "./flip"
+        },
+        {
+            "label": "fliplr",
+            "url": "./fliplr"
+        },
+        {
+            "label": "flipud",
+            "url": "./flipud"
+        },
+        {
+            "label": "horzcat",
+            "url": "./horzcat"
+        },
+        {
+            "label": "ipermute",
+            "url": "./ipermute"
+        },
+        {
+            "label": "kron",
+            "url": "./kron"
+        },
+        {
+            "label": "permute",
+            "url": "./permute"
+        },
+        {
+            "label": "repmat",
+            "url": "./repmat"
+        },
+        {
+            "label": "rot90",
+            "url": "./rot90"
+        },
+        {
+            "label": "squeeze",
+            "url": "./squeeze"
+        },
+        {
+            "label": "tril",
+            "url": "./tril"
+        },
+        {
+            "label": "triu",
+            "url": "./triu"
+        },
+        {
+            "label": "vertcat",
+            "url": "./vertcat"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/array/shape/reshape.rs",
+        "url": "crates/runmat-runtime/src/builtins/array/shape/reshape.rs"
+    },
+    "gpu_behavior": [
+        "When the input lives on the GPU, RunMat asks the active acceleration provider to apply the `reshape` hook so the backend can update its residency metadata. No data transfers or kernel launches are needed, so `gpuArray` inputs stay on the device. Providers that do not override the hook fall back to updating the tensor handle directly, which is sufficient for the in-process reference backend."
+    ],
+    "key": "reshape",
+    "slug": "reshape",
+    "categoryPath": [
+        "array",
+        "shape"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=reshape.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reshape.js","sourceRoot":"","sources":["../../../src/generated/builtins/reshape.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE;QACV,SAAS;QACT,QAAQ;QACR,YAAY;QACZ,KAAK;QACL,gBAAgB;KACjB;IACD,SAAS,EAAE,iEAAiE;IAC5E,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iFAAiF;KAC3F;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,4EAA4E;KAC5F;IACD,aAAa,EAAE,mLAAmL;IAClM,WAAW,EAAE;QACX,oGAAoG;QACpG,0FAA0F;QAC1F,kGAAkG;QAClG,iHAAiH;QACjH,oEAAoE;QACpE,2HAA2H;KAC5H;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,mCAAmC;YAC5C,QAAQ,EAAE,gFAAgF;SAC3F;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,kCAAkC;YAC3C,QAAQ,EAAE,qBAAqB;SAChC;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,sCAAsC;YAC/C,QAAQ,EAAE,uBAAuB;SAClC;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,4DAA4D;YACrE,QAAQ,EAAE,gDAAgD;SAC3D;QACD;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,gDAAgD;SAC1D;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,uBAAuB;YAChC,QAAQ,EAAE,qBAAqB;SAChC;KACF;IACD,MAAM,EAAE,EAAE;IACV,OAAO,EAAE;QACP;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,aAAa;SACrB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,2DAA2D;KACnE;IACD,cAAc,EAAE;QACd,2YAA2Y;KAC5Y;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,cAAc,EAAE;QACd,OAAO;QACP,OAAO;KACR;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/rmdir.js

@@ -0,0 +1,215 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "rmdir",
+    "category": "io/repl_fs",
+    "keywords": [
+        "rmdir",
+        "remove directory",
+        "delete folder",
+        "filesystem",
+        "status",
+        "message",
+        "messageid",
+        "recursive"
+    ],
+    "summary": "Remove folders with MATLAB-compatible status, message, and message ID outputs.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/rmdir.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Runs entirely on the CPU. When path inputs or flags reside on the GPU, RunMat gathers them to host memory before removing directories."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::repl_fs::rmdir::tests",
+        "integration": "builtins::io::repl_fs::rmdir::tests::rmdir_recursive_removes_contents"
+    },
+    "description": "`rmdir` removes folders from the filesystem. Like MATLAB, it can optionally delete the folder's contents when you pass the `'s'` flag and returns diagnostic status information instead of throwing exceptions.",
+    "behaviors": [
+        "`status = rmdir(folder)` deletes `folder` only when it exists, is a directory, and is empty. Status outputs are `double` scalars (`1` for success, `0` for failure).",
+        "`[status, message, messageID] = rmdir(folder)` returns the diagnostic message and MATLAB-style message identifier. Successful deletions populate both outputs with empty character arrays (`1×0`).",
+        "`rmdir(folder, 's')` removes the folder and all descendants recursively. The flag is case-insensitive and accepts either a char vector or a string scalar with the text `\"s\"`.",
+        "Passing a path that does not exist or that resolves to a file returns `status = 0` together with descriptive diagnostics. Paths are resolved relative to the current working directory and expand a leading `~` into the user's home directory.",
+        "Invalid inputs—including numeric arrays, logical values, multi-element string arrays, or empty character vectors—raise MATLAB-style errors before any filesystem work occurs.",
+        "`rmdir` automatically gathers GPU-resident path strings (for example, `gpuArray(\"logs\")`) to host memory before evaluating the filesystem operation. There is no device-side acceleration."
+    ],
+    "examples": [
+        {
+            "description": "Remove An Empty Folder",
+            "input": "mkdir(\"scratch\");\nstatus = rmdir(\"scratch\")",
+            "output": "status =\n     1"
+        },
+        {
+            "description": "Remove A Folder And Its Contents",
+            "input": "mkdir(\"data/project\");\nfid = fopen(fullfile(\"data/project\", \"notes.txt\"), \"w\");\nfprintf(fid, \"Draft notes\");\nfclose(fid);\nstatus = rmdir(\"data\", \"s\")",
+            "output": "status =\n     1"
+        },
+        {
+            "description": "Handle A Missing Folder Gracefully",
+            "input": "[status, message, messageID] = rmdir(\"not-here\")",
+            "output": "status =\n     0\nmessage =\nFolder \"not-here\" does not exist.\nmessageID =\nRunMat:RMDIR:DirectoryNotFound"
+        },
+        {
+            "description": "Detect That A Folder Is Not Empty Without The 's' Flag",
+            "input": "mkdir(\"logs\");\nfid = fopen(fullfile(\"logs\", \"today.log\"), \"w\");\nfprintf(fid, \"Log entry\");\nfclose(fid);\n[status, message, messageID] = rmdir(\"logs\")",
+            "output": "status =\n     0\nmessage =\nCannot remove folder \"logs\": directory is not empty.\nmessageID =\nRunMat:RMDIR:DirectoryNotEmpty"
+        },
+        {
+            "description": "Remove A Directory Specified As A String Scalar On The GPU",
+            "input": "mkdir(\"gpu-folder\");\nstatus = rmdir(gpuArray(\"gpu-folder\"))",
+            "output": "status =\n     1"
+        },
+        {
+            "description": "Capture Status And Message Outputs",
+            "input": "mkdir(\"reports\");\n[status, message, messageID] = rmdir(\"reports\")",
+            "output": "status =\n     1\nmessage =\n\nmessageID ="
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What status codes does `rmdir` return?",
+            "answer": "`1` means the folder was removed (or already absent after a recursive call), while `0` means the folder could not be removed."
+        },
+        {
+            "question": "Does `rmdir` throw exceptions?",
+            "answer": "Only invalid inputs raise errors. Filesystem failures surface through the status, message, and message ID outputs."
+        },
+        {
+            "question": "How do I remove non-empty folders?",
+            "answer": "Pass the `'s'` flag (for example, `rmdir(\"folder\", \"s\")`). Without it, `rmdir` refuses to delete directories that contain files or subfolders."
+        },
+        {
+            "question": "Is the `'s'` flag case-sensitive?",
+            "answer": "No. Use `'s'` or `'S'`, supplied as either a char vector or a string scalar with a single element."
+        },
+        {
+            "question": "Can I target files instead of folders?",
+            "answer": "No. Passing a file path returns `status = 0` with the message ID `RunMat:RMDIR:NotADirectory`."
+        },
+        {
+            "question": "How are paths resolved?",
+            "answer": "Relative paths are resolved against the current working folder (`pwd`). Leading `~` segments expand to the user's home directory on each platform."
+        },
+        {
+            "question": "Does `rmdir` require GPU acceleration?",
+            "answer": "No. The builtin executes on the host. If an argument resides on the GPU, RunMat gathers it automatically before touching the filesystem."
+        },
+        {
+            "question": "What happens if the folder is already missing when I pass `'s'`?",
+            "answer": "The function reports `status = 0` and the message ID `RunMat:RMDIR:DirectoryNotFound`; it never creates folders."
+        },
+        {
+            "question": "Can I remove folders using UNC paths or drive letters on Windows?",
+            "answer": "Yes. The builtin forwards the path to the operating system exactly as MATLAB does."
+        },
+        {
+            "question": "Why are the message outputs character arrays instead of strings?",
+            "answer": "MATLAB returns char arrays for compatibility. Wrap them with `string(message)` if you prefer string scalars."
+        }
+    ],
+    "links": [
+        {
+            "label": "mkdir",
+            "url": "./mkdir"
+        },
+        {
+            "label": "ls",
+            "url": "./ls"
+        },
+        {
+            "label": "dir",
+            "url": "./dir"
+        },
+        {
+            "label": "pwd",
+            "url": "./pwd"
+        },
+        {
+            "label": "addpath",
+            "url": "./addpath"
+        },
+        {
+            "label": "cd",
+            "url": "./cd"
+        },
+        {
+            "label": "copyfile",
+            "url": "./copyfile"
+        },
+        {
+            "label": "delete",
+            "url": "./delete"
+        },
+        {
+            "label": "exist",
+            "url": "./exist"
+        },
+        {
+            "label": "fullfile",
+            "url": "./fullfile"
+        },
+        {
+            "label": "genpath",
+            "url": "./genpath"
+        },
+        {
+            "label": "getenv",
+            "url": "./getenv"
+        },
+        {
+            "label": "movefile",
+            "url": "./movefile"
+        },
+        {
+            "label": "path",
+            "url": "./path"
+        },
+        {
+            "label": "rmpath",
+            "url": "./rmpath"
+        },
+        {
+            "label": "savepath",
+            "url": "./savepath"
+        },
+        {
+            "label": "setenv",
+            "url": "./setenv"
+        },
+        {
+            "label": "tempdir",
+            "url": "./tempdir"
+        },
+        {
+            "label": "tempname",
+            "url": "./tempname"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/repl_fs/rmdir.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/repl_fs/rmdir.rs"
+    },
+    "gpu_residency": "No. `rmdir` always executes on the host CPU, therefore placing arguments on the GPU offers no benefit. If a path value is already wrapped in `gpuArray`, RunMat gathers it automatically before accessing the filesystem so existing scripts continue to work unchanged.",
+    "gpu_behavior": [
+        "`rmdir` performs host-side filesystem operations. When acceleration providers are active, RunMat first gathers any GPU-resident arguments, performs the removal on the CPU, and returns host-resident outputs. Providers do not expose special hooks for this builtin, so GPU execution is not applicable."
+    ],
+    "key": "rmdir",
+    "slug": "rmdir",
+    "categoryPath": [
+        "io",
+        "repl_fs"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=rmdir.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rmdir.js","sourceRoot":"","sources":["../../../src/generated/builtins/rmdir.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE;QACV,OAAO;QACP,kBAAkB;QAClB,eAAe;QACf,YAAY;QACZ,QAAQ;QACR,SAAS;QACT,WAAW;QACX,WAAW;KACZ;IACD,SAAS,EAAE,gFAAgF;IAC3F,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,wIAAwI;KAClJ;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,qCAAqC;QAC7C,aAAa,EAAE,uEAAuE;KACvF;IACD,aAAa,EAAE,iNAAiN;IAChO,WAAW,EAAE;QACX,sKAAsK;QACtK,oMAAoM;QACpM,kLAAkL;QAClL,iPAAiP;QACjP,+KAA+K;QAC/K,8LAA8L;KAC/L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,kDAAkD;YAC3D,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,yKAAyK;YAClL,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,+GAA+G;SAC1H;QACD;YACE,aAAa,EAAE,wDAAwD;YACvE,OAAO,EAAE,sKAAsK;YAC/K,QAAQ,EAAE,kIAAkI;SAC7I;QACD;YACE,aAAa,EAAE,4DAA4D;YAC3E,OAAO,EAAE,kEAAkE;YAC3E,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,wEAAwE;YACjF,QAAQ,EAAE,4CAA4C;SACvD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,+HAA+H;SAC1I;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,oHAAoH;SAC/H;QACD;YACE,UAAU,EAAE,oCAAoC;YAChD,QAAQ,EAAE,oJAAoJ;SAC/J;QACD;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,oGAAoG;SAC/G;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,gGAAgG;SAC3G;QACD;YACE,UAAU,EAAE,yBAAyB;YACrC,QAAQ,EAAE,oJAAoJ;SAC/J;QACD;YACE,UAAU,EAAE,wCAAwC;YACpD,QAAQ,EAAE,0IAA0I;SACrJ;QACD;YACE,UAAU,EAAE,kEAAkE;YAC9E,QAAQ,EAAE,kHAAkH;SAC7H;QACD;YACE,UAAU,EAAE,mEAAmE;YAC/E,QAAQ,EAAE,oFAAoF;SAC/F;QACD;YACE,UAAU,EAAE,kEAAkE;YAC9E,QAAQ,EAAE,8GAA8G;SACzH;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,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,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,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;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,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,uGAAuG;KAC/G;IACD,eAAe,EAAE,0QAA0Q;IAC3R,cAAc,EAAE;QACd,4SAA4S;KAC7S;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,cAAc,EAAE;QACd,IAAI;QACJ,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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