Skip to content

Commit

Permalink
Merge pull request #21891 from JuliaLang/jrg/inv-fact-doc
Browse files Browse the repository at this point in the history
Mention `inv` in docstrings of factorizations that implement it
  • Loading branch information
Sacha0 authored May 16, 2017
2 parents 12bf0bc + 6f7c763 commit 6dc7512
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions base/linalg/lu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ The relationship between `F` and `A` is
|:---------------------------------|:-----|:-----------------------|
| [`/`](@ref) | ✓ | |
| [`\\`](@ref) | ✓ | ✓ |
| [`inv`](@ref) | ✓ | ✓ |
| [`det`](@ref) | ✓ | ✓ |
| [`logdet`](@ref) | ✓ | ✓ |
| [`logabsdet`](@ref) | ✓ | ✓ |
Expand Down
2 changes: 1 addition & 1 deletion base/linalg/qr.jl
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ The individual components of the factorization `F` can be accessed by indexing w
- `F[:p]`: the permutation vector of the pivot ([`QRPivoted`](@ref) only)
- `F[:P]`: the permutation matrix of the pivot ([`QRPivoted`](@ref) only)
The following functions are available for the `QR` objects: [`size`](@ref)
The following functions are available for the `QR` objects: [`inv`](@ref), [`size`](@ref),
and [`\\`](@ref). When `A` is rectangular, `\\` will return a least squares
solution and if the solution is not unique, the one with smallest norm is returned.
Expand Down
2 changes: 1 addition & 1 deletion base/sparse/cholmod.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1511,7 +1511,7 @@ have the type tag, it must still be symmetric or Hermitian.
A fill-reducing permutation is used. `F = ldltfact(A)` is most frequently
used to solve systems of equations `A*x = b` with `F\\b`. The returned
factorization object `F` also supports the methods [`diag`](@ref),
[`det`](@ref), and [`logdet`](@ref).
[`det`](@ref), [`logdet`](@ref), and [`inv`](@ref).
You can extract individual factors from `F` using `F[:L]`.
However, since pivoting is on by default, the factorization is internally
represented as `A == P'*L*D*L'*P` with a permutation matrix `P`;
Expand Down

0 comments on commit 6dc7512

Please sign in to comment.