Skip to content

Change SOneTo indexing and support \ for svd(M; full=true) #618

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 3 commits into from
Jun 11, 2019
Merged

Change SOneTo indexing and support \ for svd(M; full=true) #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bea22b4
Support indexing with SOneTo
timholy Jun 10, 2019
519b15a
Support \ for svd(M; full=true)
timholy Jun 10, 2019
8b56c53
Add SOneTo indexing test for MMatrix
c42f Jun 11, 2019
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
4 changes: 3 additions & 1 deletion src/indexing.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ end
@inline index_size(::Size, ::Int) = Size()
@inline index_size(::Size, a::StaticArray) = Size(a)
@inline index_size(s::Size, ::Colon) = s
@inline index_size(s::Size, a::SOneTo{n}) where n = Size(n,)

@inline index_sizes(::S, inds...) where {S<:Size} = map(index_size, unpack_size(S), inds)

Expand All @@ -93,6 +94,7 @@ linear_index_size(ind_sizes::Type{<:Size}...) = _linear_index_size((), ind_sizes
_ind(i::Int, ::Int, ::Type{Int}) = :(inds[$i])
_ind(i::Int, j::Int, ::Type{<:StaticArray}) = :(inds[$i][$j])
_ind(i::Int, j::Int, ::Type{Colon}) = j
_ind(i::Int, j::Int, ::Type{<:SOneTo}) = j

################################
## Non-scalar linear indexing ##
Expand Down Expand Up @@ -213,7 +215,7 @@ end

# getindex

@propagate_inbounds function getindex(a::StaticArray, inds::Union{Int, StaticArray{<:Tuple, Int}, Colon}...)
@propagate_inbounds function getindex(a::StaticArray, inds::Union{Int, StaticArray{<:Tuple, Int}, SOneTo, Colon}...)
_getindex(a, index_sizes(Size(a), inds...), inds)
end

Expand Down
14 changes: 13 additions & 1 deletion src/svd.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,17 @@ end
function \(F::SVD, B::StaticVecOrMat)
sthresh = eps(F.S[1])
Sinv = map(s->s < sthresh ? zero(1/sthresh) : 1/s, F.S)
return F.Vt' * (Diagonal(Sinv) * (F.U'*B))
return transposemult(F.Vt, diagmult(Sinv, transposemult(F.U, B)))
end

transposemult(U, B) = transposemult(Size(U), Size(B), U, B)
function transposemult(sU, sB, U, B)
sU[1] == sB[1] && return U'*B
return U[SOneTo(sB[1]),:]'*B
end
diagmult(d, B) = diagmult(Size(d), Size(B), d, B)
function diagmult(sd, sB, d, B)
sd[1] == sB[1] && return Diagonal(d)*B
ind = SOneTo(sd[1])
return isa(B, AbstractVector) ? Diagonal(d)*B[ind] : Diagonal(d)*B[ind,:]
end
2 changes: 1 addition & 1 deletion test/abstractarray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ using StaticArrays, Test, LinearAlgebra

@test m[:, 1:2] isa Matrix
@test m[:, [true, false, false]] isa Matrix
@test m[:, SOneTo(2)] isa MMatrix{2, 2, Int}
@test m[:, SOneTo(2)] isa SMatrix{2, 2, Int}
Copy link
Member

Choose a reason for hiding this comment

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

I think this new behavior is preferable because it's more consistent. It's technically breaking, but I think the chances of this breaking the average user of StaticArrays are low.

@test m[:, :] isa SMatrix{2, 3, Int}
@test m[:, 1] isa SVector{2, Int}
@test m[2, :] isa SVector{3, Int}
Expand Down
8 changes: 8 additions & 0 deletions test/indexing.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ using StaticArrays, Test
@test (@inferred getindex(sm, :, SVector(2,1))) === @SMatrix [3 1; 4 2]
@test (@inferred getindex(sm, 1, :)) === @SVector [1,3]
@test (@inferred getindex(sm, :, 1)) === @SVector [1,2]

# SOneTo
@testinf sm[SOneTo(1),:] === @SMatrix [1 3]
@testinf sm[:,SOneTo(1)] === @SMatrix [1;2]
Copy link
Member

Choose a reason for hiding this comment

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

Could you add an equivalent test for MMatrix just to assert the MMatrix type is preserved?

[edit - I went ahead and added this]

end

@testset "2D getindex()/setindex! on MMatrix" begin
Expand All @@ -117,6 +121,10 @@ using StaticArrays, Test
@test (mm = MMatrix{2,2,Int}(undef); mm[:,SVector(2,1)] = sm[:,SVector(2,1)]; (@inferred getindex(mm, :, SVector(2,1)))::MMatrix == @MMatrix [3 1; 4 2])
@test (mm = MMatrix{2,2,Int}(undef); mm[1,:] = sm[1,:]; (@inferred getindex(mm, 1, :))::MVector == @MVector [1,3])
@test (mm = MMatrix{2,2,Int}(undef); mm[:,1] = sm[:,1]; (@inferred getindex(mm, :, 1))::MVector == @MVector [1,2])

