runmat 0.5.2-dev.3 → 0.5.2-dev.4

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

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

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

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

package/dist/generated/builtins/rref.js

@@ -0,0 +1,133 @@
+// @generated by scripts/generate-builtins.cjs
+// Do not edit by hand.
+const builtinDoc = {
+    "title": "rref",
+    "category": "math/linalg/solve",
+    "keywords": [
+        "rref",
+        "reduced row echelon form",
+        "pivot columns",
+        "Gaussian elimination",
+        "tolerance",
+        "gpu"
+    ],
+    "summary": "Compute reduced row echelon form and MATLAB-style pivot column indices.",
+    "references": [],
+    "gpu_support": {
+        "elementwise": false,
+        "reduction": false,
+        "precisions": [
+            "f32",
+            "f64"
+        ],
+        "broadcasting": "none",
+        "notes": "Invokes the acceleration provider's rref hook when available; the current WGPU backend gathers to the host, runs the shared elimination implementation, and re-uploads R and pivcol to keep downstream residency intact."
+    },
+    "fusion": {
+        "elementwise": false,
+        "reduction": false,
+        "max_inputs": 1,
+        "constants": "inline"
+    },
+    "requires_feature": null,
+    "tested": {
+        "unit": "builtins::math::linalg::solve::rref::tests",
+        "gpu": "builtins::math::linalg::solve::rref::tests::rref_gpu_provider_round_trip",
+        "wgpu": "builtins::math::linalg::solve::rref::tests::rref_wgpu_matches_cpu"
+    },
+    "description": "`rref(A)` returns the reduced row echelon form of matrix `A`. `[R, pivcol] = rref(A)` also returns the 1-based pivot column indices as a row vector.",
+    "behaviors": [
+        "Supports real numeric, logical, integer, scalar, vector, matrix, and complex matrix inputs. Logical and integer inputs are promoted to double precision before elimination.",
+        "The optional second argument `rref(A, tol)` overrides the pivot tolerance. Tolerance must be a finite, non-negative real scalar.",
+        "When tolerance is omitted, RunMat uses MATLAB-compatible scaling: `max(size(A)) * eps(norm(A, inf))`.",
+        "Pivot search proceeds left to right and chooses the largest-magnitude entry in the remaining rows of the active column.",
+        "Pivot column indices in `pivcol` are MATLAB-style 1-based double values. If no pivots are found, `pivcol` has shape `1 x 0`.",
+        "Empty matrices and all-zero matrices return unchanged matrix-shaped output with no pivot columns.",
+        "Complex inputs use complex division and magnitudes during pivot selection and elimination."
+    ],
+    "examples": [
+        {
+            "description": "Computing reduced row echelon form",
+            "input": "A = [1 2; 3 4];\nR = rref(A)",
+            "output": "R =\n     1     0\n     0     1"
+        },
+        {
+            "description": "Returning pivot columns",
+            "input": "A = [1 2; 2 4];\n[R, pivcol] = rref(A)",
+            "output": "R =\n     1     2\n     0     0\npivcol =\n     1"
+        },
+        {
+            "description": "Applying an explicit tolerance",
+            "input": "A = diag([1, 1e-10]);\n[R, pivcol] = rref(A, 1e-9)",
+            "output": "R =\n     1     0\n     0     0\npivcol =\n     1"
+        },
+        {
+            "description": "Reducing a row vector",
+            "input": "v = [2 4 6];\nR = rref(v)",
+            "output": "R =\n     1     2     3"
+        },
+        {
+            "description": "Using rref with gpuArray data",
+            "input": "G = gpuArray([1 2; 3 4]);\n[R, pivcol] = rref(G);\nR_host = gather(R)\npiv_host = gather(pivcol)",
+            "output": "R_host =\n     1     0\n     0     1\npiv_host =\n     1     2"
+        }
+    ],
+    "faqs": [
+        {
+            "question": "How is the default tolerance chosen?",
+            "answer": "RunMat follows MATLAB's dense-matrix rule: `max(size(A)) * eps(norm(A, inf))`. Larger or more highly scaled matrices therefore receive a larger pivot cutoff."
+        },
+        {
+            "question": "What shape is `pivcol`?",
+            "answer": "`pivcol` is always a row vector of 1-based double indices. No pivots returns an empty row vector with shape `1 x 0`."
+        },
+        {
+            "question": "Does `rref` support complex matrices?",
+            "answer": "Yes. Complex values use magnitude-based pivoting and complex arithmetic for row normalization and elimination."
+        },
+        {
+            "question": "Will calling `rref` move GPU data back to the CPU?",
+            "answer": "Only when the active provider lacks a native implementation. The current WGPU backend gathers, computes on the host, and re-uploads both outputs so later GPU work can continue with resident tensors."
+        }
+    ],
+    "links": [
+        {
+            "label": "rank",
+            "url": "./rank"
+        },
+        {
+            "label": "pinv",
+            "url": "./pinv"
+        },
+        {
+            "label": "lu",
+            "url": "./lu"
+        },
+        {
+            "label": "qr",
+            "url": "./qr"
+        },
+        {
+            "label": "gather",
+            "url": "./gather"
+        }
+    ],
+    "source": {
+        "label": "crates/runmat-runtime/src/builtins/math/linalg/solve/rref.rs",
+        "url": "crates/runmat-runtime/src/builtins/math/linalg/solve/rref.rs"
+    },
+    "gpu_residency": "RunMat first offers `rref` to the active acceleration provider through the `rref` hook. Providers without a native implementation gather the input, run the shared host RREF algorithm, and upload both `R` and `pivcol` so downstream GPU kernels can continue without an explicit user-managed transfer.",
+    "gpu_behavior": [
+        "The current WGPU backend implements `rref` as a provider hook backed by host fallback and re-upload. The builtin is not fused into elementwise kernels; producers flush before `rref` runs, and both outputs are new resident GPU handles when the provider path is active."
+    ],
+    "key": "rref",
+    "slug": "rref",
+    "aliases": [],
+    "categoryPath": [
+        "math",
+        "linalg",
+        "solve"
+    ]
+};
+export default builtinDoc;
+//# sourceMappingURL=rref.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rref.js","sourceRoot":"","sources":["../../../src/generated/builtins/rref.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uBAAuB;AAIvB,MAAM,UAAU,GAAe;IAC7B,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,mBAAmB;IAC/B,UAAU,EAAE;QACV,MAAM;QACN,0BAA0B;QAC1B,eAAe;QACf,sBAAsB;QACtB,WAAW;QACX,KAAK;KACN;IACD,SAAS,EAAE,yEAAyE;IACpF,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE;QACb,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,KAAK;QAClB,YAAY,EAAE;YACZ,KAAK;YACL,KAAK;SACN;QACD,cAAc,EAAE,MAAM;QACtB,OAAO,EAAE,0NAA0N;KACpO;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,4CAA4C;QACpD,KAAK,EAAE,0EAA0E;QACjF,MAAM,EAAE,mEAAmE;KAC5E;IACD,aAAa,EAAE,sJAAsJ;IACrK,WAAW,EAAE;QACX,6KAA6K;QAC7K,kIAAkI;QAClI,uGAAuG;QACvG,yHAAyH;QACzH,8HAA8H;QAC9H,mGAAmG;QACnG,4FAA4F;KAC7F;IACD,UAAU,EAAE;QACV;YACE,aAAa,EAAE,oCAAoC;YACnD,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,iCAAiC;SAC5C;QACD;YACE,aAAa,EAAE,yBAAyB;YACxC,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,aAAa,EAAE,gCAAgC;YAC/C,OAAO,EAAE,oDAAoD;YAC7D,QAAQ,EAAE,mDAAmD;SAC9D;QACD;YACE,aAAa,EAAE,uBAAuB;YACtC,OAAO,EAAE,2BAA2B;YACpC,QAAQ,EAAE,yBAAyB;SACpC;QACD;YACE,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE,kGAAkG;YAC3G,QAAQ,EAAE,gEAAgE;SAC3E;KACF;IACD,MAAM,EAAE;QACN;YACE,UAAU,EAAE,sCAAsC;YAClD,QAAQ,EAAE,+JAA+J;SAC1K;QACD;YACE,UAAU,EAAE,yBAAyB;YACrC,QAAQ,EAAE,sHAAsH;SACjI;QACD;YACE,UAAU,EAAE,uCAAuC;YACnD,QAAQ,EAAE,gHAAgH;SAC3H;QACD;YACE,UAAU,EAAE,oDAAoD;YAChE,QAAQ,EAAE,wMAAwM;SACnN;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,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,MAAM;SACd;QACD;YACE,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,UAAU;SAClB;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8DAA8D;QACvE,KAAK,EAAE,8DAA8D;KACtE;IACD,eAAe,EAAE,4SAA4S;IAC7T,cAAc,EAAE;QACd,6QAA6Q;KAC9Q;IACD,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,SAAS,EAAE,EAAE;IACb,cAAc,EAAE;QACd,MAAM;QACN,QAAQ;QACR,OAAO;KACR;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,EA83QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAya9D,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,EAo5QjD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CA0a9D,CAAC;AAEF,eAAO,MAAM,4BAA4B,sEAC0C,CAAC"}

