runmat 0.4.6 → 0.4.7-dev.1

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

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

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

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

package/dist/generated/builtins/tf.js

@@ -0,0 +1,136 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "tf",
+    "category": "control",
+    "keywords": [
+        "tf",
+        "transfer function",
+        "control system",
+        "coefficient vector"
+    ],
+    "summary": "Create a SISO transfer-function object from numerator and denominator coefficient vectors.",
+    "references": [
+        "title: \"MATLAB tf documentation\"",
+        "title: \"Octave control package tf documentation\""
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`tf` constructs host-side metadata. If coefficient inputs are gpuArray values, RunMat gathers them before creating the object."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline",
+        "notes": "`tf` is not fused; it constructs a host-side object."
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::control::tf::tests",
+        "integration": "crates/runmat-vm/tests/control.rs"
+    },
+    "description": "`tf(num, den)` creates a scalar-input scalar-output transfer-function object from numeric numerator and denominator coefficient vectors. Coefficients follow MATLAB's polynomial convention: the first entry is the highest-order term and the last entry is the constant term.",
+    "behaviors": [
+        "Accepts numeric scalar, row-vector, or column-vector numerator coefficients.",
+        "Accepts numeric scalar, row-vector, or column-vector denominator coefficients.",
+        "Normalizes stored numerator and denominator coefficients to row vectors on the returned `tf` object.",
+        "Returns a lightweight object whose class name is `tf`.",
+        "Stores `Numerator`, `Denominator`, `Variable`, `Ts`, `InputDelay`, and `OutputDelay` properties on the object.",
+        "Uses continuous-time defaults: `Variable` is `'s'` and `Ts` is `0`.",
+        "`tf(num, den, Ts)` stores a finite non-negative sample time and defaults `Variable` to `'z'`.",
+        "`tf(num, den, 'Variable', variable)` accepts `variable` values `'s'`, `'p'`, `'z'`, `'q'`, `'z^-1'`, and `'q^-1'`.",
+        "`tf(num, den, 'Ts', Ts)` or `tf(num, den, 'SampleTime', Ts)` stores a finite non-negative sample time.",
+        "Complex coefficients are accepted and stored as complex row vectors.",
+        "Logical and integer coefficients are promoted to double precision."
+    ],
+    "examples": [
+        {
+            "description": "Creating a first-order continuous-time transfer function",
+            "input": "H = tf(20, [1 5]);\nclass(H)",
+            "output": "ans = \"tf\""
+        },
+        {
+            "description": "Creating a second-order transfer function",
+            "input": "H = tf([1 2], [1 3 2]);\nH.Numerator\nH.Denominator",
+            "output": "H.Numerator = [1 2]\nH.Denominator = [1 3 2]"
+        },
+        {
+            "description": "Creating a discrete-time transfer function",
+            "input": "H = tf(1, [1 -0.5], 0.1);\nH.Variable\nH.Ts",
+            "output": "H.Variable = 'z'\nH.Ts = 0.1"
+        },
+        {
+            "description": "Selecting the polynomial variable",
+            "input": "H = tf([1 0], [1 2 1], 'Variable', 'p');\nH.Variable",
+            "output": "H.Variable = 'p'"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `tf` evaluate the transfer function at frequency points?",
+            "answer": "No. This implementation only constructs the transfer-function object. Frequency-response helpers such as `bode`, `freqresp`, and `evalfr` are separate Control System Toolbox functions."
+        },
+        {
+            "question": "Does `tf` support MIMO transfer functions?",
+            "answer": "Not yet. This implementation supports scalar-input scalar-output systems created from numeric coefficient vectors."
+        },
+        {
+            "question": "Does `tf` implement `step`, `impulse`, or `bode`?",
+            "answer": "No. Those functions are not part of this builtin."
+        },
+        {
+            "question": "Can I pass matrices of coefficients?",
+            "answer": "No. Numerator and denominator inputs must be scalars or vectors."
+        },
+        {
+            "question": "Can the denominator be all zeros?",
+            "answer": "No. The denominator coefficient vector must contain at least one non-zero value."
+        }
+    ],
+    "links": [
+        {
+            "label": "polyval",
+            "url": "./polyval"
+        },
+        {
+            "label": "roots",
+            "url": "./roots"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/control/tf.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/tf.rs"
+    },
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "H = tf(num, den)\nH = tf(num, den, Ts)\nH = tf(num, den, 'Variable', variable)\nH = tf(num, den, 'Ts', Ts)",
+            "output": "H is a tf object."
+        },
+        "points": [
+            "`num` and `den` are numeric scalar, row-vector, or column-vector coefficient inputs. Coefficients are stored using MATLAB's highest-order-term-first polynomial convention.",
+            "`Ts` is an optional finite non-negative sample time. Positive sample times default the transfer-function variable to `'z'` unless `Variable` is provided explicitly.",
+            "`Variable` accepts `'s'`, `'p'`, `'z'`, `'q'`, `'z^-1'`, or `'q^-1'`. The denominator vector must contain at least one non-zero coefficient."
+        ]
+    },
+    "validation": {
+        "summary": "`tf` validates coefficient shapes, finite numeric values, supported variable names, and sample-time constraints before constructing the host-side transfer-function object. Unit and integration tests cover continuous and discrete constructors, row normalization, option parsing, and invalid denominator or matrix coefficient inputs.",
+        "implementation": {
+            "label": "`crates/runmat-runtime/src/builtins/control/tf.rs`",
+            "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/tf.rs"
+        }
+    },
+    "gpu_residency": "`tf` is a host-side object constructor. gpuArray coefficient inputs are gathered before object construction, and the returned transfer-function object does not live on the GPU.",
+    "key": "tf",
+    "slug": "tf",
+    "aliases": [],
+    "categoryPath": [
+        "control"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=tf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tf.js","sourceRoot":"","sources":["../../../src/generated/builtins/tf.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,IAAI;IACb,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE;QACV,IAAI;QACJ,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;KACrB;IACD,SAAS,EAAE,4FAA4F;IACvG,YAAY,EAAE;QACZ,oCAAoC;QACpC,oDAAoD;KACrD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,gIAAgI;KAC1I;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,sDAAsD;KAChE;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,8BAA8B;QACtC,aAAa,EAAE,mCAAmC;KACnD;IACD,aAAa,EAAE,iRAAiR;IAChS,WAAW,EAAE;QACX,8EAA8E;QAC9E,gFAAgF;QAChF,sGAAsG;QACtG,wDAAwD;QACxD,gHAAgH;QAChH,qEAAqE;QACrE,+FAA+F;QAC/F,oHAAoH;QACpH,wGAAwG;QACxG,sEAAsE;QACtE,oEAAoE;KACrE;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,0DAA0D;YACzE,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,2CAA2C;YAC1D,OAAO,EAAE,qDAAqD;YAC9D,QAAQ,EAAE,8CAA8C;SACzD;QACD;YACE,aAAa,EAAE,4CAA4C;YAC3D,OAAO,EAAE,6CAA6C;YACtD,QAAQ,EAAE,8BAA8B;SACzC;QACD;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,sDAAsD;YAC/D,QAAQ,EAAE,kBAAkB;SAC7B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,+DAA+D;YAC3E,QAAQ,EAAE,0LAA0L;SACrM;QACD;YACE,UAAU,EAAE,4CAA4C;YACxD,QAAQ,EAAE,oHAAoH;SAC/H;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,kEAAkE;SAC7E;QACD;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,kFAAkF;SAC7F;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,oDAAoD;QAC7D,KAAK,EAAE,iGAAiG;KACzG;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,4GAA4G;YACrH,QAAQ,EAAE,mBAAmB;SAC9B;QACD,QAAQ,EAAE;YACR,6KAA6K;YAC7K,sKAAsK;YACtK,8IAA8I;SAC/I;KACF;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,6UAA6U;QACxV,gBAAgB,EAAE;YAChB,OAAO,EAAE,oDAAoD;YAC7D,KAAK,EAAE,iGAAiG;SACzG;KACF;IACD,eAAe,EAAE,kLAAkL;IACnM,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,SAAS;KACV;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/generated/builtins-manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EAkyPjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA2Y9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}
+{"version":3,"file":"builtins-manifest.d.ts","sourceRoot":"","sources":["../../src/generated/builtins-manifest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,eAAO,MAAM,eAAe,EAAE,oBAAoB,EAozPjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA4Y9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -7352,6 +7352,24 @@ export const builtinManifest = [
         "summary": "Return a unique temporary file path in the system temp folder or a user-specified directory.",
         "exampleCount": 6
     },
+    {
+        "key": "tf",
+        "title": "tf",
+        "slug": "tf",
+        "aliases": [],
+        "category": "control",
+        "categoryPath": [
+            "control"
+        ],
+        "keywords": [
+            "tf",
+            "transfer function",
+            "control system",
+            "coefficient vector"
+        ],
+        "summary": "Create a SISO transfer-function object from numerator and denominator coefficient vectors.",
+        "exampleCount": 4
+    },
     {
         "key": "tic",
         "title": "tic",
@@ -8335,6 +8353,7 @@ export const builtinDocLoaders = {
     "tcpserver": () => import("./builtins/tcpserver.js").then((mod) => mod.default),
     "tempdir": () => import("./builtins/tempdir.js").then((mod) => mod.default),
     "tempname": () => import("./builtins/tempname.js").then((mod) => mod.default),
+    "tf": () => import("./builtins/tf.js").then((mod) => mod.default),
     "tic": () => import("./builtins/tic.js").then((mod) => mod.default),
     "timeit": () => import("./builtins/timeit.js").then((mod) => mod.default),
     "times": () => import("./builtins/times.js").then((mod) => mod.default),