# SOneTo
@test (mm = MMatrix{2,2,Int}(undef); mm[SOneTo(1),:] = sm[SOneTo(1),:]; (@inferred getindex(mm, SOneTo(1), :))::MMatrix == @MMatrix [1 3])
@test (mm = MMatrix{2,2,Int}(undef); mm[:,SOneTo(1)] = sm[:,SOneTo(1)]; (@inferred getindex(mm, :, SOneTo(1)))::MMatrix == @MMatrix [1;2])
end

@testset "3D scalar indexing" begin
Expand Down
23 changes: 22 additions & 1 deletion test/svd.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ using StaticArrays, Test, LinearAlgebra
m3 = @SMatrix Float64[3 9 4; 6 6 2; 3 7 9]
m3c = ComplexF64.(m3)
m23 = @SMatrix Float64[3 9 4; 6 6 2]
m_sing = @SMatrix [2.0 3.0 5.0; 4.0 9.0 10.0; 1.0 1.0 1.0]
m_sing = @SMatrix [2.0 3.0 5.0; 4.0 6.0 10.0; 1.0 1.0 1.0]
m_sing2 = @SMatrix [1 1; 1 0; 0 1]
v = @SVector [1, 2, 3]
v2 = @SVector [1, 2]
mc_sing = @SMatrix [1.0+0.1im 0 0; 2.0+0.2im 0 0; 3.0 0.1im 0]
mc_sing2 = @SMatrix [1.0+0.1im 0; 2.0+0.2im 1; 3.0 0.1im]
vc = @SVector [1.0f0+8.0f0im, 0.2f0im, 2.5f0]
vc2 = @SVector [1.0f0+8.0f0im, 0.2f0im]

@testset "svd" begin
@testinf svdvals(@SMatrix [2 0; 0 0])::StaticVector ≊ [2, 0]
Expand Down Expand Up @@ -58,11 +62,28 @@ using StaticArrays, Test, LinearAlgebra

@testinf svd(m3) \ v ≈ svd(Matrix(m3)) \ Vector(v)
@testinf svd(m_sing) \ v ≈ svd(Matrix(m_sing)) \ Vector(v)
@testinf svd(m_sing2) \ v ≈ svd(Matrix(m_sing2)) \ Vector(v)
@testinf svd(m_sing2') \ v2 ≈ svd(Matrix(m_sing2')) \ Vector(v2)
@testinf svd(m3) \ m23' ≈ svd(Matrix(m3)) \ Matrix(m23')
@testinf svd(m_sing) \ m23' ≈ svd(Matrix(m_sing)) \ Matrix(m23')
@testinf svd(m_sing2) \ m23' ≈ svd(Matrix(m_sing2)) \ Matrix(m23')
@testinf svd(m_sing2; full=Val(true)) \ v ≈ svd(Matrix(m_sing2); full=true) \ Vector(v)
@testinf svd(m_sing2'; full=Val(true)) \ v2 ≈ svd(Matrix(m_sing2'); full=true) \ Vector(v2)
@testinf svd(m_sing2; full=Val(true)) \ m23' ≈ svd(Matrix(m_sing2); full=true) \ Matrix(m23')
@testinf svd(m_sing2'; full=Val(true)) \ m23 ≈ svd(Matrix(m_sing2'); full=true) \ Matrix(m23)

@testinf svd(mc_sing) \ v ≈ svd(Matrix(mc_sing)) \ Vector(v)
@testinf svd(mc_sing) \ vc ≈ svd(Matrix(mc_sing)) \ Vector(vc)
@testinf svd(mc_sing) \ m23' ≈ svd(Matrix(mc_sing)) \ Matrix(m23')
@testinf svd(mc_sing2) \ v ≈ svd(Matrix(mc_sing2)) \ Vector(v)
@testinf svd(mc_sing2) \ vc ≈ svd(Matrix(mc_sing2)) \ Vector(vc)
@testinf svd(mc_sing2') \ vc2 ≈ svd(Matrix(mc_sing2')) \ Vector(vc2)
@testinf svd(mc_sing2) \ m23' ≈ svd(Matrix(mc_sing2)) \ Matrix(m23')
@testinf svd(mc_sing2') \ m23 ≈ svd(Matrix(mc_sing2')) \ Matrix(m23)
@testinf svd(mc_sing2; full=Val(true)) \ v ≈ svd(Matrix(mc_sing2); full=true) \ Vector(v)
@testinf svd(mc_sing2; full=Val(true)) \ vc ≈ svd(Matrix(mc_sing2); full=true) \ Vector(vc)
@testinf svd(mc_sing2'; full=Val(true)) \ vc2 ≈ svd(Matrix(mc_sing2'); full=true) \ Vector(vc2)
@testinf svd(mc_sing2; full=Val(true)) \ m23' ≈ svd(Matrix(mc_sing2); full=true) \ Matrix(m23')
@testinf svd(mc_sing2'; full=Val(true)) \ m23 ≈ svd(Matrix(mc_sing2'); full=true) \ Matrix(m23)
end
end