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

package/dist/generated/builtins/fitlm.js

@@ -0,0 +1,101 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "fitlm",
+    "category": "stats/ml",
+    "keywords": [
+        "fitlm",
+        "linear model",
+        "regression",
+        "least squares",
+        "statistics",
+        "machine learning"
+    ],
+    "summary": "Fit an ordinary least-squares linear regression model.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "GPU inputs are gathered to host. Linear-model fitting runs on CPU."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "none"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::stats::ml::linear_model::tests",
+        "integration": "crates/runmat-vm/tests/stats_ml.rs"
+    },
+    "description": "`fitlm` fits an ordinary least-squares linear regression model from a numeric predictor matrix or table and returns a `LinearModel` object.",
+    "behaviors": [
+        "`fitlm(X,y)` fits a model with an intercept and one linear term per predictor column.",
+        "Table input uses the last variable as the response by default, or the response from a response name, formula, or `ResponseVar` option.",
+        "Additive table formulas such as `Y ~ A + B` are supported for numeric predictors.",
+        "Matrix model specifications `constant`, `linear`, `interactions`, `purequadratic`, and `quadratic` are supported.",
+        "Rows containing `NaN` in predictors, response, or zero weights are omitted before fitting; `Inf` values are rejected.",
+        "`Exclude` accepts logical masks or one-based numeric row indices. `Weights` accepts a numeric vector, and table input also accepts a weights variable name.",
+        "The returned model exposes `Coefficients`, `Fitted`, `Residuals.Raw`, `NumObservations`, `DFE`, `RMSE`, `Rsquared`, `Formula`, `PredictorNames`, and `ResponseName` properties.",
+        "The `Coefficients` table contains `Estimate`, `SE`, `tStat`, and `pValue` variables with coefficient names in `Properties.RowNames`.",
+        "Categorical predictors, robust regression, and Wilkinson interaction formula terms are not supported yet and raise explicit errors."
+    ],
+    "examples": [
+        {
+            "description": "Fit a matrix-input linear model",
+            "input": "X = [0; 1; 2; 3];\ny = [1; 3; 5; 7];\nmdl = fitlm(X, y);\nmdl.Coefficients.Estimate",
+            "output": "The coefficient estimates are approximately [1; 2]."
+        },
+        {
+            "description": "Fit and predict",
+            "input": "mdl = fitlm(X, y);\nyhat = predict(mdl, [4; 5])",
+            "output": "yhat is approximately [9; 11]."
+        },
+        {
+            "description": "Fit a named table formula",
+            "input": "T = table(A, B, Y, 'VariableNames', {'A','B','Y'});\nmdl = fitlm(T, 'Y ~ A + B')",
+            "output": "mdl uses A and B as predictors and Y as the response."
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `fitlm` add an intercept?",
+            "answer": "Yes. The default model includes an intercept. Use the `Intercept` option or a no-intercept formula to omit it."
+        },
+        {
+            "question": "How are missing rows handled?",
+            "answer": "Rows with `NaN` in any active predictor or response are omitted before fitting, matching MATLAB's complete-observation behavior."
+        }
+    ],
+    "links": [
+        {
+            "label": "predict",
+            "url": "./predict"
+        },
+        {
+            "label": "lasso",
+            "url": "./lasso"
+        },
+        {
+            "label": "ridge",
+            "url": "./ridge"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/stats/ml/linear_model.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/stats/ml/linear_model.rs"
+    },
+    "key": "fitlm",
+    "slug": "fitlm",
+    "aliases": [],
+    "categoryPath": [
+        "stats",
+        "ml"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=fitlm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fitlm.js","sourceRoot":"","sources":["../../../src/generated/builtins/fitlm.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,OAAO;QACP,cAAc;QACd,YAAY;QACZ,eAAe;QACf,YAAY;QACZ,kBAAkB;KACnB;IACD,SAAS,EAAE,wDAAwD;IACnE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,oEAAoE;KAC9E;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,oCAAoC;KACpD;IACD,aAAa,EAAE,6IAA6I;IAC5J,WAAW,EAAE;QACX,uFAAuF;QACvF,wIAAwI;QACxI,mFAAmF;QACnF,mHAAmH;QACnH,uHAAuH;QACvH,6JAA6J;QAC7J,iLAAiL;QACjL,sIAAsI;QACtI,qIAAqI;KACtI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,qFAAqF;YAC9F,QAAQ,EAAE,qDAAqD;SAChE;QACD;YACE,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,iDAAiD;YAC1D,QAAQ,EAAE,gCAAgC;SAC3C;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,kFAAkF;YAC3F,QAAQ,EAAE,uDAAuD;SAClE;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,gCAAgC;YAC5C,QAAQ,EAAE,gHAAgH;SAC3H;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,kIAAkI;SAC7I;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,+DAA+D;QACxE,KAAK,EAAE,4GAA4G;KACpH;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,IAAI;KACL;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/flintmax.js

@@ -0,0 +1,71 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "flintmax",
+    "category": "math/elementwise",
+    "keywords": [
+        "flintmax",
+        "float",
+        "limits",
+        "integer precision"
+    ],
+    "summary": "Return the largest consecutive integer in a floating-point class.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Scalar metadata query."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::math::elementwise::numeric_limits::tests",
+        "integration": null
+    },
+    "description": "`flintmax` returns 2^53 for `double` and 2^24 for `single`; the default is `double`.",
+    "behaviors": [
+        "Supports `double` and `single` class names."
+    ],
+    "examples": [
+        {
+            "description": "Single precision flintmax",
+            "input": "flintmax('single')",
+            "output": "ans = 16777216"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "What does flint mean?",
+            "answer": "It is the largest consecutive integer exactly representable in the floating-point format."
+        }
+    ],
+    "links": [
+        {
+            "label": "realmax",
+            "url": "./realmax"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/math/elementwise/numeric_limits.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/math/elementwise/numeric_limits.rs"
+    },
+    "gpu_residency": "The result is host-resident.",
+    "gpu_behavior": [
+        "No GPU kernels are launched."
+    ],
+    "key": "flintmax",
+    "slug": "flintmax",
+    "aliases": [],
+    "categoryPath": [
+        "math",
+        "elementwise"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=flintmax.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"flintmax.js","sourceRoot":"","sources":["../../../src/generated/builtins/flintmax.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,kBAAkB;IAC9B,UAAU,EAAE;QACV,UAAU;QACV,OAAO;QACP,QAAQ;QACR,mBAAmB;KACpB;IACD,SAAS,EAAE,mEAAmE;IAC9E,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,wBAAwB;KAClC;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,sFAAsF;IACrG,WAAW,EAAE;QACX,6CAA6C;KAC9C;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,oBAAoB;YAC7B,QAAQ,EAAE,gBAAgB;SAC3B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,uBAAuB;YACnC,QAAQ,EAAE,2FAA2F;SACtG;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,yEAAyE;QAClF,KAAK,EAAE,sHAAsH;KAC9H;IACD,eAAe,EAAE,8BAA8B;IAC/C,cAAc,EAAE;QACd,8BAA8B;KAC/B;IACD,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,MAAM;QACN,aAAa;KACd;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

@@ -0,0 +1,48 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "forward",
+    "category": "deep_learning",
+    "keywords": [
+        "forward",
+        "dlnetwork",
+        "deep learning",
+        "predict"
+    ],
+    "summary": "Run a supported dlnetwork forward pass.",
+    "description": "`forward(net,X)` evaluates a RunMat `dlnetwork` compatibility object over numeric predictor data.",
+    "behaviors": [
+        "Supports sequential feed-forward networks made from `featureInputLayer`, `fullyConnectedLayer`, `reluLayer`, `eluLayer`, `softmaxLayer`, `classificationLayer`, and `regressionLayer`.",
+        "Numeric matrix inputs are interpreted as observations in rows and predictors in columns.",
+        "`dlarray` inputs are unwrapped for normal execution, and the output is wrapped back into a `dlarray` preserving the input format metadata.",
+        "Inside `dlfeval`, host `dlarray` inputs and supported dlnetwork learnables are traced through fully-connected, ReLU, ELU, and softmax layers so scalar losses can be differentiated by `dlgradient`.",
+        "Name-value execution options, recurrent state outputs, branching DAG execution, custom layers, GPU-backed dlarray execution, and provider-resident autodiff are not implemented in this slice and raise explicit compatibility errors."
+    ],
+    "examples": [
+        {
+            "description": "Evaluate a feed-forward dlnetwork",
+            "input": "layers = {featureInputLayer(2,'Name','in'); fullyConnectedLayer(2,'Name','fc'); softmaxLayer('Name','prob')};\nnet = dlnetwork(layers);\ny = forward(net, [1 2; 3 4])",
+            "output": "y is a numeric matrix with one row per observation."
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported form",
+            "input": "Y = forward(net, X)",
+            "output": "Network scores or activations."
+        }
+    },
+    "gpu_residency": "`forward` currently gathers plain provider-resident `gpuArray` inputs to host before evaluating the supported layer chain outside autodiff. GPU-backed `dlarray` inputs are rejected before gather because native Deep Learning provider execution and tape kernels remain future acceleration work.",
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/deep_learning/model.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/deep_learning/model.rs"
+    },
+    "key": "forward",
+    "slug": "forward",
+    "aliases": [],
+    "categoryPath": [
+        "deep_learning"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=forward.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"forward.js","sourceRoot":"","sources":["../../../src/generated/builtins/forward.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,WAAW;QACX,eAAe;QACf,SAAS;KACV;IACD,SAAS,EAAE,yCAAyC;IACpD,aAAa,EAAE,mGAAmG;IAClH,WAAW,EAAE;QACX,wLAAwL;QACxL,0FAA0F;QAC1F,4IAA4I;QAC5I,sMAAsM;QACtM,wOAAwO;KACzO;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,mCAAmC;YAClD,OAAO,EAAE,uKAAuK;YAChL,QAAQ,EAAE,qDAAqD;SAChE;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE,qBAAqB;YAC9B,QAAQ,EAAE,gCAAgC;SAC3C;KACF;IACD,eAAe,EAAE,sSAAsS;IACvT,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;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/freeBoundary.d.ts

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

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

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

package/dist/generated/builtins/freeBoundary.js

@@ -0,0 +1,64 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "freeBoundary",
+    "category": "geometry/triangulation",
+    "keywords": [
+        "freeBoundary",
+        "DelaunayTri",
+        "triangulation",
+        "boundary",
+        "mesh"
+    ],
+    "summary": "Return boundary edges for a DelaunayTri triangulation.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`freeBoundary` operates on DelaunayTri object topology on the host."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "none"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::geometry::triangulation::tests",
+        "integration": null
+    },
+    "description": "`freeBoundary(dt)` returns an M-by-2 one-based edge list for edges used by only one triangle in a 2-D `DelaunayTri` object.",
+    "behaviors": [
+        "Accepts `DelaunayTri` objects from the legacy constructor.",
+        "Returns one-based vertex indices sorted deterministically by edge.",
+        "Returns a 0-by-2 tensor for empty triangulations."
+    ],
+    "examples": [
+        {
+            "description": "Find outer edges",
+            "input": "dt = DelaunayTri([0 0; 1 0; 0 1]);\ne = freeBoundary(dt);"
+        }
+    ],
+    "faqs": [],
+    "links": [
+        {
+            "label": "DelaunayTri",
+            "url": "./DelaunayTri"
+        }
+    ],
+    "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": "freeboundary",
+    "slug": "freeboundary",
+    "aliases": [],
+    "categoryPath": [
+        "geometry",
+        "triangulation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=freeBoundary.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"freeBoundary.js","sourceRoot":"","sources":["../../../src/generated/builtins/freeBoundary.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,cAAc;IACvB,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE;QACV,cAAc;QACd,aAAa;QACb,eAAe;QACf,UAAU;QACV,MAAM;KACP;IACD,SAAS,EAAE,wDAAwD;IACnE,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,qEAAqE;KAC/E;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,IAAI;KACpB;IACD,aAAa,EAAE,6HAA6H;IAC5I,WAAW,EAAE;QACX,4DAA4D;QAC5D,oEAAoE;QACpE,mDAAmD;KACpD;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,kBAAkB;YACjC,OAAO,EAAE,2DAA2D;SACrE;KACF;IACD,MAAM,EAAE,EAAE;IACV,OAAO,EAAE;QACP;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,eAAe;SACvB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,gEAAgE;QACzE,KAAK,EAAE,6GAA6G;KACrH;IACD,KAAK,EAAE,cAAc;IACrB,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;QACV,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/fsurf.js

@@ -0,0 +1,100 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "fsurf",
+    "category": "plotting",
+    "keywords": [
+        "fsurf",
+        "function surface",
+        "parametric surface",
+        "surface plot",
+        "matlab fsurf"
+    ],
+    "summary": "Plot scalar or parametric function surfaces.",
+    "hero_image": "https://web.runmatstatic.com/builtin-image/runmat-matlab-plot-surf-surface.webp",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`fsurf` samples arbitrary function handles on the host, then uses RunMat's existing surface renderer. There is no provider kernel because MATLAB callbacks are not GPU kernels."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 3,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::plotting::fsurf::tests",
+        "integration": "runmat-vm --test plotting::fsurf_dispatches_function_handle_surface_through_vm"
+    },
+    "description": "`fsurf` evaluates function handles over a rectangular two-variable domain and renders the sampled values as a 3-D surface. It supports ordinary `z = f(x,y)` surfaces and parametric surfaces supplied as `x = fx(u,v)`, `y = fy(u,v)`, and `z = fz(u,v)`.",
+    "behaviors": [
+        "`fsurf(f)` samples `f(x,y)` on the default `[-5 5 -5 5]` domain.",
+        "`fsurf(f, [xmin xmax ymin ymax])` uses an explicit rectangular domain; a two-element vector applies the same limits to both axes.",
+        "`fsurf(fx, fy, fz)` samples a parametric surface over the default parameter domain.",
+        "`fsurf(ax, ___)` renders into the requested axes and returns a function-surface graphics handle.",
+        "Function-handle outputs must be scalar real numeric values at every sampled point; non-finite explicit surface samples are preserved as surface discontinuities."
+    ],
+    "options": [
+        "`'MeshDensity'` controls the number of samples along each domain dimension. RunMat accepts integer values from 2 through 400.",
+        "Surface style name/value pairs such as `'DisplayName'`, `'FaceAlpha'`, `'FaceColor'`, `'EdgeColor'`, `'Shading'`, `'Lighting'`, `'Visible'`, and `'Colormap'` use the same parsing path as `surf`."
+    ],
+    "examples": [
+        {
+            "description": "Plot a function surface over the default domain",
+            "input": "fsurf(@(x,y) sin(x) + cos(y));"
+        },
+        {
+            "description": "Set the domain and mesh density",
+            "input": "h = fsurf(@(x,y) x.^2 - y.^2, [-2 2 -1 1], 'MeshDensity', 75, 'DisplayName', 'saddle');"
+        },
+        {
+            "description": "Plot a parametric surface",
+            "input": "fx = @(u,v) cos(u).*sin(v);\nfy = @(u,v) sin(u).*sin(v);\nfz = @(u,v) cos(v);\nfsurf(fx, fy, fz, [0 2*pi 0 pi]);"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `fsurf` evaluate the function handle on the GPU?",
+            "answer": "No. MATLAB function handles can contain arbitrary user code, so RunMat samples them on the host and then hands the sampled surface to the plotting renderer."
+        },
+        {
+            "question": "What happens if the function returns a vector?",
+            "answer": "RunMat raises `RunMat:fsurf:EvaluationFailed`; each sampled point must produce one scalar numeric value."
+        }
+    ],
+    "links": [
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "mesh",
+            "url": "./mesh"
+        },
+        {
+            "label": "view",
+            "url": "./view"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/plotting/ops/fsurf.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/fsurf.rs"
+    },
+    "gpu_residency": "`fsurf` is a callback-sampling builtin. It creates a new sampled surface and does not preserve input residency, because the inputs are MATLAB function handles rather than numeric provider buffers.",
+    "gpu_behavior": [
+        "Callback sampling runs on the host.",
+        "The resulting surface uses the existing `runmat-plot` surface rendering path."
+    ],
+    "key": "fsurf",
+    "slug": "fsurf",
+    "aliases": [],
+    "categoryPath": [
+        "plotting"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=fsurf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fsurf.js","sourceRoot":"","sources":["../../../src/generated/builtins/fsurf.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE;QACV,OAAO;QACP,kBAAkB;QAClB,oBAAoB;QACpB,cAAc;QACd,cAAc;KACf;IACD,SAAS,EAAE,8CAA8C;IACzD,YAAY,EAAE,iFAAiF;IAC/F,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iLAAiL;KAC3L;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,kCAAkC;QAC1C,aAAa,EAAE,gFAAgF;KAChG;IACD,aAAa,EAAE,4PAA4P;IAC3Q,WAAW,EAAE;QACX,kEAAkE;QAClE,mIAAmI;QACnI,qFAAqF;QACrF,kGAAkG;QAClG,kKAAkK;KACnK;IACD,SAAS,EAAE;QACT,+HAA+H;QAC/H,oMAAoM;KACrM;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,iDAAiD;YAChE,OAAO,EAAE,gCAAgC;SAC1C;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,yFAAyF;SACnG;QACD;YACE,aAAa,EAAE,2BAA2B;YAC1C,OAAO,EAAE,kHAAkH;SAC5H;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,uDAAuD;YACnE,QAAQ,EAAE,8JAA8J;SACzK;QACD;YACE,UAAU,EAAE,gDAAgD;YAC5D,QAAQ,EAAE,0GAA0G;SACrH;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,4DAA4D;QACrE,KAAK,EAAE,yGAAyG;KACjH;IACD,eAAe,EAAE,sMAAsM;IACvN,cAAc,EAAE;QACd,qCAAqC;QACrC,+EAA+E;KAChF;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

@@ -0,0 +1,115 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "full",
+    "category": "array/creation",
+    "keywords": [
+        "full",
+        "sparse",
+        "dense",
+        "matrix",
+        "storage"
+    ],
+    "summary": "Convert sparse matrix storage to full storage.",
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "`full` densifies host sparse matrices. Already-full dense gpuArray handles remain resident because RunMat does not currently expose native sparse GPU storage."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline",
+        "notes": "Storage conversion executes outside numeric fusion."
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::array::creation::full::tests",
+        "integration": "crates/runmat-vm/tests/logic.rs::full_densifies_sparse_storage_through_vm_dispatch"
+    },
+    "description": "`A = full(S)` converts a RunMat sparse double matrix to dense full storage. Inputs that are already full numeric, logical, character, complex, or gpuArray values are returned unchanged.",
+    "behaviors": [
+        "`full(S)` converts `SparseTensor` values to dense double tensors with the same row and column shape.",
+        "Stored sparse values are materialized in column-major order and unstored entries become explicit zeros.",
+        "Empty sparse matrices such as `sparse(m,n)` become dense `m`-by-`n` zero tensors.",
+        "Dense numeric tensors, scalar numeric/logical values, logical arrays, character arrays, complex arrays, and dense `gpuArray` handles pass through unchanged.",
+        "Cells, structs, strings, objects, function handles, symbolic expressions, classes, and exceptions raise `RunMat:full:InvalidInput`."
+    ],
+    "examples": [
+        {
+            "description": "Convert sparse storage to a full matrix",
+            "input": "S = sparse([1; 3; 2], [1; 1; 2], [10; 30; 20], 3, 2);\nA = full(S)",
+            "output": "A = [10 0; 0 20; 30 0]"
+        },
+        {
+            "description": "Empty sparse matrices become dense zeros",
+            "input": "S = sparse(2, 3);\nA = full(S)",
+            "output": "A = [0 0 0; 0 0 0]"
+        },
+        {
+            "description": "Already-full arrays remain full",
+            "input": "A = full([1 0; 0 2])",
+            "output": "A = [1 0; 0 2]"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `full` change matrix values?",
+            "answer": "No. It changes sparse storage into dense storage while preserving shape and values. Unstored sparse entries become explicit zeros."
+        },
+        {
+            "question": "Does `full` gather dense gpuArray values?",
+            "answer": "No. Dense gpuArray handles are already full, so RunMat returns the existing GPU handle unchanged."
+        },
+        {
+            "question": "Can `full` create native sparse GPU output?",
+            "answer": "No. RunMat's current sparse matrices are host-resident, and `full` only materializes them as host dense tensors."
+        }
+    ],
+    "links": [
+        {
+            "label": "issparse",
+            "url": "./issparse"
+        },
+        {
+            "label": "nnz",
+            "url": "./nnz"
+        },
+        {
+            "label": "find",
+            "url": "./find"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/array/creation/full.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/array/creation/full.rs"
+    },
+    "syntax": {
+        "example": {
+            "description": "Supported form",
+            "input": "A = full(S)",
+            "output": "`A` is a full matrix with the same values as `S`."
+        },
+        "points": [
+            "`S` may be a sparse matrix or an already-full matrix value.",
+            "`full` has one input and one output."
+        ]
+    },
+    "gpu_residency": "Already-full GPU tensors remain on the GPU. Sparse host matrices are converted to host dense tensors.",
+    "key": "full",
+    "slug": "full",
+    "aliases": [],
+    "categoryPath": [
+        "array",
+        "creation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=full.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"full.js","sourceRoot":"","sources":["../../../src/generated/builtins/full.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE;QACV,MAAM;QACN,QAAQ;QACR,OAAO;QACP,QAAQ;QACR,SAAS;KACV;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,gKAAgK;KAC1K;IACD,QAAQ,EAAE;QACR,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,qDAAqD;KAC/D;IACD,kBAAkB,EAAE,IAAI;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,wCAAwC;QAChD,aAAa,EAAE,oFAAoF;KACpG;IACD,aAAa,EAAE,2LAA2L;IAC1M,WAAW,EAAE;QACX,sGAAsG;QACtG,yGAAyG;QACzG,mFAAmF;QACnF,8JAA8J;QAC9J,qIAAqI;KACtI;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,oEAAoE;YAC7E,QAAQ,EAAE,wBAAwB;SACnC;QACD;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,gCAAgC;YACzC,QAAQ,EAAE,oBAAoB;SAC/B;QACD;YACE,aAAa,EAAE,iCAAiC;YAChD,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,gBAAgB;SAC3B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,oIAAoI;SAC/I;QACD;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,mGAAmG;SAC9G;QACD;YACE,UAAU,EAAE,6CAA6C;YACzD,QAAQ,EAAE,kHAAkH;SAC7H;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACf;QACD;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6DAA6D;QACtE,KAAK,EAAE,0GAA0G;KAClH;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE,aAAa;YACtB,QAAQ,EAAE,mDAAmD;SAC9D;QACD,QAAQ,EAAE;YACR,6DAA6D;YAC7D,sCAAsC;SACvC;KACF;IACD,eAAe,EAAE,uGAAuG;IACxH,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,OAAO;QACP,UAAU;KACX;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/fullyConnectedLayer.js

@@ -0,0 +1,41 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "fullyConnectedLayer",
+    "category": "deep_learning",
+    "keywords": [
+        "fullyConnectedLayer",
+        "deep learning",
+        "layer"
+    ],
+    "summary": "Create a fully connected layer compatibility object.",
+    "description": "`fullyConnectedLayer(outputSize)` returns a RunMat Deep Learning Toolbox compatibility object with layer metadata and common name-value properties.",
+    "behaviors": [
+        "`outputSize` must be a positive integer.",
+        "`Name` and `Description` are stored as layer properties.",
+        "Additional common layer name-value options are preserved as properties for layer graph construction."
+    ],
+    "examples": [
+        {
+            "description": "Create A Named Layer",
+            "input": "layer = fullyConnectedLayer(10, 'Name', 'fc1')",
+            "output": "`layer` is a `nnet.cnn.layer.FullyConnectedLayer` compatibility object."
+        }
+    ],
+    "syntax": {
+        "example": {
+            "description": "Supported forms",
+            "input": "layer = fullyConnectedLayer(outputSize)\nlayer = fullyConnectedLayer(outputSize, Name, Value)",
+            "output": "Layer compatibility object."
+        }
+    },
+    "gpu_residency": "Layer construction is host metadata work and has no provider kernel.",
+    "key": "fullyconnectedlayer",
+    "slug": "fullyconnectedlayer",
+    "aliases": [],
+    "categoryPath": [
+        "deep_learning"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=fullyConnectedLayer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fullyConnectedLayer.js","sourceRoot":"","sources":["../../../src/generated/builtins/fullyConnectedLayer.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,qBAAqB;IAC9B,UAAU,EAAE,eAAe;IAC3B,UAAU,EAAE;QACV,qBAAqB;QACrB,eAAe;QACf,OAAO;KACR;IACD,SAAS,EAAE,sDAAsD;IACjE,aAAa,EAAE,qJAAqJ;IACpK,WAAW,EAAE;QACX,0CAA0C;QAC1C,0DAA0D;QAC1D,sGAAsG;KACvG;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,gDAAgD;YACzD,QAAQ,EAAE,yEAAyE;SACpF;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,aAAa,EAAE,iBAAiB;YAChC,OAAO,EAAE,+FAA+F;YACxG,QAAQ,EAAE,6BAA6B;SACxC;KACF;IACD,eAAe,EAAE,sEAAsE;IACvF,KAAK,EAAE,qBAAqB;IAC5B,MAAM,EAAE,qBAAqB;IAC7B,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,eAAe;KAChB;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}