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

Jump to bottom

LinearAlgebra.givens with unitful arguments #36430

Merged
merged 7 commits into from
Jul 3, 2020
Merged

LinearAlgebra.givens with unitful arguments #36430

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
49944e3
LinearAlgebra.givens with unitful arguments (#36429)
KlausC Jun 25, 2020
3ab6d7f
added test cases
KlausC Jun 25, 2020
16c7b75
test cases for Complex of unitful
KlausC Jun 26, 2020
8deb6bc
additional test case
KlausC Jun 27, 2020
877ed9e
Update stdlib/LinearAlgebra/src/givens.jl
andreasnoack Jul 1, 2020
e551da7
removed ambigiuties in test type MockUnitful
KlausC Jul 2, 2020
fb45bb1
Merge branch 'krc/givensunitful' of https://github.com/KlausC/julia i…
KlausC Jul 2, 2020
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
15 changes: 14 additions & 1 deletion stdlib/LinearAlgebra/src/givens.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ end
convert(::Type{T}, r::T) where {T<:AbstractRotation} = r
convert(::Type{T}, r::AbstractRotation) where {T<:AbstractRotation} = T(r)

Givens(i1, i2, c, s) = Givens(i1, i2, promote(c, s)...)
Givens{T}(G::Givens{T}) where {T} = G
Givens{T}(G::Givens) where {T} = Givens(G.i1, G.i2, convert(T, G.c), convert(T, G.s))
Rotation{T}(R::Rotation{T}) where {T} = R
Expand Down Expand Up @@ -248,6 +249,18 @@ function givensAlgorithm(f::Complex{T}, g::Complex{T}) where T<:AbstractFloat
return cs, sn, r
end

# enable for unitful quantities
function givensAlgorithm(f::T, g::T) where T
fs = f / oneunit(T)
gs = g / oneunit(T)
typeof(fs) === T && typeof(gs) === T &&
!isa(fs, Union{AbstractFloat,Complex{<:AbstractFloat}}) &&
throw(MethodError(givensAlgorithm, (fs, gs)))

c, s, r = givensAlgorithm(fs, gs)
return c, s, r * oneunit(T)
end

givensAlgorithm(f, g) = givensAlgorithm(promote(float(f), float(g))...)

"""
Expand Down Expand Up @@ -280,7 +293,7 @@ function givens(f::T, g::T, i1::Integer, i2::Integer) where T
s = -conj(s)
i1,i2 = i2,i1
end
Givens(i1, i2, convert(T, c), convert(T, s)), r
Givens(i1, i2, c, s), r
end
"""
givens(A::AbstractArray, i1::Integer, i2::Integer, j::Integer) -> (G::Givens, r)
Expand Down
29 changes: 28 additions & 1 deletion stdlib/LinearAlgebra/test/givens.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
module TestGivens

using Test, LinearAlgebra, Random
using LinearAlgebra: rmul!, lmul!
using LinearAlgebra: rmul!, lmul!, Givens

# Test givens rotations
@testset for elty in (Float32, Float64, ComplexF32, ComplexF64)
Expand Down Expand Up @@ -70,4 +70,31 @@ using LinearAlgebra: rmul!, lmul!
end
end

# 36430
# dimensional correctness:
const BASE_TEST_PATH = joinpath(Sys.BINDIR, "..", "share", "julia", "test")
isdefined(Main, :Furlongs) || @eval Main include(joinpath($(BASE_TEST_PATH), "testhelpers", "Furlongs.jl"))
using .Main.Furlongs

@testset "testing dimensions with Furlongs" begin
@test_throws MethodError givens(Furlong(1.0), Furlong(2.0), 1, 2)
end

struct MockUnitful{T<:Number} <: Number
data::T
end
import Base: *, /, one, oneunit
*(a::MockUnitful, b::Number) = MockUnitful(a.data * b)
*(a::Number, b::MockUnitful) = MockUnitful(a * b.data)
/(a::MockUnitful, b::MockUnitful) = a.data / b.data
one(::Type{<:MockUnitful{T}}) where T = one(T)
oneunit(::Type{<:MockUnitful{T}}) where T = MockUnitful(one(T))

@testset "unitful givens rotation unitful $T " for T in (Float64, ComplexF64)
g, r = givens(MockUnitful(T(3)), MockUnitful(T(4)), 1, 2)
@test g.c ≈ 3/5
@test g.s ≈ 4/5
@test r.data ≈ 5.0
end

end # module TestGivens