Skip to content

Document mdivide_left and mdivide_right #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avehtari wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document mdivide_left and mdivide_right #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/functions-reference/complex_matrix_operations.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1296,6 +1296,26 @@ The right division of b by A; equivalently `b * inverse(A)`
The right division of B by A; equivalently `B * inverse(A)`
{{< since 2.30 >}}

#### Complex matrix division functions

The function `mdivide_right` is the function form of the operator `/`.

<!-- complex_row_vector; mdivide_right; (complex_row_vector b, complex_matrix A); -->
\index{{\tt \bfseries mdivide\_right }!{\tt (complex\_row\_vector b, complex\_matrix A): complex\_row\_vector}|hyperpage}

`complex_row_vector` **`mdivide_right`**`(complex_row_vector b, complex_matrix A)`<br>\newline
The right division of b by A; equivalently `b / A` and
`b * inverse(A)`
{{< since 2.30 >}}

<!-- complex_matrix; mdivide_right; (complex_matrix B, complex_matrix A); -->
\index{{\tt \bfseries mdivide\_right }!{\tt (complex\_matrix B, complex\_matrix A): complex\_matrix}|hyperpage}

`complex_matrix` **`mdivide_right`**`(complex_matrix B, complex_matrix A)`<br>\newline
The right division of B by A; equivalently `B / A` and
`B * inverse(A)`
{{< since 2.30 >}}

### Linear algebra functions

#### Trace
Expand Down
18 changes: 16 additions & 2 deletions src/functions-reference/functions_index.qmd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 45 additions & 8 deletions src/functions-reference/matrix_operations.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2034,16 +2034,53 @@ The right division of B by A; equivalently `B * inverse(A)`
\index{{\tt \bfseries operator\_left\_div }!{\tt (matrix A, vector b): vector}|hyperpage}

`vector` **`operator\`**`(matrix A, vector b)`<br>\newline
The left division of A by b; equivalently `inverse(A) * b`
The left division of b by A; equivalently `inverse(A) * b`
{{< since 2.18 >}}

<!-- matrix; operator\; (matrix A, matrix B); -->
\index{{\tt \bfseries operator\_left\_div }!{\tt (matrix A, matrix B): matrix}|hyperpage}

`matrix` **`operator\`**`(matrix A, matrix B)`<br>\newline
The left division of A by B; equivalently `inverse(A) * B`
The left division of B by A; equivalently `inverse(A) * B`
{{< since 2.18 >}}

#### General matrix division functions

The functions `mdivide_right` and `mdivide_left` are the function
forms of the operators `/` and `\`.

<!-- row_vector; mdivide_right; (row_vector b, matrix A); -->
\index{{\tt \bfseries mdivide\_right }!{\tt (row\_vector b, matrix A): row\_vector}|hyperpage}

`row_vector` **`mdivide_right`**`(row_vector b, matrix A)`<br>\newline
The right division of b by A; equivalently `b / A` and
`b * inverse(A)`
{{< since 2.0 >}}

<!-- matrix; mdivide_right; (matrix B, matrix A); -->
\index{{\tt \bfseries mdivide\_right }!{\tt (matrix B, matrix A): matrix}|hyperpage}

`matrix` **`mdivide_right`**`(matrix B, matrix A)`<br>\newline
The right division of B by A; equivalently `B / A` and
`B * inverse(A)`
{{< since 2.0 >}}

<!-- vector; mdivide_left; (matrix A, vector b); -->
\index{{\tt \bfseries mdivide\_left }!{\tt (matrix A, vector b): vector}|hyperpage}

`vector` **`mdivide_left`**`(matrix A, vector b)`<br>\newline
The left division of b by A; equivalently `A \ b` and
`inverse(A) * b`
{{< since 2.0 >}}

<!-- matrix; mdivide_left; (matrix A, matrix B); -->
\index{{\tt \bfseries mdivide\_left }!{\tt (matrix A, matrix B): matrix}|hyperpage}

`matrix` **`mdivide_left`**`(matrix A, matrix B)`<br>\newline
The left division of B by A; equivalently `A \ B` and
`inverse(A) * B`
{{< since 2.0 >}}


#### Lower-triangular matrix division functions

Expand Down Expand Up @@ -2101,19 +2138,19 @@ and stability for symmetric positive-definite matrix dividends. If
the matrix dividend argument is not symmetric and positive definite,
these will reject and print warnings.

<!-- matrix; mdivide_left_spd; (matrix A, vector b); -->
\index{{\tt \bfseries mdivide\_left\_spd }!{\tt (matrix A, vector b): matrix}|hyperpage}
<!-- vector; mdivide_left_spd; (matrix A, vector b); -->
\index{{\tt \bfseries mdivide\_left\_spd }!{\tt (matrix A, vector b): vector}|hyperpage}

`matrix` **`mdivide_left_spd`**`(matrix A, vector b)`<br>\newline
`vector` **`mdivide_left_spd`**`(matrix A, vector b)`<br>\newline
The left division of b by the symmetric, positive-definite matrix A;
algebraically equivalent to the less efficient and stable form
`inverse(A) * b`.
{{< since 2.12 >}}

<!-- vector; mdivide_left_spd; (matrix A, matrix B); -->
\index{{\tt \bfseries mdivide\_left\_spd }!{\tt (matrix A, matrix B): vector}|hyperpage}
<!-- matrix; mdivide_left_spd; (matrix A, matrix B); -->
\index{{\tt \bfseries mdivide\_left\_spd }!{\tt (matrix A, matrix B): matrix}|hyperpage}

`vector` **`mdivide_left_spd`**`(matrix A, matrix B)`<br>\newline
`matrix` **`mdivide_left_spd`**`(matrix A, matrix B)`<br>\newline
The left division of B by the symmetric, positive-definite matrix A;
algebraically equivalent to the less efficient and stable form
`inverse(A) * B`.
Expand Down