runmat 0.4.10-dev.8 → 0.4.10-dev.9

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

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

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

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

package/dist/generated/builtins/ss.js

@@ -0,0 +1,131 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "ss",
+    "category": "control",
+    "keywords": [
+        "ss",
+        "state space",
+        "control system",
+        "state matrix",
+        "sample time"
+    ],
+    "summary": "Create a state-space model object from A, B, C, and D matrices.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`ss` constructs host-side metadata. If matrix inputs are gpuArray values, RunMat gathers them before validating dimensions and creating the object."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline",
+        "notes": "`ss` is not fused; it constructs a host-side object."
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::control::ss::tests",
+        "integration": "crates/runmat-vm/tests/control.rs"
+    },
+    "description": "`ss(A, B, C, D)` creates a lightweight state-space model object from finite real numeric matrices. `A` is the state matrix, `B` maps inputs to states, `C` maps states to outputs, and `D` is direct feedthrough.",
+    "behaviors": [
+        "Returns an object whose class name is `ss`.",
+        "Stores `A`, `B`, `C`, `D`, `Ts`, `InputDelay`, `OutputDelay`, `StateName`, `InputName`, and `OutputName` properties.",
+        "Preserves the input matrix orientations on the returned object.",
+        "Uses continuous-time defaults with `Ts` equal to `0`.",
+        "`ss(A, B, C, D, Ts)` stores a finite non-negative sample time.",
+        "`ss(A, B, C, D, 'Ts', Ts)` and `ss(A, B, C, D, 'SampleTime', Ts)` store a finite non-negative sample time.",
+        "Numeric scalar inputs are treated as 1-by-1 matrices and are accepted only when the resulting dimensions are consistent.",
+        "Complex, sparse, descriptor-form, uncertain, identified, and generalized models are not supported in this initial implementation."
+    ],
+    "examples": [
+        {
+            "description": "Creating a continuous-time state-space model",
+            "input": "A = [0 1; -2 -3];\nB = [0; 1];\nC = [1 0];\nD = 0;\nG = ss(A, B, C, D);\nclass(G)",
+            "output": "ans = \"ss\""
+        },
+        {
+            "description": "Reading stored state-space matrices",
+            "input": "G = ss([0 1; -2 -3], [0; 1], [1 0], 0);\nfprintf(\"%.0f %.0f %.0f %.0f %.0f %.0f\\n\", G.A(1), G.A(2), G.A(3), G.A(4), G.B(1), G.B(2));",
+            "output": "0 -2 1 -3 0 1"
+        },
+        {
+            "description": "Creating a discrete-time model",
+            "input": "G = ss(0.5, 1, 1, 0, 0.1);\nfprintf(\"%.1f\\n\", G.Ts);",
+            "output": "0.1"
+        },
+        {
+            "description": "Specifying sample time with a name-value pair",
+            "input": "G = ss(0.5, 1, 1, 0, 'SampleTime', 0.2);\nfprintf(\"%.1f\\n\", G.Ts);",
+            "output": "0.2"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `ss` simulate step or impulse responses?",
+            "answer": "No. This builtin constructs a state-space object. Response functions can add `ss` parsing separately."
+        },
+        {
+            "question": "Does `ss` accept complex or sparse matrices?",
+            "answer": "Not yet. Inputs must be finite real numeric scalars or dense matrices."
+        },
+        {
+            "question": "How are dimensions validated?",
+            "answer": "`A` must be n-by-n, `B` must be n-by-nu, `C` must be ny-by-n, and `D` must be ny-by-nu."
+        },
+        {
+            "question": "Will `ss(gpuArray(A), B, C, D)` return a gpuArray-backed object?",
+            "answer": "No. `ss` gathers gpuArray inputs and stores host tensors on the returned object."
+        }
+    ],
+    "links": [
+        {
+            "label": "tf",
+            "url": "./tf"
+        },
+        {
+            "label": "step",
+            "url": "./step"
+        },
+        {
+            "label": "impulse",
+            "url": "./impulse"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/control/ss.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/ss.rs"
+    },
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "G = ss(A, B, C, D)\nG = ss(A, B, C, D, Ts)\nG = ss(A, B, C, D, 'Ts', Ts)\nG = ss(A, B, C, D, 'SampleTime', Ts)",
+            "output": "G is an ss object."
+        },
+        "points": [
+            "`A`, `B`, `C`, and `D` must be finite real numeric scalars or dense matrices.",
+            "`Ts` is optional and must be a finite non-negative scalar.",
+            "The object stores matrices exactly in the provided orientation after gpuArray gathering."
+        ]
+    },
+    "validation": {
+        "summary": "`ss` validates finite real matrix inputs, state-space dimension consistency, supported name-value options, and sample-time constraints before constructing the host-side object. Unit and integration tests cover continuous and discrete constructors, property access, invalid dimensions, invalid sample times, descriptor signatures, and gpuArray gathering.",
+        "implementation": {
+            "label": "`crates/runmat-runtime/src/builtins/control/ss.rs`",
+            "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/control/ss.rs"
+        }
+    },
+    "gpu_residency": "`ss` is a host-side object constructor. gpuArray matrix inputs are gathered before object construction, and the returned state-space object does not live on the GPU.",
+    "key": "ss",
+    "slug": "ss",
+    "aliases": [],
+    "categoryPath": [
+        "control"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=ss.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ss.js","sourceRoot":"","sources":["../../../src/generated/builtins/ss.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,aAAa;QACb,gBAAgB;QAChB,cAAc;QACd,aAAa;KACd;IACD,SAAS,EAAE,iEAAiE;IAC5E,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,qJAAqJ;KAC/J;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,mNAAmN;IAClO,WAAW,EAAE;QACX,6CAA6C;QAC7C,sHAAsH;QACtH,iEAAiE;QACjE,uDAAuD;QACvD,gEAAgE;QAChE,4GAA4G;QAC5G,0HAA0H;QAC1H,mIAAmI;KACpI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,8CAA8C;YAC7D,OAAO,EAAE,mFAAmF;YAC5F,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,yIAAyI;YAClJ,QAAQ,EAAE,eAAe;SAC1B;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,yDAAyD;YAClE,QAAQ,EAAE,KAAK;SAChB;QACD;YACE,aAAa,EAAE,+CAA+C;YAC9D,OAAO,EAAE,uEAAuE;YAChF,QAAQ,EAAE,KAAK;SAChB;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,+CAA+C;YAC3D,QAAQ,EAAE,uGAAuG;SAClH;QACD;YACE,UAAU,EAAE,8CAA8C;YAC1D,QAAQ,EAAE,wEAAwE;SACnF;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,yFAAyF;SACpG;QACD;YACE,UAAU,EAAE,kEAAkE;YAC9E,QAAQ,EAAE,kFAAkF;SAC7F;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;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,oDAAoD;QAC7D,KAAK,EAAE,iGAAiG;KACzG;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,gHAAgH;YACzH,QAAQ,EAAE,oBAAoB;SAC/B;QACD,QAAQ,EAAE;YACR,+EAA+E;YAC/E,4DAA4D;YAC5D,0FAA0F;SAC3F;KACF;IACD,YAAY,EAAE;QACZ,SAAS,EAAE,mWAAmW;QAC9W,gBAAgB,EAAE;YAChB,OAAO,EAAE,oDAAoD;YAC7D,KAAK,EAAE,iGAAiG;SACzG;KACF;IACD,eAAe,EAAE,uKAAuK;IACxL,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,EAu1QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAua9D,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,EA02QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAwa9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -7096,6 +7096,25 @@ export const builtinManifest = [
         "summary": "Remove singleton (size-one) dimensions while preserving MATLAB vector semantics.",
         "exampleCount": 6
     },
+    {
+        "key": "ss",
+        "title": "ss",
+        "slug": "ss",
+        "aliases": [],
+        "category": "control",
+        "categoryPath": [
+            "control"
+        ],
+        "keywords": [
+            "ss",
+            "state space",
+            "control system",
+            "state matrix",
+            "sample time"
+        ],
+        "summary": "Create a state-space model object from A, B, C, and D matrices.",
+        "exampleCount": 4
+    },
     {
         "key": "stairs",
         "title": "stairs",
@@ -8887,6 +8906,7 @@ export const builtinDocLoaders = {
     "sqrt": () => import("./builtins/sqrt.js").then((mod) => mod.default),
     "square": () => import("./builtins/square.js").then((mod) => mod.default),
     "squeeze": () => import("./builtins/squeeze.js").then((mod) => mod.default),
+    "ss": () => import("./builtins/ss.js").then((mod) => mod.default),
     "stairs": () => import("./builtins/stairs.js").then((mod) => mod.default),
     "startswith": () => import("./builtins/startsWith.js").then((mod) => mod.default),
     "std": () => import("./builtins/std.js").then((mod) => mod.default),