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

package/dist/generated/builtins/addPartOfSpeechDetails.js

@@ -0,0 +1,112 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addPartOfSpeechDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addPartOfSpeechDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "part of speech",
+        "pos"
+    ],
+    "summary": "Add part-of-speech tags to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addPartOfSpeechDetails` 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::pos::tests",
+        "integration": null
+    },
+    "description": "`addPartOfSpeechDetails(documents)` adds part-of-speech metadata to a RunMat `tokenizedDocument` compatibility object. Use `tokenDetails` to view the resulting `PartOfSpeech` column.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "`addPartOfSpeechDetails(documents, Name, Value)` supports `RetokenizeMethod`, `Abbreviations`, and `DiscardKnownValues` name-value pairs.",
+        "`RetokenizeMethod` defaults to `\"part-of-speech\"`, which applies common part-of-speech retokenization such as English contractions, `wanna`/`gonna`, ellipses, and dotted initialisms. Use `\"none\"` to keep existing tokens.",
+        "`Abbreviations` is passed through to the sentence-detail prepass when sentence details are absent.",
+        "`DiscardKnownValues` defaults to `false`, so existing known part-of-speech details are preserved while missing or empty entries are filled.",
+        "`DiscardKnownValues`, `true` recomputes every stored tag.",
+        "RunMat tags English and German tokens with deterministic compatibility taggers covering common pronouns, determiners, coordinate and subordinate conjunctions, adpositions, particles, auxiliary verbs, verbs, adverbs, adjectives, nouns, numerals, punctuation, and other token classes.",
+        "If an existing tokenizedDocument object already carries Japanese or Korean language metadata, RunMat currently uses token-class-aware fallback tags and a conservative noun fallback for letter tokens. Public Japanese/Korean tokenizedDocument construction and MeCab-backed part-of-speech models remain tracked.",
+        "Exact MathWorks statistical model parity remains tracked as broader Text Analytics work."
+    ],
+    "examples": [
+        {
+            "description": "Add Part-Of-Speech Details",
+            "input": "documents = tokenizedDocument(\"The dogs are running.\");\ndocuments = addPartOfSpeechDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails.PartOfSpeech` contains tags such as `\"determiner\"`, `\"noun\"`, `\"auxiliary-verb\"`, `\"verb\"`, and `\"punctuation\"`."
+        },
+        {
+            "description": "Keep Existing Tokens",
+            "input": "documents = addPartOfSpeechDetails(documents, \"RetokenizeMethod\", \"none\")",
+            "output": "`documents` receives part-of-speech details without the part-of-speech retokenization pass."
+        },
+        {
+            "description": "Recompute Part-Of-Speech Details",
+            "input": "documents = addPartOfSpeechDetails(documents, \"DiscardKnownValues\", true)",
+            "output": "`documents` has refreshed part-of-speech details."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addPartOfSpeechDetails` use a full NLP model?",
+            "answer": "No. This compatibility slice uses deterministic English rules and records exact MathWorks model parity as remaining Text Analytics work."
+        },
+        {
+            "question": "Does `addPartOfSpeechDetails` 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 forms",
+            "input": "updatedDocuments = addPartOfSpeechDetails(documents)\nupdatedDocuments = addPartOfSpeechDetails(documents, Name, Value)",
+            "output": "`updatedDocuments` is a `tokenizedDocument` compatibility object."
+        },
+        "points": [
+            "`documents` must be a RunMat `tokenizedDocument` object.",
+            "`Name, Value` pairs may include `RetokenizeMethod`, `Abbreviations`, and `DiscardKnownValues`.",
+            "`DiscardKnownValues` must be a logical scalar or numeric 0/1 scalar.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting `PartOfSpeech` table column."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/pos.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/pos.rs"
+    },
+    "gpu_residency": "`addPartOfSpeechDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "addpartofspeechdetails",
+    "slug": "addpartofspeechdetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addPartOfSpeechDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addPartOfSpeechDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addPartOfSpeechDetails.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,wBAAwB;IACjC,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,wBAAwB;QACxB,mBAAmB;QACnB,gBAAgB;QAChB,gBAAgB;QAChB,KAAK;KACN;IACD,SAAS,EAAE,iDAAiD;IAC5D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,mIAAmI;KAC7I;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,+CAA+C;QACvD,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,wLAAwL;IACvM,WAAW,EAAE;QACX,0DAA0D;QAC1D,2IAA2I;QAC3I,kOAAkO;QAClO,oGAAoG;QACpG,6IAA6I;QAC7I,2DAA2D;QAC3D,4RAA4R;QAC5R,sTAAsT;QACtT,0FAA0F;KAC3F;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,4BAA4B;YAC3C,OAAO,EAAE,+IAA+I;YACxJ,QAAQ,EAAE,sIAAsI;SACjJ;QACD;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,+EAA+E;YACxF,QAAQ,EAAE,6FAA6F;SACxG;QACD;YACE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE,6EAA6E;YACtF,QAAQ,EAAE,mDAAmD;SAC9D;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,qDAAqD;YACjE,QAAQ,EAAE,0IAA0I;SACrJ;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,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,iBAAiB;YAChC,OAAO,EAAE,yHAAyH;YAClI,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,gGAAgG;YAChG,sEAAsE;YACtE,yFAAyF;SAC1F;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,oEAAoE;QAC7E,KAAK,EAAE,iHAAiH;KACzH;IACD,eAAe,EAAE,8FAA8F;IAC/G,KAAK,EAAE,wBAAwB;IAC/B,MAAM,EAAE,wBAAwB;IAChC,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/addSentenceDetails.js

@@ -0,0 +1,112 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addSentenceDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addSentenceDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "sentence numbers",
+        "token details"
+    ],
+    "summary": "Add sentence numbers to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addSentenceDetails` 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::details::tests",
+        "integration": null
+    },
+    "description": "`addSentenceDetails(documents)` detects sentence boundaries in a RunMat `tokenizedDocument` compatibility object and stores one `SentenceNumber` value per token. Use `tokenDetails` to view the resulting table column.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "RunMat assigns sentence numbers from terminating punctuation tokens `.`, `!`, `?`, and common Japanese/Korean equivalents.",
+        "`Abbreviations` accepts a character vector, string array, cell array of character vectors, or a table with `Abbreviation` and `Usage` variables.",
+        "Text abbreviation lists are treated as `regular` abbreviations. Table `Usage` values can be text or categorical values of `regular`, `inner`, `reference`, or `unit`.",
+        "`Starters` accepts a character vector, string array, cell array of character vectors, or categorical vector and controls whether regular abbreviations break before capitalized starter words. The default starter list is based on RunMat's English `stopWords` list plus common sentence starters.",
+        "`DiscardKnownValues` defaults to `false`; existing complete positive integer sentence-number details are preserved. Set it to `true` to recompute every sentence number.",
+        "Single-letter initialisms such as `U.S.A.` are treated as regular abbreviations and are not split inside the initialism.",
+        "RunMat's sentence detector is token-level and deterministic. Exact MathWorks statistical sentence boundary models, emoji-after-terminator placement, line-provenance-aware splitting, and Japanese/Korean MeCab behavior remain broader Text Analytics work."
+    ],
+    "examples": [
+        {
+            "description": "Add Sentence Details",
+            "input": "documents = tokenizedDocument([\"This is an example document. It has two sentences.\"; \"This document has one sentence.\"]);\ndocuments = addSentenceDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails` includes a `SentenceNumber` column."
+        },
+        {
+            "description": "Use Custom Abbreviations",
+            "input": "documents = tokenizedDocument(\"Book an appt. We'll meet then.\");\ndocuments = addSentenceDetails(documents, \"Abbreviations\", \"appt\", \"Starters\", \"we'll\")",
+            "output": "`appt.` is treated as a regular abbreviation and breaks only before the configured starter."
+        },
+        {
+            "description": "Recompute Sentence Details",
+            "input": "documents = addSentenceDetails(documents, \"DiscardKnownValues\", true)",
+            "output": "`documents` has refreshed sentence-number details."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addSentenceDetails` support abbreviation tables?",
+            "answer": "Yes. The table must contain `Abbreviation` and `Usage` variables, and `Usage` values can be text or categorical `regular`, `inner`, `reference`, or `unit` values."
+        },
+        {
+            "question": "Does `addSentenceDetails` execute on the GPU?",
+            "answer": "No. It updates host tokenizedDocument metadata."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenDetails",
+            "url": "./tokenDetails"
+        },
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        },
+        {
+            "label": "addTypeDetails",
+            "url": "./addTypeDetails"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "updatedDocuments = addSentenceDetails(documents)\nupdatedDocuments = addSentenceDetails(documents, 'Abbreviations', abbreviations)\nupdatedDocuments = addSentenceDetails(documents, 'Starters', starters)\nupdatedDocuments = addSentenceDetails(documents, 'DiscardKnownValues', tf)",
+            "output": "`updatedDocuments` is a `tokenizedDocument` compatibility object."
+        },
+        "points": [
+            "`documents` must be a RunMat `tokenizedDocument` object.",
+            "`abbreviations` can be text or a table with `Abbreviation` and `Usage` variables.",
+            "`starters` must be a text or categorical vector.",
+            "`tf` must be a logical scalar or numeric 0/1 scalar.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting `SentenceNumber` table column."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/details.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/details.rs"
+    },
+    "gpu_residency": "`addSentenceDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "addsentencedetails",
+    "slug": "addsentencedetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addSentenceDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addSentenceDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addSentenceDetails.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,mBAAmB;QACnB,gBAAgB;QAChB,kBAAkB;QAClB,eAAe;KAChB;IACD,SAAS,EAAE,8CAA8C;IACzD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,4HAA4H;KACtI;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,mDAAmD;QAC3D,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,0NAA0N;IACzO,WAAW,EAAE;QACX,0DAA0D;QAC1D,4HAA4H;QAC5H,kJAAkJ;QAClJ,uKAAuK;QACvK,sSAAsS;QACtS,0KAA0K;QAC1K,0HAA0H;QAC1H,8PAA8P;KAC/P;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,+MAA+M;YACxN,QAAQ,EAAE,gDAAgD;SAC3D;QACD;YACE,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,qKAAqK;YAC9K,QAAQ,EAAE,6FAA6F;SACxG;QACD;YACE,aAAa,EAAE,4BAA4B;YAC3C,OAAO,EAAE,yEAAyE;YAClF,QAAQ,EAAE,oDAAoD;SAC/D;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,wDAAwD;YACpE,QAAQ,EAAE,oKAAoK;SAC/K;QACD;YACE,UAAU,EAAE,+CAA+C;YAC3D,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,wRAAwR;YACjS,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,mFAAmF;YACnF,kDAAkD;YAClD,sDAAsD;YACtD,2FAA2F;SAC5F;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,wEAAwE;QACjF,KAAK,EAAE,qHAAqH;KAC7H;IACD,eAAe,EAAE,0FAA0F;IAC3G,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/addTypeDetails.d.ts

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

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

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

package/dist/generated/builtins/addTypeDetails.js

@@ -0,0 +1,105 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addTypeDetails",
+    "category": "strings/text_analytics",
+    "keywords": [
+        "addTypeDetails",
+        "tokenizedDocument",
+        "text analytics",
+        "token types"
+    ],
+    "summary": "Add token type details to tokenized documents.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`addTypeDetails` classifies host-resident text tokens 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::details::tests",
+        "integration": null
+    },
+    "description": "`addTypeDetails(documents)` detects token types in a RunMat `tokenizedDocument` compatibility object and returns an updated object. `addTypeDetails(documents,'DiscardKnownValues',tf)` controls whether existing type details are preserved or recomputed. `addTypeDetails(documents,'TopLevelDomains',domains)` customizes web-address type recognition.",
+    "behaviors": [
+        "`documents` must be a RunMat `tokenizedDocument` object.",
+        "When type details are absent, RunMat derives one type value for each token and stores the details on the returned object.",
+        "`DiscardKnownValues` defaults to `false`, so existing known type details are preserved while missing or `unknown` type details are filled.",
+        "`DiscardKnownValues`, `true` recomputes every stored type detail.",
+        "`TopLevelDomains` accepts a character vector, string array, or cell array of character vectors. It overrides the document's stored TLD list for web-address type recognition and is stored on the returned object.",
+        "RunMat recognizes `letters`, `digits`, `punctuation`, `email-address`, `web-address`, `hashtag`, `at-mention`, `emoticon`, `emoji`, and `other` using the same lightweight token rules as `tokenizedDocument`.",
+        "Custom token-type tables, full MathWorks `topLevelDomains` corpus parity, and exact MathWorks URL classifier parity remain broader Text Analytics work."
+    ],
+    "examples": [
+        {
+            "description": "Add Types To Pre-Tokenized Documents",
+            "input": "documents = tokenizedDocument([\"For\" \"more\" \"information\" \",\"], \"TokenizeMethod\", \"none\");\ndocuments = addTypeDetails(documents);\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails.Type` contains `letters`, `letters`, `letters`, and `punctuation`."
+        },
+        {
+            "description": "Recompute Type Details",
+            "input": "documents = addTypeDetails(documents, \"DiscardKnownValues\", true)",
+            "output": "`documents` has refreshed token type details."
+        },
+        {
+            "description": "Configure Web Address Domains",
+            "input": "documents = tokenizedDocument([\"example.zz\"], \"TokenizeMethod\", \"none\");\ndocuments = addTypeDetails(documents, \"TopLevelDomains\", \"zz\");\ntdetails = tokenDetails(documents)",
+            "output": "`tdetails.Type` contains `web-address` for `example.zz`."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addTypeDetails` support `TopLevelDomains`?",
+            "answer": "Yes. RunMat accepts character, string-array, and cell-string TLD lists for web-address detection. Full default `topLevelDomains` corpus parity remains tracked."
+        },
+        {
+            "question": "Does `addTypeDetails` execute on the GPU?",
+            "answer": "No. It classifies host token strings and updates object metadata."
+        }
+    ],
+    "links": [
+        {
+            "label": "tokenDetails",
+            "url": "./tokenDetails"
+        },
+        {
+            "label": "tokenizedDocument",
+            "url": "./tokenizedDocument"
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "updatedDocuments = addTypeDetails(documents)\nupdatedDocuments = addTypeDetails(documents, 'DiscardKnownValues', tf)\nupdatedDocuments = addTypeDetails(documents, 'TopLevelDomains', domains)",
+            "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.",
+            "`domains` must contain one or more valid top-level-domain labels.",
+            "Use `tokenDetails(updatedDocuments)` to view the resulting type table."
+        ]
+    },
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/strings/text_analytics/details.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/strings/text_analytics/details.rs"
+    },
+    "gpu_residency": "`addTypeDetails` updates host tokenizedDocument metadata and has no provider kernel.",
+    "key": "addtypedetails",
+    "slug": "addtypedetails",
+    "aliases": [],
+    "categoryPath": [
+        "strings",
+        "text_analytics"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addTypeDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addTypeDetails.js","sourceRoot":"","sources":["../../../src/generated/builtins/addTypeDetails.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,gBAAgB;IACzB,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,gBAAgB;QAChB,mBAAmB;QACnB,gBAAgB;QAChB,aAAa;KACd;IACD,SAAS,EAAE,gDAAgD;IAC3D,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iIAAiI;KAC3I;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,mDAAmD;QAC3D,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,4VAA4V;IAC3W,WAAW,EAAE;QACX,0DAA0D;QAC1D,2HAA2H;QAC3H,4IAA4I;QAC5I,mEAAmE;QACnE,oNAAoN;QACpN,gNAAgN;QAChN,yJAAyJ;KAC1J;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,oLAAoL;YAC7L,QAAQ,EAAE,8EAA8E;SACzF;QACD;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,qEAAqE;YAC9E,QAAQ,EAAE,+CAA+C;SAC1D;QACD;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,yLAAyL;YAClM,QAAQ,EAAE,0DAA0D;SACrE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,kDAAkD;YAC9D,QAAQ,EAAE,iKAAiK;SAC5K;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,mEAAmE;SAC9E;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,qBAAqB;SAC7B;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,gMAAgM;YACzM,QAAQ,EAAE,mEAAmE;SAC9E;QACD,QAAQ,EAAE;YACR,0DAA0D;YAC1D,sDAAsD;YACtD,mEAAmE;YACnE,wEAAwE;SACzE;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,wEAAwE;QACjF,KAAK,EAAE,qHAAqH;KAC7H;IACD,eAAe,EAAE,sFAAsF;IACvG,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;QACT,gBAAgB;KACjB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/addpoints.js

@@ -0,0 +1,110 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addpoints",
+    "category": "plotting",
+    "keywords": [
+        "addpoints",
+        "animatedline",
+        "animated line",
+        "streaming plot",
+        "live plot",
+        "matlab plotting"
+    ],
+    "summary": "Append 2-D or 3-D coordinates to an animated line.",
+    "hero_image": null,
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "single",
+            "double"
+        ],
+        "broadcasting": "none",
+        "notes": "`addpoints` mutates graphics handle state. GPU-resident coordinate inputs are accepted through the plotting input path and gathered before appending."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 4,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::addpoints::tests",
+        "integration": "crates/runmat-vm/tests/plotting.rs"
+    },
+    "description": "`addpoints` appends coordinates to a handle returned by `animatedline`. It updates the underlying line geometry and honors the handle's `MaximumNumPoints` limit by trimming oldest samples.",
+    "behaviors": [
+        "`addpoints(an,x,y)` appends 2-D points to an animated line.",
+        "`addpoints(an,x,y,z)` appends 3-D points. An empty 2-D animated line is promoted to a 3-D line when Z data is first added, unless the handle has marker metadata that the 3-D renderer cannot preserve.",
+        "Coordinate inputs must be scalars or vectors with matching element counts.",
+        "If the target is already 3-D, callers must provide X, Y, and Z coordinates.",
+        "The function mutates graphics state and has no MATLAB output."
+    ],
+    "options": [
+        "The first argument must be an `animatedline` handle.",
+        "X, Y, and optional Z coordinates may be scalars, vectors, or GPU-resident vectors."
+    ],
+    "examples": [
+        {
+            "description": "Append samples to an animated line",
+            "input": "an = animatedline('MaximumNumPoints', 3);\naddpoints(an, [1 2], [10 20]);\naddpoints(an, [3 4], [30 40]);\nget(an, 'YData')",
+            "output": "ans =\n    20    30    40"
+        },
+        {
+            "description": "Append 3-D samples",
+            "input": "an = animatedline();\naddpoints(an, [1 2], [3 4], [5 6]);\nget(an, 'Type')",
+            "output": "ans =\n    'animatedline'"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Can addpoints be used with ordinary line handles?",
+            "answer": "No. The first argument must be a handle returned by `animatedline`; ordinary `line` and `plot` handles should be updated with `set(h,'XData',...)` and related properties."
+        },
+        {
+            "question": "Does addpoints clear the axes?",
+            "answer": "No. It mutates the existing animated-line object in place."
+        },
+        {
+            "question": "Can I promote a marker-styled 2-D animated line to 3-D?",
+            "answer": "No. RunMat rejects that promotion so marker metadata is not silently lost. Create a 3-D animated line without marker styling instead."
+        }
+    ],
+    "links": [
+        {
+            "label": "animatedline",
+            "url": "./animatedline"
+        },
+        {
+            "label": "line",
+            "url": "./line"
+        },
+        {
+            "label": "get",
+            "url": "./get"
+        },
+        {
+            "label": "set",
+            "url": "./set"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/addpoints.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/addpoints.rs"
+    },
+    "gpu_residency": "`addpoints` gathers GPU-resident coordinate vectors before appending to host-side animated-line graphics state.",
+    "gpu_behavior": [
+        "The operation preserves graphics handle identity while replacing the stored line data.",
+        "The updated line continues through RunMat's existing line or line3 rendering path."
+    ],
+    "key": "addpoints",
+    "slug": "addpoints",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addpoints.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addpoints.js","sourceRoot":"","sources":["../../../src/generated/builtins/addpoints.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,cAAc;QACd,eAAe;QACf,gBAAgB;QAChB,WAAW;QACX,iBAAiB;KAClB;IACD,SAAS,EAAE,oDAAoD;IAC/D,YAAY,EAAE,IAAI;IAClB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,QAAQ;YACR,QAAQ;SACT;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,uJAAuJ;KACjK;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;QAC9C,aAAa,EAAE,oCAAoC;KACpD;IACD,aAAa,EAAE,8LAA8L;IAC7M,WAAW,EAAE;QACX,6DAA6D;QAC7D,yMAAyM;QACzM,4EAA4E;QAC5E,6EAA6E;QAC7E,+DAA+D;KAChE;IACD,SAAS,EAAE;QACT,sDAAsD;QACtD,oFAAoF;KACrF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,6HAA6H;YACtI,QAAQ,EAAE,2BAA2B;SACtC;QACD;YACE,aAAa,EAAE,oBAAoB;YACnC,OAAO,EAAE,4EAA4E;YACrF,QAAQ,EAAE,2BAA2B;SACtC;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,4KAA4K;SACvL;QACD;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,4DAA4D;SACvE;QACD;YACE,UAAU,EAAE,yDAAyD;YACrE,QAAQ,EAAE,uIAAuI;SAClJ;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;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,eAAe,EAAE,iHAAiH;IAClI,cAAc,EAAE;QACd,wFAAwF;QACxF,oFAAoF;KACrF;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/addprop.d.ts

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

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

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

@@ -0,0 +1,99 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "addprop",
+    "category": "introspection",
+    "keywords": [
+        "addprop",
+        "dynamicprops",
+        "dynamic property",
+        "handle",
+        "matlab.metadata.DynamicProperty"
+    ],
+    "summary": "Add a per-instance dynamic property to a handle object.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Host-side object metadata mutation. GPU provider kernels do not participate."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::introspection::dynamicprops::tests",
+        "integration": "crates/runmat-vm/tests/functions.rs::dynamicprops_class_supports_addprop_dot_access_and_delete"
+    },
+    "description": "`prop = addprop(obj, name)` adds a dynamic property to a valid `dynamicprops` handle object and returns a `matlab.metadata.DynamicProperty` metadata handle for that per-instance property.",
+    "behaviors": [
+        "The target must be a valid handle object whose class inherits from `dynamicprops`; value objects, ordinary handle classes, and structs are rejected.",
+        "The property name must be a valid identifier and must not duplicate a class-defined property or an existing dynamic property on the same instance.",
+        "The new property is immediately readable and writable through dot syntax, `getfield`, and `setfield`.",
+        "The returned metadata handle exposes `Name`, `DefiningClass`, `GetAccess`, `SetAccess`, `Dependent`, `Hidden`, `Transient`, `NonCopyable`, `AbortSet`, `SetObservable`, `GetObservable`, and `Description` fields.",
+        "Writable metadata fields update the target object's dynamic property metadata. `Name` and `DefiningClass` are read-only.",
+        "`delete(prop)` removes the dynamic property and invalidates the metadata handle."
+    ],
+    "examples": [
+        {
+            "description": "Add and use a dynamic property",
+            "input": "classdef Sensor < dynamicprops\nend\ns = new_object('Sensor');\np = addprop(s, 'gain');\ns.gain = 7;\nvalue = s.gain",
+            "output": "value = 7"
+        },
+        {
+            "description": "Set metadata",
+            "input": "p = addprop(s, 'label');\np.Hidden = true;\ntf = p.Hidden",
+            "output": "tf = logical(1)"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `addprop` work on value classes?",
+            "answer": "No. MATLAB dynamic properties are handle-object instance state, so RunMat requires a valid handle object."
+        },
+        {
+            "question": "Are dynamic properties saved to MAT files?",
+            "answer": "Not as full classdef metadata. RunMat saves object property values through the existing object serialization path, but complete dynamic-property persistence requires broader classdef persistence support."
+        },
+        {
+            "question": "Do `SetObservable` and `GetObservable` fire property listeners?",
+            "answer": "The metadata flags are stored and reported, but full observable-property listener semantics are not implemented yet."
+        }
+    ],
+    "links": [
+        {
+            "label": "findprop",
+            "url": "./findprop"
+        },
+        {
+            "label": "setfield",
+            "url": "./setfield"
+        },
+        {
+            "label": "getfield",
+            "url": "./getfield"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/introspection/dynamicprops.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/introspection/dynamicprops.rs"
+    },
+    "gpu_residency": "`addprop` mutates host-side object metadata. GPU-resident numeric values assigned into dynamic properties follow the same residency behavior as ordinary object properties.",
+    "limitations": [
+        "Only scalar handle objects are supported.",
+        "Full MATLAB dynamic-property listener behavior for observable get/set events is not implemented.",
+        "Full dynamic-property persistence across external MATLAB MAT-file representations is not implemented."
+    ],
+    "key": "addprop",
+    "slug": "addprop",
+    "aliases": [],
+    "categoryPath": [
+        "introspection"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=addprop.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addprop.js","sourceRoot":"","sources":["../../../src/generated/builtins/addprop.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,SAAS;QACT,cAAc;QACd,kBAAkB;QAClB,QAAQ;QACR,iCAAiC;KAClC;IACD,SAAS,EAAE,yDAAyD;IACpE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,8EAA8E;KACxF;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,8CAA8C;QACtD,aAAa,EAAE,gGAAgG;KAChH;IACD,aAAa,EAAE,6LAA6L;IAC5M,WAAW,EAAE;QACX,sJAAsJ;QACtJ,oJAAoJ;QACpJ,uGAAuG;QACvG,oNAAoN;QACpN,0HAA0H;QAC1H,kFAAkF;KACnF;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,sHAAsH;YAC/H,QAAQ,EAAE,WAAW;SACtB;QACD;YACE,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,2DAA2D;YACpE,QAAQ,EAAE,iBAAiB;SAC5B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,2GAA2G;SACtH;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,6MAA6M;SACxN;QACD;YACE,UAAU,EAAE,iEAAiE;YAC7E,QAAQ,EAAE,sHAAsH;SACjI;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,oEAAoE;QAC7E,KAAK,EAAE,iHAAiH;KACzH;IACD,eAAe,EAAE,6KAA6K;IAC9L,aAAa,EAAE;QACb,2CAA2C;QAC3C,kGAAkG;QAClG,uGAAuG;KACxG;IACD,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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