Change the argument order in rankUpdate!. Fixes #36 (#38)

Author: andreasnoack

azure-pipelines.yml

@@ -5,7 +5,7 @@
 
 jobs:
 - job: Linux
-  
+
   pool:
     vmImage: 'Ubuntu 16.04'
 
@@ -26,7 +26,7 @@ jobs:
     displayName: 'Run the tests'
 
 - job: macOS
-  
+
   pool:
     vmImage: 'macOS-10.13'
 
@@ -49,7 +49,7 @@ jobs:
     displayName: 'Run the tests'
 
 - job: Windows
-  
+
   pool:
     vmImage: 'VS2017-Win2016'
 

src/cholesky.jl

@@ -8,7 +8,7 @@ function cholUnblocked!(A::AbstractMatrix{T}, ::Type{Val{:L}}) where T<:Number
         rmul!(a21, inv(real(A[1,1])))
 
         A22 = view(A, 2:n, 2:n)
-        rankUpdate!(-one(real(T)), a21, Hermitian(A22, :L))
+        rankUpdate!(Hermitian(A22, :L), a21, -1)
         cholUnblocked!(A22, Val{:L})
     end
     A
@@ -24,7 +24,7 @@ function cholBlocked!(A::AbstractMatrix{T}, ::Type{Val{:L}}, blocksize::Integer)
         rdiv!(A21, LowerTriangular(A11)')
 
         A22 = view(A, (blocksize + 1):n, (blocksize + 1):n)
-        rankUpdate!(-one(real(T)), A21, Hermitian(A22, :L))
+        rankUpdate!(Hermitian(A22, :L), A21, -1)
         cholBlocked!(A22, Val{:L}, blocksize)
     end
     A
@@ -44,7 +44,7 @@ function cholRecursive!(A::StridedMatrix{T}, ::Type{Val{:L}}, cutoff = 1) where
         rdiv!(A21, LowerTriangular(A11)')
 
         A22 = view(A, n2 + 1:n, n2 + 1:n)
-        rankUpdate!(-real(one(T)), A21, Hermitian(A22, :L))
+        rankUpdate!(Hermitian(A22, :L), A21, -1)
         cholRecursive!(A22, Val{:L}, cutoff)
     end
     return LowerTriangular(A)

src/householder.jl

@@ -45,7 +45,7 @@ function rmul!(A::StridedMatrix, H::Householder)
     x = A1*v
     axpy!(one(τ), a1, x)
     axpy!(-τ, x, a1)
-    rankUpdate!(-τ, x, v, A1)
+    rankUpdate!(A1, x, v, -τ)
     A
 end
 

src/juliaBLAS.jl

@@ -9,10 +9,10 @@ export rankUpdate!
 
 ## General
 ### BLAS
-rankUpdate!(α::T, x::StridedVector{T}, y::StridedVector{T}, A::StridedMatrix{T}) where {T<:BlasReal} = BLAS.ger!(α, x, y, A)
+rankUpdate!(A::StridedMatrix{T}, x::StridedVector{T}, y::StridedVector{T}, α::T) where {T<:BlasReal} = BLAS.ger!(α, x, y, A)
 
 ### Generic
-function rankUpdate!(α::Number, x::StridedVector, y::StridedVector, A::StridedMatrix)
+function rankUpdate!(A::StridedMatrix, x::StridedVector, y::StridedVector, α::Number)
     m, n = size(A, 1), size(A, 2)
     m == length(x) || throw(DimensionMismatch("x vector has wrong length"))
     n == length(y) || throw(DimensionMismatch("y vector has wrong length"))
@@ -24,12 +24,15 @@ function rankUpdate!(α::Number, x::StridedVector, y::StridedVector, A::StridedM
     end
 end
 
+# Deprecated 11 October 2018
+Base.@deprecate rankUpdate!(α::Number, x::StridedVector, y::StridedVector, A::StridedMatrix) rankUpdate!(A, x, y, α)
+
 ## Hermitian
-rankUpdate!(α::T, a::StridedVector{T}, A::HermOrSym{T,S}) where {T<:BlasReal,S<:StridedMatrix} = BLAS.syr!(A.uplo, α, a, A.data)
-rankUpdate!(a::StridedVector{T}, A::HermOrSym{T,S}) where {T<:BlasReal,S<:StridedMatrix} = rankUpdate!(one(T), a, A)
+rankUpdate!(A::HermOrSym{T,S}, a::StridedVector{T}, α::T) where {T<:BlasReal,S<:StridedMatrix} = BLAS.syr!(A.uplo, α, a, A.data)
+rankUpdate!(A::HermOrSym{T,S}, a::StridedVector{T}) where {T<:BlasReal,S<:StridedMatrix} = rankUpdate!(one(T), a, A)
 
 ### Generic
-function rankUpdate!(α::Real, a::StridedVector, A::Hermitian)
+function rankUpdate!(A::Hermitian, a::StridedVector, α::Real)
     n = size(A, 1)
     n == length(a) || throw(DimensionMismatch("a vector has wrong length"))
     @inbounds for j in 1:n
@@ -41,15 +44,18 @@ function rankUpdate!(α::Real, a::StridedVector, A::Hermitian)
     return A
 end
 
+# Deprecated 11 October 2018
+Base.@deprecate rankUpdate!(α::Real, a::StridedVector, A::Hermitian) rankUpdate!(A, a, α)
+
 # Rank k update
 ## Real
-rankUpdate!(α::T, A::StridedMatrix{T}, β::T, C::HermOrSym{T,S}) where {T<:BlasReal,S<:StridedMatrix} = syrk!(C.uplo, 'N', α, A, β, C.data)
+rankUpdate!(C::HermOrSym{T,S}, A::StridedMatrix{T}, α::T, β::T) where {T<:BlasReal,S<:StridedMatrix} = syrk!(C.uplo, 'N', α, A, β, C.data)
 
 ## Complex
-rankUpdate!(α::T, A::StridedMatrix{Complex{T}}, β::T, C::Hermitian{T,S}) where {T<:BlasReal,S<:StridedMatrix} = herk!(C.uplo, 'N', α, A, β, C.data)
+rankUpdate!(C::Hermitian{T,S}, A::StridedMatrix{Complex{T}}, α::T, β::T) where {T<:BlasReal,S<:StridedMatrix} = herk!(C.uplo, 'N', α, A, β, C.data)
 
 ### Generic
-function rankUpdate!(α::Real, A::StridedVecOrMat, C::Hermitian)
+function rankUpdate!(C::Hermitian, A::StridedVecOrMat, α::Real)
     n = size(C, 1)
     n == size(A, 1) || throw(DimensionMismatch("first dimension of A has wrong size"))
     @inbounds if C.uplo == 'L' # branch outside the loop to have larger loop to optimize
@@ -74,6 +80,10 @@ function rankUpdate!(α::Real, A::StridedVecOrMat, C::Hermitian)
     return C
 end
 
+# Deprecated 11 October 2018
+Base.@deprecate rankUpdate!(α::Real, A::StridedVecOrMat, C::Hermitian) rankUpdate!(C, A, α)
+Base.@deprecate rankUpdate!(α::Real, A::StridedVecOrMat, β::Real, C::Hermitian) rankUpdate!(C, A, α, β)
+
 # BLAS style mul!
 ## gemv
 mul!(y::StridedVector{T}, A::StridedMatrix{T}, x::StridedVector{T}, α::T, β::T) where {T<:BlasFloat} = gemv!('N', α, A, x, β, y)