Skip to content
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

Mention inv in docstrings of factorizations that implement it #21891

Merged
merged 1 commit into from
May 16, 2017
Merged

Mention inv in docstrings of factorizations that implement it #21891

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
1 change: 1 addition & 0 deletions base/linalg/lu.jl
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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