Skip to content

Update the docstring of ldiv! #1344

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

Merged
merged 4 commits into from
May 11, 2025
Merged

Update the docstring of ldiv! #1344

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99d11d8
Update the docstring of ldiv!
WalterMadelim May 10, 2025
97ee7d2
Update the docstring of ldiv!
WalterMadelim May 10, 2025
d947bcd
Update docstring for ldiv!
WalterMadelim May 10, 2025
0df47a5
use similar
WalterMadelim May 10, 2025
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
16 changes: 8 additions & 8 deletions src/LinearAlgebra.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,13 +394,13 @@ control over the factorization of `A`.
```jldoctest
julia> A = [1 2.2 4; 3.1 0.2 3; 4 1 2];

julia> X = [1; 2.5; 3];
julia> B = [1, 2.5, 3];

julia> Y = zero(X);
julia> Y = similar(B); # use similar since there is no need to read from it

julia> ldiv!(Y, qr(A), X);
julia> ldiv!(Y, qr(A), B); # you may also try qr!(A) to further reduce allocation

julia> Y ≈ A\\X
julia> Y ≈ A \\ B
true
```
"""
Expand All @@ -426,13 +426,13 @@ control over the factorization of `A`.
```jldoctest
julia> A = [1 2.2 4; 3.1 0.2 3; 4 1 2];

julia> X = [1; 2.5; 3];
julia> B = [1, 2.5, 3];

julia> Y = copy(X);
julia> B0 = copy(B); # a backup copy to facilitate testing

julia> ldiv!(qr(A), X);
julia> ldiv!(lu(A), B); # you may also try lu!(A) to further reduce allocation

julia> X ≈ A\\Y
julia> B ≈ A \\ B0
true
```
"""
Expand Down