runmat 0.4.1 → 0.4.2

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

@@ -0,0 +1 @@
+{"version":3,"file":"nextpow2.js","sourceRoot":"","sources":["../../../src/generated/builtins/nextpow2.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,cAAc;QACd,KAAK;QACL,cAAc;QACd,KAAK;KACN;IACD,SAAS,EAAE,+FAA+F;IAC1G,aAAa,EAAE,kNAAkN;IACjO,WAAW,EAAE;QACX,sDAAsD;QACtD,wDAAwD;QACxD,mBAAmB;QACnB,6DAA6D;QAC7D,iDAAiD;QACjD,wFAAwF;QACxF,uDAAuD;KACxD;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,6CAA6C;YAC5D,OAAO,EAAE,+CAA+C;SACzD;QACD;YACE,aAAa,EAAE,wCAAwC;YACvD,OAAO,EAAE,yBAAyB;YAClC,QAAQ,EAAE,eAAe;SAC1B;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,4EAA4E;YACxF,QAAQ,EAAE,6IAA6I;SACxJ;QACD;YACE,UAAU,EAAE,0CAA0C;YACtD,QAAQ,EAAE,0IAA0I;SACrJ;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,iGAAiG;SAC5G;KACF;IACD,OAAO,EAAE;QACP;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,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,cAAc,EAAE;QACd,MAAM;QACN,aAAa;KACd;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

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

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

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

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

package/dist/generated/builtins/peaks.js

@@ -0,0 +1,127 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "peaks",
+    "category": "array/creation",
+    "keywords": [
+        "peaks",
+        "sample data",
+        "test surface",
+        "demo",
+        "3d",
+        "surface"
+    ],
+    "summary": "Sample data: 3-D test surface on an n-by-n grid.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/peaks.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "Computed on the host CPU. Results are returned as host tensors."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 2,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::array::creation::peaks::tests",
+        "integration": null
+    },
+    "description": "`peaks` evaluates the following function over an n×n grid spanning [-3, 3] × [-3, 3]:\n\n```\nZ = 3*(1-x)^2 * exp(-x^2 - (y+1)^2)\n    - 10*(x/5 - x^3 - y^5) * exp(-x^2 - y^2)\n    - 1/3 * exp(-(x+1)^2 - y^2)\n```\n\nIt is commonly used to demonstrate 3-D surface plots. RunMat matches MATLAB's formula and default grid size.",
+    "behaviors": [
+        "`peaks` with no arguments returns a 49×49 matrix (MATLAB default).",
+        "`peaks(n)` returns an n×n matrix evaluated on an n-point grid from -3 to 3 on both axes.",
+        "`peaks(X, Y)` evaluates the formula at caller-supplied coordinate matrices and returns a Z matrix of the same size.",
+        "`[X, Y, Z] = peaks(…)` returns all three matrices — the X and Y coordinate grids and the computed Z surface.",
+        "`peaks(0)` returns an empty 0×0 matrix.",
+        "When exactly two outputs are requested, `[X, Y] = peaks(n)` returns only the coordinate grids without Z."
+    ],
+    "examples": [
+        {
+            "description": "Default 49×49 surface",
+            "input": "Z = peaks;\nsurf(Z);"
+        },
+        {
+            "description": "Custom grid size",
+            "input": "Z = peaks(30);\nsurf(Z);\ncolormap('parula');\ncolorbar;"
+        },
+        {
+            "description": "Full three-output form",
+            "input": "[X, Y, Z] = peaks(40);\nsurf(X, Y, Z);\nshading interp;\ncolorbar;\nview(45, 30);"
+        },
+        {
+            "description": "Caller-supplied coordinate matrices",
+            "input": "[X, Y] = meshgrid(linspace(-3, 3, 50), linspace(-3, 3, 50));\nZ = peaks(X, Y);\ncontourf(X, Y, Z);\ncolorbar;"
+        },
+        {
+            "description": "Combine with contour",
+            "input": "[X, Y, Z] = peaks(50);\nsubplot(1, 2, 1);\nsurf(X, Y, Z);\nview(3);\nsubplot(1, 2, 2);\ncontourf(X, Y, Z);\ncolorbar;"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Why is the default size 49?",
+            "answer": "MATLAB chose 49 as the default grid size for `peaks`. RunMat matches this specification."
+        },
+        {
+            "question": "Can I get the coordinate grids back as well as Z?",
+            "answer": "Yes. Use `[X, Y, Z] = peaks(n)` to retrieve all three matrices."
+        },
+        {
+            "question": "How do I move the result to the GPU?",
+            "answer": "Call `gpuArray(peaks(n))` if you need the output on the GPU. RunMat computes `peaks` on the host today."
+        },
+        {
+            "question": "What happens with `peaks(0)`?",
+            "answer": "`peaks(0)` returns an empty 0×0 tensor, consistent with how other array-creation functions handle a zero size."
+        }
+    ],
+    "links": [
+        {
+            "label": "surf",
+            "url": "./surf"
+        },
+        {
+            "label": "mesh",
+            "url": "./mesh"
+        },
+        {
+            "label": "contour",
+            "url": "./contour"
+        },
+        {
+            "label": "meshgrid",
+            "url": "./meshgrid"
+        },
+        {
+            "label": "linspace",
+            "url": "./linspace"
+        },
+        {
+            "label": "magic",
+            "url": "./magic"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/array/creation/peaks.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/array/creation/peaks.rs"
+    },
+    "gpu_residency": "`peaks` always runs on the host CPU today. If you need the result on the GPU, wrap the call in `gpuArray(...)`.",
+    "gpu_behavior": [
+        "RunMat computes `peaks` on the host and returns a host tensor. No acceleration provider hooks are defined for this builtin."
+    ],
+    "key": "peaks",
+    "slug": "peaks",
+    "categoryPath": [
+        "array",
+        "creation"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=peaks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"peaks.js","sourceRoot":"","sources":["../../../src/generated/builtins/peaks.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE;QACV,OAAO;QACP,aAAa;QACb,cAAc;QACd,MAAM;QACN,IAAI;QACJ,SAAS;KACV;IACD,SAAS,EAAE,kDAAkD;IAC7D,YAAY,EAAE;QACZ,sDAAsD;KACvD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,iEAAiE;KAC3E;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,yCAAyC;QACjD,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,uUAAuU;IACtV,WAAW,EAAE;QACX,oEAAoE;QACpE,0FAA0F;QAC1F,qHAAqH;QACrH,8GAA8G;QAC9G,yCAAyC;QACzC,0GAA0G;KAC3G;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,uBAAuB;YACtC,OAAO,EAAE,sBAAsB;SAChC;QACD;YACE,aAAa,EAAE,kBAAkB;YACjC,OAAO,EAAE,0DAA0D;SACpE;QACD;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,mFAAmF;SAC7F;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,+GAA+G;SACzH;QACD;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,uHAAuH;SACjI;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,6BAA6B;YACzC,QAAQ,EAAE,0FAA0F;SACrG;QACD;YACE,UAAU,EAAE,mDAAmD;YAC/D,QAAQ,EAAE,iEAAiE;SAC5E;QACD;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,yGAAyG;SACpH;QACD;YACE,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,gHAAgH;SAC3H;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,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,YAAY;SACpB;QACD;YACE,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS;SACjB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,KAAK,EAAE,2GAA2G;KACnH;IACD,eAAe,EAAE,iHAAiH;IAClI,cAAc,EAAE;QACd,6HAA6H;KAC9H;IACD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,OAAO;IACf,cAAc,EAAE;QACd,OAAO;QACP,UAAU;KACX;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,EA2zMjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAgV9D,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,EAi8MjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAuV9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -403,6 +403,25 @@ export const builtinManifest = [
         "summary": "Create bar charts for categorical comparisons, grouped series, stacked values, and MATLAB `bar` workflows.",
         "exampleCount": 3
     },
+    {
+        "key": "blackman",
+        "title": "blackman",
+        "slug": "blackman",
+        "category": "math/signal",
+        "categoryPath": [
+            "math",
+            "signal"
+        ],
+        "keywords": [
+            "blackman",
+            "window",
+            "signal processing",
+            "dsp",
+            "fft"
+        ],
+        "summary": "Generate a Blackman window as an N-by-1 real column vector.",
+        "exampleCount": 3
+    },
     {
         "key": "box",
         "title": "box",
@@ -1162,6 +1181,26 @@ export const builtinManifest = [
         "summary": "Cumulative sum of scalars, vectors, matrices, or N-D tensors.",
         "exampleCount": 5
     },
+    {
+        "key": "datetime",
+        "title": "datetime",
+        "slug": "datetime",
+        "category": "datetime",
+        "categoryPath": [
+            "datetime"
+        ],
+        "keywords": [
+            "datetime",
+            "date",
+            "time",
+            "serial date number",
+            "datenum",
+            "Format",
+            "MATLAB compatibility"
+        ],
+        "summary": "Create MATLAB-compatible datetime arrays from components, text, or serial date numbers.",
+        "exampleCount": 6
+    },
     {
         "key": "deconv",
         "title": "deconv",
@@ -1376,6 +1415,24 @@ export const builtinManifest = [
         "summary": "Convert numeric values, logical masks, characters, and gpuArray handles to double precision.",
         "exampleCount": 7
     },
+    {
+        "key": "duration",
+        "title": "duration",
+        "slug": "duration",
+        "category": "datetime",
+        "categoryPath": [
+            "datetime"
+        ],
+        "keywords": [
+            "duration",
+            "elapsed time",
+            "time span",
+            "Format",
+            "MATLAB compatibility"
+        ],
+        "summary": "Create MATLAB-compatible duration arrays from hour, minute, and second components.",
+        "exampleCount": 4
+    },
     {
         "key": "eig",
         "title": "eig",
@@ -2363,6 +2420,44 @@ export const builtinManifest = [
         "summary": "Element-wise greater-than comparison for scalars, arrays, strings, and gpuArray inputs.",
         "exampleCount": 6
     },
+    {
+        "key": "hamming",
+        "title": "hamming",
+        "slug": "hamming",
+        "category": "math/signal",
+        "categoryPath": [
+            "math",
+            "signal"
+        ],
+        "keywords": [
+            "hamming",
+            "window",
+            "signal processing",
+            "dsp",
+            "fft"
+        ],
+        "summary": "Generate a Hamming window as an N-by-1 real column vector.",
+        "exampleCount": 2
+    },
+    {
+        "key": "hann",
+        "title": "hann",
+        "slug": "hann",
+        "category": "math/signal",
+        "categoryPath": [
+            "math",
+            "signal"
+        ],
+        "keywords": [
+            "hann",
+            "window",
+            "signal processing",
+            "dsp",
+            "fft"
+        ],
+        "summary": "Generate a Hann window as an N-by-1 real column vector.",
+        "exampleCount": 3
+    },
     {
         "key": "hist",
         "title": "hist",
@@ -3889,6 +3984,25 @@ export const builtinManifest = [
         "summary": "Element-wise inequality comparison for scalars, arrays, strings, and gpuArray inputs.",
         "exampleCount": 5
     },
+    {
+        "key": "nextpow2",
+        "title": "nextpow2",
+        "slug": "nextpow2",
+        "category": "math/elementwise",
+        "categoryPath": [
+            "math",
+            "elementwise"
+        ],
+        "keywords": [
+            "nextpow2",
+            "power of two",
+            "fft",
+            "zero padding",
+            "gpu"
+        ],
+        "summary": "Return the exponent p such that 2^p is the next power of two greater than or equal to abs(n).",
+        "exampleCount": 2
+    },
     {
         "key": "nnz",
         "title": "nnz",
@@ -4121,6 +4235,26 @@ export const builtinManifest = [
         "summary": "Suspend execution until the user presses a key or a specified time elapses.",
         "exampleCount": 5
     },
+    {
+        "key": "peaks",
+        "title": "peaks",
+        "slug": "peaks",
+        "category": "array/creation",
+        "categoryPath": [
+            "array",
+            "creation"
+        ],
+        "keywords": [
+            "peaks",
+            "sample data",
+            "test surface",
+            "demo",
+            "3d",
+            "surface"
+        ],
+        "summary": "Sample data: 3-D test surface on an n-by-n grid.",
+        "exampleCount": 5
+    },
     {
         "key": "permute",
         "title": "permute",
@@ -6482,6 +6616,7 @@ export const builtinDocLoaders = {
     "axis": () => import("./builtins/axis.js").then((mod) => mod.default),
     "bandwidth": () => import("./builtins/bandwidth.js").then((mod) => mod.default),
     "bar": () => import("./builtins/bar.js").then((mod) => mod.default),
+    "blackman": () => import("./builtins/blackman.js").then((mod) => mod.default),
     "box": () => import("./builtins/box.js").then((mod) => mod.default),
     "cat": () => import("./builtins/cat.js").then((mod) => mod.default),
     "cd": () => import("./builtins/cd.js").then((mod) => mod.default),
@@ -6521,6 +6656,7 @@ export const builtinDocLoaders = {
     "cummin": () => import("./builtins/cummin.js").then((mod) => mod.default),
     "cumprod": () => import("./builtins/cumprod.js").then((mod) => mod.default),
     "cumsum": () => import("./builtins/cumsum.js").then((mod) => mod.default),
+    "datetime": () => import("./builtins/datetime.js").then((mod) => mod.default),
     "deconv": () => import("./builtins/deconv.js").then((mod) => mod.default),
     "delete": () => import("./builtins/delete.js").then((mod) => mod.default),
     "det": () => import("./builtins/det.js").then((mod) => mod.default),
@@ -6532,6 +6668,7 @@ export const builtinDocLoaders = {
     "dlmwrite": () => import("./builtins/dlmwrite.js").then((mod) => mod.default),
     "dot": () => import("./builtins/dot.js").then((mod) => mod.default),
     "double": () => import("./builtins/double.js").then((mod) => mod.default),
+    "duration": () => import("./builtins/duration.js").then((mod) => mod.default),
     "eig": () => import("./builtins/eig.js").then((mod) => mod.default),
     "endswith": () => import("./builtins/endsWith.js").then((mod) => mod.default),
     "eq": () => import("./builtins/eq.js").then((mod) => mod.default),
@@ -6583,6 +6720,8 @@ export const builtinDocLoaders = {
     "gpuinfo": () => import("./builtins/gpuInfo.js").then((mod) => mod.default),
     "grid": () => import("./builtins/grid.js").then((mod) => mod.default),
     "gt": () => import("./builtins/gt.js").then((mod) => mod.default),
+    "hamming": () => import("./builtins/hamming.js").then((mod) => mod.default),
+    "hann": () => import("./builtins/hann.js").then((mod) => mod.default),
     "hist": () => import("./builtins/hist.js").then((mod) => mod.default),
     "histcounts": () => import("./builtins/histcounts.js").then((mod) => mod.default),
     "histcounts2": () => import("./builtins/histcounts2.js").then((mod) => mod.default),
@@ -6662,6 +6801,7 @@ export const builtinDocLoaders = {
     "mtimes": () => import("./builtins/mtimes.js").then((mod) => mod.default),
     "ndims": () => import("./builtins/ndims.js").then((mod) => mod.default),
     "ne": () => import("./builtins/ne.js").then((mod) => mod.default),
+    "nextpow2": () => import("./builtins/nextpow2.js").then((mod) => mod.default),
     "nnz": () => import("./builtins/nnz.js").then((mod) => mod.default),
     "norm": () => import("./builtins/norm.js").then((mod) => mod.default),
     "not": () => import("./builtins/not.js").then((mod) => mod.default),
@@ -6674,6 +6814,7 @@ export const builtinDocLoaders = {
     "pagefun": () => import("./builtins/pagefun.js").then((mod) => mod.default),
     "path": () => import("./builtins/path.js").then((mod) => mod.default),
     "pause": () => import("./builtins/pause.js").then((mod) => mod.default),
+    "peaks": () => import("./builtins/peaks.js").then((mod) => mod.default),
     "permute": () => import("./builtins/permute.js").then((mod) => mod.default),
     "pie": () => import("./builtins/pie.js").then((mod) => mod.default),
     "pinv": () => import("./builtins/pinv.js").then((mod) => mod.default),