package/dist/generated/builtins-manifest.js

@@ -6517,6 +6517,28 @@ export const builtinManifest = [
         "summary": "Round values to nearest integers, decimal places, or significant digits with MATLAB-compatible modes.",
         "exampleCount": 5
     },
+    {
+        "key": "rref",
+        "title": "rref",
+        "slug": "rref",
+        "aliases": [],
+        "category": "math/linalg/solve",
+        "categoryPath": [
+            "math",
+            "linalg",
+            "solve"
+        ],
+        "keywords": [
+            "rref",
+            "reduced row echelon form",
+            "pivot columns",
+            "Gaussian elimination",
+            "tolerance",
+            "gpu"
+        ],
+        "summary": "Compute reduced row echelon form and MATLAB-style pivot column indices.",
+        "exampleCount": 5
+    },
     {
         "key": "save",
         "title": "save",
@@ -8897,6 +8919,7 @@ export const builtinDocLoaders = {
     "roots": () => import("./builtins/roots.js").then((mod) => mod.default),
     "rot90": () => import("./builtins/rot90.js").then((mod) => mod.default),
     "round": () => import("./builtins/round.js").then((mod) => mod.default),
+    "rref": () => import("./builtins/rref.js").then((mod) => mod.default),
     "save": () => import("./builtins/save.js").then((mod) => mod.default),
     "savepath": () => import("./builtins/savepath.js").then((mod) => mod.default),
     "sawtooth": () => import("./builtins/sawtooth.js").then((mod) => mod.default),