fix some references in docs (#107)

Author: dkarrasch

docs/src/types.md

@@ -93,7 +93,7 @@ Base.:*(::LinearMap,::AbstractVector)
 Base.:*(::LinearMap,::AbstractMatrix)
 Base.:*(::AbstractMatrix,::LinearMap)
 LinearAlgebra.mul!(::AbstractVecOrMat,::LinearMap,::AbstractVector)
-LinearAlgebra.mul!(::AbstractMatrix,::LinearMap,::AbstractMatrix)
+LinearAlgebra.mul!(::AbstractVecOrMat,::LinearMap,::AbstractVector,::Number,::Number)
 *(::LinearAlgebra.AdjointAbsVec,::LinearMap)
 *(::LinearAlgebra.TransposeAbsVec,::LinearMap)
 ```

src/LinearMaps.jl

@@ -90,7 +90,37 @@ function Base.:(*)(A::LinearMap, x::AbstractVector)
 end
 
 """
-    mul!(C, A::LinearMap, B, α, β) -> C
+    mul!(Y::AbstractVecOrMat, A::LinearMap, B::AbstractVector) -> Y
+    mul!(Y::AbstractMatrix, A::LinearMap, B::AbstractMatrix) -> Y
+
+Calculates the action of the linear map `A` on the vector or matrix `B` and stores the result in `Y`,
+overwriting the existing value of `Y`. Note that `Y` must not be aliased with either `A` or `B`.
+
+## Examples
+```jldoctest; setup=(using LinearAlgebra, LinearMaps)
+julia> A=LinearMap([1.0 2.0; 3.0 4.0]); B=[1.0, 1.0]; Y = similar(B); mul!(Y, A, B);
+
+julia> Y
+2-element Array{Float64,1}:
+ 3.0
+ 7.0
+
+julia> A=LinearMap([1.0 2.0; 3.0 4.0]); B=[1.0 1.0; 1.0 1.0]; Y = similar(B); mul!(Y, A, B);
+
+julia> Y
+2×2 Array{Float64,2}:
+ 3.0  3.0
+ 7.0  7.0
+```
+"""
+function mul!(y::AbstractVecOrMat, A::LinearMap, x::AbstractVector)
+    check_dim_mul(y, A, x)
+    return _unsafe_mul!(y, A, x)
+end
+
+"""
+    mul!(C::AbstractVecOrMat, A::LinearMap, B::AbstractVector, α, β) -> C
+    mul!(C::AbstractMatrix, A::LinearMap, B::AbstractMatrix, α, β) -> C
 
 Combined inplace multiply-add ``A B α + C β``. The result is stored in `C` by overwriting it.
 Note that `C` must not be aliased with either `A` or `B`.
@@ -118,11 +148,6 @@ julia> C
  730.0  740.0
 ```
 """
-function mul!(y::AbstractVecOrMat, A::LinearMap, x::AbstractVector)
-    check_dim_mul(y, A, x)
-    return _unsafe_mul!(y, A, x)
-end
-
 function mul!(y::AbstractVecOrMat, A::LinearMap, x::AbstractVector, α::Number, β::Number)
     check_dim_mul(y, A, x)
     return _unsafe_mul!(y, A, x, α, β)
@@ -155,29 +180,6 @@ function _generic_mapvec_mul!(y, A, x, α, β)
 end
 
 # the following is of interest in, e.g., subspace-iteration methods
-"""
-    mul!(Y, A::LinearMap, B) -> Y
-
-Calculates the action of the linear map `A` on the vector or matrix `B` and stores the result in `Y`,
-overwriting the existing value of `Y`. Note that `Y` must not be aliased with either `A` or `B`.
-
-## Examples
-```jldoctest; setup=(using LinearAlgebra, LinearMaps)
-julia> A=LinearMap([1.0 2.0; 3.0 4.0]); B=[1.0, 1.0]; Y = similar(B); mul!(Y, A, B);
-
-julia> Y
-2-element Array{Float64,1}:
- 3.0
- 7.0
-
-julia> A=LinearMap([1.0 2.0; 3.0 4.0]); B=[1.0 1.0; 1.0 1.0]; Y = similar(B); mul!(Y, A, B);
-
-julia> Y
-2×2 Array{Float64,2}:
- 3.0  3.0
- 7.0  7.0
-```
-"""
 function mul!(Y::AbstractMatrix, A::LinearMap, X::AbstractMatrix)
     check_dim_mul(Y, A, X)
     return _generic_mapmat_mul!(Y, A, X)