Skip to content

Commit a3c2681

Browse files
authored
Fix docstring for reflectorApply! (#1301)
The `τ` should go between the vectors. This can be confirmed from applying the reflector to a matrix of quaternions.
1 parent b5cc56a commit a3c2681

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/generic.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1758,7 +1758,7 @@ end
17581758
"""
17591759
reflectorApply!(x, τ, A)
17601760
1761-
Multiplies `A` in-place by a Householder reflection on the left. It is equivalent to `A .= (I - conj(τ)*[1; x[2:end]]*[1; x[2:end]]')*A`.
1761+
Multiplies `A` in-place by a Householder reflection on the left. It is equivalent to `A .= (I - [1; x[2:end]] * conj(τ) * [1; x[2:end]]') * A`.
17621762
"""
17631763
@inline function reflectorApply!(x::AbstractVector, τ::Number, A::AbstractVecOrMat)
17641764
require_one_based_indexing(x, A)

0 commit comments

Comments
 (0)