Skip to content

Add uplo check to Bidiagonal, Symmetric, and Hermitian base constructors#42466

Merged
dkarrasch merged 1 commit intoJuliaLang:masterfrom
mcognetta:bidiag_uplo
Oct 5, 2021
Merged

Add uplo check to Bidiagonal, Symmetric, and Hermitian base constructors#42466
dkarrasch merged 1 commit intoJuliaLang:masterfrom
mcognetta:bidiag_uplo

Conversation

@mcognetta
Copy link
Copy Markdown
Contributor

@mcognetta mcognetta commented Oct 2, 2021

Currently, most, but not all, constructors for Bidiagonal, Symmetric, and Hermitian matrices perform an uplo check to see if it is valid (U/:U or L/:L). However, the base constructors do not.

This PR adds an uplo check to the base constructors and slightly expands the throw_uplo error message.

For example,

At HEAD:

julia> Bidiagonal(rand(2), rand(1), 'U')
2×2 Bidiagonal{Float64,Array{Float64,1}}:
 0.792414  0.848267
  ⋅        0.0463521

julia> Bidiagonal(rand(2), rand(1), 'X')
2×2 Bidiagonal{Float64,Array{Float64,1}}:
 0.916971   ⋅ 
 0.0       0.27176

julia> Bidiagonal(rand(2), rand(1), :U)
2×2 Bidiagonal{Float64,Array{Float64,1}}:
 0.810733  0.828368
  ⋅        0.628955

julia> Bidiagonal(rand(2), rand(1), :X)
ERROR: ArgumentError: uplo argument must be either :U (upper) or :L (lower)
Stacktrace:
 [1] throw_uplo() at /home/mc/github/julia/usr/share/julia/stdlib/v1.5/LinearAlgebra/src/LinearAlgebra.jl:257
 [2] char_uplo at /home/mc/github/julia/usr/share/julia/stdlib/v1.5/LinearAlgebra/src/LinearAlgebra.jl:242 [inlined]
 [3] Bidiagonal(::Array{Float64,1}, ::Array{Float64,1}, ::Symbol) at /home/mc/github/julia/usr/share/julia/stdlib/v1.5/LinearAlgebra/src/bidiag.jl:65
 [4] top-level scope at REPL[6]:1

This PR:

julia> Bidiagonal(rand(2), rand(1), 'U')
2×2 Bidiagonal{Float64, Vector{Float64}}:
 0.970627  0.828208
  ⋅        0.265786

julia> Bidiagonal(rand(2), rand(1), 'X')
ERROR: ArgumentError: uplo argument must be either :U/'U' (upper) or :L/'L' (lower)
Stacktrace:
 [1] throw_uplo()
   @ LinearAlgebra ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/LinearAlgebra.jl:265
 [2] Bidiagonal{Float64, Vector{Float64}}(dv::Vector{Float64}, ev::Vector{Float64}, uplo::Char)
   @ LinearAlgebra ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/bidiag.jl:13
 [3] Bidiagonal(dv::Vector{Float64}, ev::Vector{Float64}, uplo::Char)
   @ LinearAlgebra ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/bidiag.jl:69
 [4] top-level scope
   @ REPL[3]:1

julia> Bidiagonal(rand(2), rand(1), :U)
2×2 Bidiagonal{Float64, Vector{Float64}}:
 0.768898  0.461265
  ⋅        0.409974

julia> Bidiagonal(rand(2), rand(1), :X)
ERROR: ArgumentError: uplo argument must be either :U/'U' (upper) or :L/'L' (lower)
Stacktrace:
 [1] throw_uplo()
   @ LinearAlgebra ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/LinearAlgebra.jl:265
 [2] char_uplo
   @ ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/LinearAlgebra.jl:251 [inlined]
 [3] Bidiagonal
   @ ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/bidiag.jl:18 [inlined]
 [4] Bidiagonal(dv::Vector{Float64}, ev::Vector{Float64}, uplo::Symbol)
   @ LinearAlgebra ~/github/julia-dev/usr/share/julia/stdlib/v1.8/LinearAlgebra/src/bidiag.jl:76
 [5] top-level scope
   @ REPL[5]:1

And likewise for Symmetric and Hermitian.

@mcognetta mcognetta closed this Oct 2, 2021
@mcognetta mcognetta reopened this Oct 2, 2021
@mcognetta
Copy link
Copy Markdown
Contributor Author

mcognetta commented Oct 2, 2021

Buildbot errors seem unrelated.

@mcognetta mcognetta mentioned this pull request Oct 2, 2021
Closed
@kshyatt kshyatt added the linear algebra Linear algebra label Oct 4, 2021
@dkarrasch dkarrasch merged commit 3a2441d into JuliaLang:master Oct 5, 2021
dkarrasch
dkarrasch reviewed Oct 6, 2021
View reviewed changes
stdlib/LinearAlgebra/src/LinearAlgebra.jl
Comment on lines -266 to +265
@noinline throw_uplo() = throw(ArgumentError("uplo argument must be either :U (upper) or :L (lower)"))
@noinline throw_uplo() = throw(ArgumentError("uplo argument must be either :U/'U' (upper) or :L/'L' (lower)"))
Copy link
Copy Markdown
Member

@dkarrasch dkarrasch Oct 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andreasnoack I guess this change here should be reverted according to your comment that the Char representation is internal? The additional checks in this PR should be fine, though.

Copy link
Copy Markdown
Member

@andreasnoack andreasnoack Oct 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. I'd think so. At least temporarily until a decision has been made.

@dkarrasch dkarrasch mentioned this pull request Oct 6, 2021
Merged
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Feb 22, 2022
@mcognetta @LilithHafner
add uplo check to bidiag, sym, and herm main constructors (JuliaLang#…
a6364eb 
…42466)
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Mar 8, 2022
@mcognetta @LilithHafner
add uplo check to bidiag, sym, and herm main constructors (JuliaLang#…
c9f7b07 
…42466)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andreasnoack andreasnoack andreasnoack left review comments

@dkarrasch dkarrasch dkarrasch approved these changes

Assignees

No one assigned

Labels

linear algebra Linear algebra

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mcognetta @andreasnoack @dkarrasch @kshyatt