This site describes solve-engine 2.44.0, the version npm installs.
formatMatrixAligned
function formatMatrixAligned(m, settings?): string;Defined in: packages/engine/src/format/FormatEngine.ts:1179
Render a matrix as a multi-line, column-aligned block: one row per line (the
newline is where formatValue’s compact form writes ;), each column
right-padded to its widest cell, and every row wrapped in [ ... ]. For
display where a grid reads better than a line, e.g. a docs notepad or a REPL:
[ 1 2 ][ 30 4 ]This is deliberately separate from formatValue, whose single-line matrix form stays the stable, assertable text the API and the worker DTO use. A 1xN row vector is one line; an Nx1 column vector is N lines.
Under matrixResult.maxElements a larger one shows what fits (see
matrixPreview) and ends with a line saying how much was left out,
and 99,997 more or and 8 more rows; a matrix none of whose rows fits
is written as its shape, [2x5000 matrix].
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
m | MatrixData |
settings? | FormattingOverrides |
Returns
Section titled “Returns”string