Skip to content

Commit ec06c72

Browse files
araujomsKristofferC
authored andcommitted
add docstring
1 parent 38f61d8 commit ec06c72

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/matmul.jl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -593,8 +593,14 @@ Base.@constprop :aggressive function generic_matmatmul_wrapper!(C::StridedMatrix
593593
return _generic_matmatmul!(C, wrap(A, tA), wrap(B, tB), α, β)
594594
end
595595

596-
#if conjugate is true, computes A A' α + C β if aat is true, and A' A α + C β otherwise
597-
#if conjugate is false, computes A transpose(A) α + C β if aat is true, and tranpose(A) A α + C β otherwise
596+
"""
597+
generic_syrk!(C::StridedMatrix{T}, A::StridedVecOrMat{T}, conjugate::Bool, aat::Bool, α, β) where {T<:Number}
598+
599+
Computes syrk/herk for generic number types. If `conjugate` is false computes syrk, i.e.,
600+
``A transpose(A) α + C β`` if `aat` is true, and ``transpose(A) A α + C β`` otherwise.
601+
If `conjugate` is true computes herk, i.e., ``A A' α + C β`` if `aat` is true, and
602+
``A' A α + C β`` otherwise.
603+
"""
598604
function generic_syrk!(C::StridedMatrix{T}, A::StridedVecOrMat{T}, conjugate::Bool, aat::Bool, α, β) where {T<:Number}
599605
require_one_based_indexing(C, A)
600606
nC = checksquare(C)

0 commit comments

Comments
 (0)