From 4ec5446bff29a6e76fa63110578a9fe171c3641d Mon Sep 17 00:00:00 2001 From: Andreas Noack Date: Tue, 22 Apr 2025 22:14:03 +0200 Subject: [PATCH] Fix docstring for reflectorApply! MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The `τ` should go between the vectors. This can be confirmed from applying the reflector to a matrix of quaternions. --- src/generic.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/generic.jl b/src/generic.jl index ee12f370..688a5601 100644 --- a/src/generic.jl +++ b/src/generic.jl @@ -1758,7 +1758,7 @@ end """ reflectorApply!(x, τ, A) -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`. +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`. """ @inline function reflectorApply!(x::AbstractVector, τ::Number, A::AbstractVecOrMat) require_one_based_indexing(x, A)