runmat 0.5.7-dev.3 → 0.5.7-dev.4

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

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

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

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

package/dist/generated/builtins/DelaunayTri.js

@@ -0,0 +1,95 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "DelaunayTri",
+    "category": "geometry/triangulation",
+    "keywords": [
+        "DelaunayTri",
+        "delaunay",
+        "triangulation",
+        "geometry",
+        "mesh"
+    ],
+    "summary": "Create a legacy 2-D Delaunay triangulation object.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`DelaunayTri` builds host topology using a combinatorial geometry algorithm. GPU-resident numeric inputs are gathered at the constructor boundary; there is no runmat-accelerate kernel because the result is object topology rather than an elementwise or reduction tensor."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "none"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::geometry::triangulation::tests",
+        "integration": "builtins::plotting::triplot::tests::triplot_accepts_delaunaytri_object"
+    },
+    "description": "`DelaunayTri` creates the legacy MATLAB triangulation object shape for 2-D point inputs. RunMat stores both legacy properties (`X`, `Triangulation`, `Constraints`) and modern triangulation-compatible aliases (`Points`, `ConnectivityList`) so downstream helpers such as `triplot`, `freeBoundary`, `nearestNeighbor`, and `pointLocation` can consume the same object.",
+    "behaviors": [
+        "`DelaunayTri()` returns an empty 2-D triangulation object with 0-by-2 points and 0-by-3 connectivity.",
+        "`DelaunayTri(X)` accepts an N-by-2 finite point matrix and constructs one-based triangle connectivity.",
+        "`DelaunayTri(x, y)` accepts equal-length coordinate vectors.",
+        "Duplicate point coordinates are ignored for triangulation while the public point matrix preserves the supplied rows.",
+        "Nonempty constrained triangulation inputs and 3-D point forms return explicit unsupported-target errors rather than placeholder topology."
+    ],
+    "examples": [
+        {
+            "description": "Create a 2-D triangulation from a point matrix",
+            "input": "X = [0 0; 1 0; 0 1; 1 1];\ndt = DelaunayTri(X);\ntri = dt.Triangulation;"
+        },
+        {
+            "description": "Create from coordinate vectors and plot the mesh",
+            "input": "x = [0 1 0 1];\ny = [0 0 1 1];\ndt = DelaunayTri(x, y);\ntriplot(dt);"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Which DelaunayTri properties are available?",
+            "answer": "RunMat exposes `X`, `Triangulation`, `Constraints`, `Points`, `ConnectivityList`, and `Dimension`."
+        },
+        {
+            "question": "Does RunMat support constrained or 3-D DelaunayTri inputs?",
+            "answer": "Not yet. Those forms fail deterministically with `RunMat:DelaunayTri:Unsupported`."
+        },
+        {
+            "question": "Does DelaunayTri preserve gpuArray residency?",
+            "answer": "No. The constructor gathers numeric inputs because triangulation creates CPU object topology and not a dense numeric GPU result."
+        }
+    ],
+    "links": [
+        {
+            "label": "triplot",
+            "url": "./triplot"
+        },
+        {
+            "label": "freeBoundary",
+            "url": "./freeBoundary"
+        },
+        {
+            "label": "nearestNeighbor",
+            "url": "./nearestNeighbor"
+        },
+        {
+            "label": "pointLocation",
+            "url": "./pointLocation"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/geometry/triangulation.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/geometry/triangulation.rs"
+    },
+    "key": "delaunaytri",
+    "slug": "delaunaytri",
+    "aliases": [],
+    "categoryPath": [
+        "geometry",
+        "triangulation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=DelaunayTri.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DelaunayTri.js","sourceRoot":"","sources":["../../../src/generated/builtins/DelaunayTri.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,aAAa;QACb,UAAU;QACV,eAAe;QACf,UAAU;QACV,MAAM;KACP;IACD,SAAS,EAAE,oDAAoD;IAC/D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,+QAA+Q;KACzR;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,MAAM;KACpB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,0CAA0C;QAClD,aAAa,EAAE,wEAAwE;KACxF;IACD,aAAa,EAAE,6WAA6W;IAC5X,WAAW,EAAE;QACX,uGAAuG;QACvG,wGAAwG;QACxG,8DAA8D;QAC9D,sHAAsH;QACtH,2IAA2I;KAC5I;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,gDAAgD;YAC/D,OAAO,EAAE,0EAA0E;SACpF;QACD;YACE,aAAa,EAAE,kDAAkD;YACjE,OAAO,EAAE,uEAAuE;SACjF;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,oGAAoG;SAC/G;QACD;YACE,UAAU,EAAE,4DAA4D;YACxE,QAAQ,EAAE,oFAAoF;SAC/F;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,kIAAkI;SAC7I;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,mBAAmB;SAC3B;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,iBAAiB;SACzB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,gEAAgE;QACzE,KAAK,EAAE,6GAA6G;KACrH;IACD,KAAK,EAAE,aAAa;IACpB,MAAM,EAAE,aAAa;IACrB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;QACV,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/accumarray.js

@@ -0,0 +1,48 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "accumarray",
+    "category": "array/grouping",
+    "keywords": [
+        "accumarray",
+        "accumulate",
+        "grouping",
+        "sparse"
+    ],
+    "summary": "Accumulate values into an array by subscript groups.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Grouped accumulation runs on the host."
+    },
+    "tested": {
+        "unit": "builtins::array::grouping::tests"
+    },
+    "description": "`accumarray(subs,data)` groups entries of `data` by one-based subscripts in `subs` and sums each group into the corresponding output element.",
+    "behaviors": [
+        "Supports vector, matrix, and cell-vector subscripts.",
+        "Supports scalar expansion of numeric/logical data, explicit output sizes, common callbacks such as `@mean`, general function-handle callbacks, fill values, and 2-D sparse numeric output."
+    ],
+    "examples": [
+        {
+            "description": "Sum by group",
+            "input": "B = accumarray([1;1;2],[10;20;5])",
+            "output": "B = [30; 5]"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/array/grouping.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/array/grouping.rs"
+    },
+    "key": "accumarray",
+    "slug": "accumarray",
+    "aliases": [],
+    "categoryPath": [
+        "array",
+        "grouping"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=accumarray.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accumarray.js","sourceRoot":"","sources":["../../../src/generated/builtins/accumarray.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,YAAY;IACrB,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE;QACV,YAAY;QACZ,YAAY;QACZ,UAAU;QACV,QAAQ;KACT;IACD,SAAS,EAAE,sDAAsD;IACjE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,wCAAwC;KAClD;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,kCAAkC;KAC3C;IACD,aAAa,EAAE,+IAA+I;IAC9J,WAAW,EAAE;QACX,sDAAsD;QACtD,4LAA4L;KAC7L;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,mCAAmC;YAC5C,QAAQ,EAAE,aAAa;SACxB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,wDAAwD;QACjE,KAAK,EAAE,qGAAqG;KAC7G;IACD,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"adamupdate.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/adamupdate.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/adamupdate.js

@@ -0,0 +1,46 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "adamupdate",
+    "category": "deep_learning",
+    "keywords": [
+        "adamupdate",
+        "deep learning",
+        "Adam",
+        "optimizer"
+    ],
+    "summary": "Update numeric parameters using the Adam optimizer rule.",
+    "description": "`adamupdate(params, grad, averageGrad, averageSqGrad, iteration)` applies the Adam optimizer update to host numeric arrays, host `dlarray` compatibility objects, and plain resident `gpuArray` tensors.",
+    "behaviors": [
+        "Parameters, gradients, and non-empty moving-average inputs must have matching shapes.",
+        "Empty `averageGrad` or `averageSqGrad` inputs initialize the corresponding moving average to zeros with the parameter shape.",
+        "Optional positional arguments are `learnRate`, `gradDecay`, `sqGradDecay`, and `epsilon`; defaults are `0.001`, `0.9`, `0.999`, and `1e-8`; learning rate and epsilon must be positive, and decay factors must be in `[0, 1)`.",
+        "A single unbracketed call returns updated parameters directly; bracketed calls return up to three outputs: updated parameters, updated first-moment average, and updated second-moment average.",
+        "Tensor inputs must be floating-point tensors; integer tensor optimizer state is rejected rather than relabeled after fractional updates.",
+        "When `params` and `grad` are resident `gpuArray` tensors, matching resident optimizer-state tensors or empty host numeric state route through the acceleration provider and return resident `gpuArray` outputs without downloading full tensors.",
+        "GPU-backed `dlarray` wrappers, model parameter structures, tables, function-handle training loops, and automatic differentiation remain future work."
+    ],
+    "examples": [
+        {
+            "description": "Update Parameters",
+            "input": "[params,avg,avgSq] = adamupdate(params, gradients, avg, avgSq, iteration)",
+            "output": "Updated numeric parameters and Adam moving-average state."
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "[params,avg,avgSq] = adamupdate(params, grad, avg, avgSq, iteration)\n[params,avg,avgSq] = adamupdate(params, grad, avg, avgSq, iteration, learnRate, gradDecay, sqGradDecay, epsilon)",
+            "output": "Updated parameter and optimizer-state arrays."
+        }
+    },
+    "gpu_residency": "`adamupdate` preserves residency for plain real `gpuArray` parameter, gradient, and optimizer-state tensors through the `runmat-accelerate` `adam_update` provider hook. Empty moving-average state is initialized on device. Host-backed `dlarray` remains host-compatible, and GPU-backed `dlarray` metadata/autodiff support remains future work.",
+    "key": "adamupdate",
+    "slug": "adamupdate",
+    "aliases": [],
+    "categoryPath": [
+        "deep_learning"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=adamupdate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adamupdate.js","sourceRoot":"","sources":["../../../src/generated/builtins/adamupdate.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,YAAY;IACrB,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,YAAY;QACZ,eAAe;QACf,MAAM;QACN,WAAW;KACZ;IACD,SAAS,EAAE,0DAA0D;IACrE,aAAa,EAAE,0MAA0M;IACzN,WAAW,EAAE;QACX,uFAAuF;QACvF,8HAA8H;QAC9H,gOAAgO;QAChO,iMAAiM;QACjM,0IAA0I;QAC1I,kPAAkP;QAClP,sJAAsJ;KACvJ;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mBAAmB;YAClC,OAAO,EAAE,2EAA2E;YACpF,QAAQ,EAAE,2DAA2D;SACtE;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,wLAAwL;YACjM,QAAQ,EAAE,+CAA+C;SAC1D;KACF;IACD,eAAe,EAAE,sVAAsV;IACvW,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/addDependencyDetails.js

@@ -0,0 +1,99 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addDependencyDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addDependencyDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "dependency",
+        "head"
+    ],
+    "summary": "Add dependency-head tags to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addDependencyDetails` analyzes host token strings and updates tokenizedDocument metadata; it does not use provider kernels."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::strings::text_analytics::dependencies::tests",
+        "integration": null
+    },
+    "description": "`addDependencyDetails(documents)` adds dependency-head metadata to a RunMat `tokenizedDocument` compatibility object. Use `tokenDetails` to view the resulting `Head` and `Dependency` columns.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "`addDependencyDetails` has no name-value options.",
+        "RunMat ensures sentence-number details exist before computing dependencies, so `tokenDetails` returns `SentenceNumber` alongside `Head` and `Dependency`.",
+        "`Head` stores the one-based index of the syntactic head token within the same document. Root tokens use `0`.",
+        "`Dependency` stores Universal Dependencies-style labels such as `root`, `nsubj`, `obj`, `det`, `amod`, `advmod`, `case`, `obl`, `aux`, `cc`, `mark`, `punct`, `nummod`, and `dep`.",
+        "RunMat uses deterministic English and German compatibility rules over the shared part-of-speech classifier. Existing Japanese or Korean language metadata is accepted with conservative token-class-aware fallback dependencies.",
+        "Exact MathWorks statistical dependency-parser parity, MeCab-backed Japanese/Korean tokenization, and broader language-detail model parity remain tracked as Text Analytics work."
+    ],
+    "examples": [
+        {
+            "description": "Add Dependency Details",
+            "input": "documents = tokenizedDocument(\"The dogs chase cats.\");\ndocuments = addDependencyDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails` includes `Head` and `Dependency` columns."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addDependencyDetails` use a full parser model?",
+            "answer": "No. This compatibility slice uses deterministic dependency rules and records exact MathWorks parser parity as remaining Text Analytics work."
+        },
+        {
+            "question": "Does `addDependencyDetails` execute on the GPU?",
+            "answer": "No. It updates host tokenizedDocument metadata."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenDetails",
+            "url": "./tokenDetails"
+        },
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        },
+        {
+            "label": "addSentenceDetails",
+            "url": "./addSentenceDetails"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported form",
+            "input": "updatedDocuments = addDependencyDetails(documents)",
+            "output": "`updatedDocuments` is a `tokenizedDocument` compatibility object."
+        },
+        "points": [
+            "`documents` must be a RunMat `tokenizedDocument` object.",
+            "No name-value options are supported for this MATLAB-compatible form.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting `Head` and `Dependency` table columns."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/dependencies.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/dependencies.rs"
+    },
+    "gpu_residency": "`addDependencyDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "adddependencydetails",
+    "slug": "adddependencydetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addDependencyDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addDependencyDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addDependencyDetails.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,sBAAsB;IAC/B,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,sBAAsB;QACtB,mBAAmB;QACnB,gBAAgB;QAChB,YAAY;QACZ,MAAM;KACP;IACD,SAAS,EAAE,kDAAkD;IAC7D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,8HAA8H;KACxI;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,wDAAwD;QAChE,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,iMAAiM;IAChN,WAAW,EAAE;QACX,0DAA0D;QAC1D,mDAAmD;QACnD,2JAA2J;QAC3J,8GAA8G;QAC9G,oLAAoL;QACpL,kOAAkO;QAClO,kLAAkL;KACnL;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,4IAA4I;YACrJ,QAAQ,EAAE,sDAAsD;SACjE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,sDAAsD;YAClE,QAAQ,EAAE,8IAA8I;SACzJ;QACD;YACE,UAAU,EAAE,iDAAiD;YAC7D,QAAQ,EAAE,iDAAiD;SAC5D;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,sBAAsB;SAC9B;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,sEAAsE;YACtE,mGAAmG;SACpG;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6EAA6E;QACtF,KAAK,EAAE,0HAA0H;KAClI;IACD,eAAe,EAAE,4FAA4F;IAC7G,KAAK,EAAE,sBAAsB;IAC7B,MAAM,EAAE,sBAAsB;IAC9B,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"addEntityDetails.d.ts","sourceRoot":"","sources":["../../../src/generated/builtins/addEntityDetails.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/addEntityDetails.js

@@ -0,0 +1,115 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addEntityDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addEntityDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "entity",
+        "named entity"
+    ],
+    "summary": "Add named-entity tags to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addEntityDetails` retokenizes host token strings and updates tokenizedDocument metadata; it does not use provider kernels."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 5,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::strings::text_analytics::entities::tests",
+        "integration": null
+    },
+    "description": "`addEntityDetails(documents)` adds named-entity metadata to a RunMat `tokenizedDocument` compatibility object. Use `tokenDetails` to view the resulting `Entity` column.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "`addEntityDetails(documents, Name, Value)` supports `RetokenizeMethod`, `DiscardKnownValues`, and `Model` name-value pairs.",
+        "`RetokenizeMethod` defaults to `\"entity\"`, which merges simple adjacent entity tokens such as multiword locations. Use `\"none\"` to keep existing tokens.",
+        "`DiscardKnownValues` defaults to `false`, so existing known entity details are preserved while missing or empty entries are filled.",
+        "`DiscardKnownValues`, `true` recomputes every stored tag and ignores malformed stored entity details.",
+        "`Model`, `\"auto\"` selects RunMat's built-in deterministic compatibility tagger. Custom `hmmEntityModel` inputs remain tracked as broader Text Analytics model infrastructure.",
+        "`addEntityDetails` ensures sentence and part-of-speech details exist first, then updates part-of-speech details for recognized entities to `\"proper-noun\"`.",
+        "RunMat tags English and German tokens with deterministic compatibility rules for `person`, `location`, `organization`, `other`, and `non-entity`.",
+        "If an existing tokenizedDocument object already carries Japanese or Korean language metadata, RunMat accepts the language and uses conservative token-class-aware fallback tags. Public Japanese/Korean tokenizedDocument construction and MeCab-backed entity models remain tracked.",
+        "Exact MathWorks statistical entity-model parity remains tracked as broader Text Analytics work."
+    ],
+    "examples": [
+        {
+            "description": "Add Entity Details",
+            "input": "documents = tokenizedDocument(\"Mary uses MATLAB at MathWorks.\");\ndocuments = addEntityDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails.Entity` contains tags such as `\"person\"`, `\"organization\"`, `\"other\"`, and `\"non-entity\"`."
+        },
+        {
+            "description": "Keep Existing Tokens",
+            "input": "documents = addEntityDetails(documents, \"RetokenizeMethod\", \"none\")",
+            "output": "`documents` receives entity details without the entity retokenization pass."
+        },
+        {
+            "description": "Recompute Entity Details",
+            "input": "documents = addEntityDetails(documents, \"DiscardKnownValues\", true)",
+            "output": "`documents` has refreshed entity details."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addEntityDetails` use a full entity model?",
+            "answer": "No. This compatibility slice uses deterministic English and German rules and records exact MathWorks model parity as remaining Text Analytics work."
+        },
+        {
+            "question": "Does `addEntityDetails` execute on the GPU?",
+            "answer": "No. It updates host tokenizedDocument metadata."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenDetails",
+            "url": "./tokenDetails"
+        },
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        },
+        {
+            "label": "addPartOfSpeechDetails",
+            "url": "./addPartOfSpeechDetails"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "updatedDocuments = addEntityDetails(documents)\nupdatedDocuments = addEntityDetails(documents, Name, Value)",
+            "output": "`updatedDocuments` is a `tokenizedDocument` compatibility object."
+        },
+        "points": [
+            "`documents` must be a RunMat `tokenizedDocument` object.",
+            "`Name, Value` pairs may include `RetokenizeMethod`, `DiscardKnownValues`, and `Model`.",
+            "`RetokenizeMethod` may be `\"entity\"` or `\"none\"`.",
+            "`DiscardKnownValues` must be a logical scalar or numeric 0/1 scalar.",
+            "`Model` currently accepts `\"auto\"`; custom entity model objects remain tracked.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting `Entity` table column."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/entities.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/entities.rs"
+    },
+    "gpu_residency": "`addEntityDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "addentitydetails",
+    "slug": "addentitydetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addEntityDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addEntityDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addEntityDetails.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,kBAAkB;IAC3B,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,kBAAkB;QAClB,mBAAmB;QACnB,gBAAgB;QAChB,QAAQ;QACR,cAAc;KACf;IACD,SAAS,EAAE,+CAA+C;IAC1D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,6HAA6H;KACvI;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,oDAAoD;QAC5D,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,0KAA0K;IACzL,WAAW,EAAE;QACX,0DAA0D;QAC1D,6HAA6H;QAC7H,8JAA8J;QAC9J,qIAAqI;QACrI,uGAAuG;QACvG,iLAAiL;QACjL,+JAA+J;QAC/J,mJAAmJ;QACnJ,uRAAuR;QACvR,iGAAiG;KAClG;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,oBAAoB;YACnC,OAAO,EAAE,kJAAkJ;YAC3J,QAAQ,EAAE,8GAA8G;SACzH;QACD;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,yEAAyE;YAClF,QAAQ,EAAE,6EAA6E;SACxF;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,uEAAuE;YAChF,QAAQ,EAAE,2CAA2C;SACtD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,kDAAkD;YAC9D,QAAQ,EAAE,qJAAqJ;SAChK;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,iDAAiD;SAC5D;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,0BAA0B;SAClC;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,6GAA6G;YACtH,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,wFAAwF;YACxF,uDAAuD;YACvD,sEAAsE;YACtE,mFAAmF;YACnF,mFAAmF;SACpF;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yEAAyE;QAClF,KAAK,EAAE,sHAAsH;KAC9H;IACD,eAAe,EAAE,wFAAwF;IACzG,KAAK,EAAE,kBAAkB;IACzB,MAAM,EAAE,kBAAkB;IAC1B,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/addLemmaDetails.js

@@ -0,0 +1,104 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addLemmaDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addLemmaDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "lemma",
+        "lemmatization"
+    ],
+    "summary": "Add lemma forms to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addLemmaDetails` analyzes host token strings and updates tokenizedDocument metadata; it does not use provider kernels."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::strings::text_analytics::lemmas::tests",
+        "integration": null
+    },
+    "description": "`addLemmaDetails(documents)` adds lemma metadata to a RunMat `tokenizedDocument` compatibility object. Use `tokenDetails` to view the resulting `Lemma` column.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "`addLemmaDetails(documents,'DiscardKnownValues',tf)` controls whether existing lemma details are preserved or recomputed.",
+        "`DiscardKnownValues` defaults to `false`, so existing known lemma details are preserved while missing or empty entries are filled.",
+        "`DiscardKnownValues`, `true` recomputes every stored lemma.",
+        "For English documents, RunMat applies the same lightweight English lemmatizer used by `normalizeWords(...,'Style','lemma')`, including common irregulars such as `ran` to `run`, plural reduction, and simple verb-suffix normalization.",
+        "Punctuation, numbers, URLs, email addresses, hashtags, mentions, emoji, and other non-word tokens keep their original token text as the lemma.",
+        "If an existing tokenizedDocument object already carries Japanese or Korean language metadata, RunMat preserves token text as the lemma. Public Japanese/Korean tokenizedDocument construction still requires MeCab-compatible tokenization and remains tracked. German documents are rejected because MATLAB `addLemmaDetails` does not document German support."
+    ],
+    "examples": [
+        {
+            "description": "Add Lemma Details",
+            "input": "documents = tokenizedDocument([\"The dogs ran after the cat.\"; \"I am building a house.\"]);\ndocuments = addLemmaDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails.Lemma` contains values such as `\"dog\"`, `\"run\"`, `\"be\"`, and `\"build\"`."
+        },
+        {
+            "description": "Recompute Lemma Details",
+            "input": "documents = addLemmaDetails(documents, \"DiscardKnownValues\", true)",
+            "output": "`documents` has refreshed lemma details."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addLemmaDetails` use a full NLP model?",
+            "answer": "No. This compatibility slice uses RunMat's deterministic English lemmatizer and records exact model parity as remaining Text Analytics work."
+        },
+        {
+            "question": "Does `addLemmaDetails` execute on the GPU?",
+            "answer": "No. It updates host tokenizedDocument metadata."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenDetails",
+            "url": "./tokenDetails"
+        },
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        },
+        {
+            "label": "normalizeWords",
+            "url": "./normalizeWords"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "updatedDocuments = addLemmaDetails(documents)\nupdatedDocuments = addLemmaDetails(documents, 'DiscardKnownValues', tf)",
+            "output": "`updatedDocuments` is a `tokenizedDocument` compatibility object."
+        },
+        "points": [
+            "`documents` must be a RunMat `tokenizedDocument` object.",
+            "`tf` must be a logical scalar or numeric 0/1 scalar.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting `Lemma` table column."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/lemmas.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/lemmas.rs"
+    },
+    "gpu_residency": "`addLemmaDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "addlemmadetails",
+    "slug": "addlemmadetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addLemmaDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addLemmaDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addLemmaDetails.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,iBAAiB;IAC1B,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,iBAAiB;QACjB,mBAAmB;QACnB,gBAAgB;QAChB,OAAO;QACP,eAAe;KAChB;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,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,kDAAkD;QAC1D,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,iKAAiK;IAChL,WAAW,EAAE;QACX,0DAA0D;QAC1D,2HAA2H;QAC3H,oIAAoI;QACpI,6DAA6D;QAC7D,0OAA0O;QAC1O,gJAAgJ;QAChJ,kWAAkW;KACnW;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mBAAmB;YAClC,OAAO,EAAE,4KAA4K;YACrL,QAAQ,EAAE,2FAA2F;SACtG;QACD;YACE,aAAa,EAAE,yBAAyB;YACxC,OAAO,EAAE,sEAAsE;YAC/E,QAAQ,EAAE,0CAA0C;SACrD;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,8CAA8C;YAC1D,QAAQ,EAAE,8IAA8I;SACzJ;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,iDAAiD;SAC5D;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,kBAAkB;SAC1B;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,wHAAwH;YACjI,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,sDAAsD;YACtD,kFAAkF;SACnF;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,uEAAuE;QAChF,KAAK,EAAE,oHAAoH;KAC5H;IACD,eAAe,EAAE,uFAAuF;IACxG,KAAK,EAAE,iBAAiB;IACxB,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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