runmat 0.4.5-dev.0 → 0.4.5-dev.1

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

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

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

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

package/dist/generated/builtins/format.js

@@ -0,0 +1,147 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "format",
+    "category": "io",
+    "keywords": [
+        "format",
+        "display",
+        "precision",
+        "numeric",
+        "short",
+        "long",
+        "scientific",
+        "rational",
+        "hex"
+    ],
+    "summary": "Set the numeric display format for console output, controlling how floating-point numbers are shown.",
+    "references": [
+        "https://www.mathworks.com/help/matlab/ref/format.html"
+    ],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [],
+        "broadcasting": "none",
+        "notes": "format is a display-only setting; it has no effect on GPU computation or residency."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 0,
+        "constants": "none"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::io::format::tests",
+        "integration": null
+    },
+    "description": "`format` controls how numeric values appear in the Command Window. The setting is session-wide and persists until changed. Supported numeric precision modes: `short` (default), `long`, `shortE`, `longE`, `shortG`, `longG`, `rat`, and `hex`. Spacing modes `compact` and `loose` are accepted without error but are not yet implemented. Calling `format` without arguments resets to `short`.",
+    "behaviors": [
+        "Calling `format` with no arguments resets to the default `short` mode.",
+        "`format short` displays 4 decimal places in fixed notation for values in [0.001, 10000); uses scientific notation outside that range.",
+        "`format long` displays 15 decimal places in fixed notation for values in [0.001, 10000); uses 14-decimal scientific notation outside that range.",
+        "`format shortE` always uses scientific notation with 4 decimal places (e.g., `3.1416e+00`).",
+        "`format longE` always uses scientific notation with 14 decimal places.",
+        "`format shortG` uses the more compact of fixed/scientific notation with 5 significant digits, trimming trailing zeros.",
+        "`format longG` uses the more compact of fixed/scientific notation with 15 significant digits, trimming trailing zeros.",
+        "`format rat` approximates values as ratios of small integers using a tolerance of 5×10⁻⁷ (e.g., `355/113` for pi). `format rational` is accepted as an alias.",
+        "`format hex` displays the IEEE 754 double-precision hexadecimal bit pattern (e.g., `400921fb54442d18` for pi).",
+        "`format compact` and `format loose` are accepted without error for script compatibility but do not yet change output spacing.",
+        "The format setting applies to auto-print results and `disp` output. `fprintf`/`sprintf` use their own explicit format specifiers and are not affected.",
+        "Mode names are case-insensitive."
+    ],
+    "examples": [
+        {
+            "description": "Default short format",
+            "input": "format short\npi",
+            "output": "ans = 3.1416"
+        },
+        {
+            "description": "Long format for full precision",
+            "input": "format long\npi",
+            "output": "ans = 3.141592653589793"
+        },
+        {
+            "description": "Scientific notation with short precision",
+            "input": "format shortE\npi",
+            "output": "ans = 3.1416e+00"
+        },
+        {
+            "description": "Scientific notation with full precision",
+            "input": "format longE\npi",
+            "output": "ans = 3.14159265358979e+00"
+        },
+        {
+            "description": "Rational approximation",
+            "input": "format rat\npi",
+            "output": "ans = 355/113"
+        },
+        {
+            "description": "Hexadecimal IEEE 754 representation",
+            "input": "format hex\npi",
+            "output": "ans = 400921fb54442d18"
+        },
+        {
+            "description": "Resetting to default",
+            "input": "format\npi",
+            "output": "ans = 3.1416"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "Does `format` affect computation results?",
+            "answer": "No. `format` only changes how values are displayed. Internal precision is always IEEE 754 double."
+        },
+        {
+            "question": "Is the format setting persistent across cells?",
+            "answer": "Yes. The setting is stored per-session thread and remains active until changed by another `format` call."
+        },
+        {
+            "question": "What is the default format?",
+            "answer": "`format short` — 4 decimal places in fixed notation, falling back to scientific for very large or very small values."
+        },
+        {
+            "question": "Does `format` affect `disp`?",
+            "answer": "Yes. `disp` and auto-print both use the active format setting. `fprintf` and `sprintf` use their own explicit format specifiers and ignore this setting."
+        },
+        {
+            "question": "Are format mode names case-sensitive?",
+            "answer": "No. `format SHORT`, `format Short`, and `format short` are all equivalent."
+        },
+        {
+            "question": "What does `format rat` do for integers?",
+            "answer": "Integers are displayed as-is without a denominator (e.g., `42` rather than `42/1`). `format rational` is accepted as an alias for `format rat`."
+        }
+    ],
+    "links": [
+        {
+            "label": "disp",
+            "url": "./disp"
+        },
+        {
+            "label": "fprintf",
+            "url": "./fprintf"
+        },
+        {
+            "label": "sprintf",
+            "url": "./sprintf"
+        }
+    ],
+    "source": {
+        "label": "`crates/runmat-runtime/src/builtins/io/format.rs`",
+        "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/io/format.rs"
+    },
+    "gpu_residency": "`format` is a display-only setting with no effect on GPU residency or acceleration.",
+    "gpu_behavior": [
+        "`format` does not interact with GPU tensors. It only affects how values are rendered after being gathered to the host for display."
+    ],
+    "key": "format",
+    "slug": "format",
+    "aliases": [],
+    "categoryPath": [
+        "io"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=format.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/generated/builtins/format.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE;QACV,QAAQ;QACR,SAAS;QACT,WAAW;QACX,SAAS;QACT,OAAO;QACP,MAAM;QACN,YAAY;QACZ,UAAU;QACV,KAAK;KACN;IACD,SAAS,EAAE,sGAAsG;IACjH,YAAY,EAAE;QACZ,uDAAuD;KACxD;IACD,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,qFAAqF;KAC/F;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,6BAA6B;QACrC,aAAa,EAAE,IAAI;KACpB;IACD,aAAa,EAAE,oYAAoY;IACnZ,WAAW,EAAE;QACX,wEAAwE;QACxE,uIAAuI;QACvI,kJAAkJ;QAClJ,6FAA6F;QAC7F,wEAAwE;QACxE,wHAAwH;QACxH,wHAAwH;QACxH,+JAA+J;QAC/J,gHAAgH;QAChH,+HAA+H;QAC/H,wJAAwJ;QACxJ,kCAAkC;KACnC;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,kBAAkB;YAC3B,QAAQ,EAAE,cAAc;SACzB;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,iBAAiB;YAC1B,QAAQ,EAAE,yBAAyB;SACpC;QACD;YACE,aAAa,EAAE,0CAA0C;YACzD,OAAO,EAAE,mBAAmB;YAC5B,QAAQ,EAAE,kBAAkB;SAC7B;QACD;YACE,aAAa,EAAE,yCAAyC;YACxD,OAAO,EAAE,kBAAkB;YAC3B,QAAQ,EAAE,4BAA4B;SACvC;QACD;YACE,aAAa,EAAE,wBAAwB;YACvC,OAAO,EAAE,gBAAgB;YACzB,QAAQ,EAAE,eAAe;SAC1B;QACD;YACE,aAAa,EAAE,qCAAqC;YACpD,OAAO,EAAE,gBAAgB;YACzB,QAAQ,EAAE,wBAAwB;SACnC;QACD;YACE,aAAa,EAAE,sBAAsB;YACrC,OAAO,EAAE,YAAY;YACrB,QAAQ,EAAE,cAAc;SACzB;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,2CAA2C;YACvD,QAAQ,EAAE,mGAAmG;SAC9G;QACD;YACE,UAAU,EAAE,gDAAgD;YAC5D,QAAQ,EAAE,0GAA0G;SACrH;QACD;YACE,UAAU,EAAE,6BAA6B;YACzC,QAAQ,EAAE,sHAAsH;SACjI;QACD;YACE,UAAU,EAAE,8BAA8B;YAC1C,QAAQ,EAAE,0JAA0J;SACrK;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,4EAA4E;SACvF;QACD;YACE,UAAU,EAAE,yCAAyC;YACrD,QAAQ,EAAE,iJAAiJ;SAC5J;KACF;IACD,OAAO,EAAE;QACP;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;QACD;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,WAAW;SACnB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,mDAAmD;QAC5D,KAAK,EAAE,gGAAgG;KACxG;IACD,eAAe,EAAE,qFAAqF;IACtG,cAAc,EAAE;QACd,oIAAoI;KACrI;IACD,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,IAAI;KACL;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,EA8sOjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA8W9D,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,EAquOjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA+W9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -2289,6 +2289,29 @@ export const builtinManifest = [
         "summary": "Open a file and obtain a MATLAB-compatible file identifier.",
         "exampleCount": 7
     },
+    {
+        "key": "format",
+        "title": "format",
+        "slug": "format",
+        "aliases": [],
+        "category": "io",
+        "categoryPath": [
+            "io"
+        ],
+        "keywords": [
+            "format",
+            "display",
+            "precision",
+            "numeric",
+            "short",
+            "long",
+            "scientific",
+            "rational",
+            "hex"
+        ],
+        "summary": "Set the numeric display format for console output, controlling how floating-point numbers are shown.",
+        "exampleCount": 7
+    },
     {
         "key": "fprintf",
         "title": "fprintf",
@@ -7489,6 +7512,7 @@ export const builtinDocLoaders = {
     "flipud": () => import("./builtins/flipud.js").then((mod) => mod.default),
     "floor": () => import("./builtins/floor.js").then((mod) => mod.default),
     "fopen": () => import("./builtins/fopen.js").then((mod) => mod.default),
+    "format": () => import("./builtins/format.js").then((mod) => mod.default),
     "fprintf": () => import("./builtins/fprintf.js").then((mod) => mod.default),
     "fread": () => import("./builtins/fread.js").then((mod) => mod.default),
     "frewind": () => import("./builtins/frewind.js").then((mod) => mod.default),