search

JuliaLinearAlgebra / Octavian.jl

Multi-threaded BLAS-like library that provides pure Julia matrix multiplication
https://julialinearalgebra.github.io/Octavian.jl/stable/
Other
230 stars 18 forks source link

is this a typo in the doc of matmul! #81

Closed JianghuiDu closed 3 years ago

JianghuiDu commented 3 years ago 
matmul!(C, A, B[, α, β, max_threads])
Calculates C = α * A * B + β * C in place, overwriting the contents of A.

overwriting the contents of A.

Not C? Also why is there a bracket in side?

chriselrod commented 3 years ago

Yes, it is a typo. It overwrites the contents of C, not of A.

The brackets meant to say that those are optional positional arguments. Perhaps it should instead show their defaults to make that more clear.

JianghuiDu commented 3 years ago

Also I noticed that C, A and B must all be matrix in matmul!. Whereas the LinearAlgebra mul! accepts vectors for C and B. Is there a plan to support matrix vector multiplication?

chriselrod commented 3 years ago

Yes. It should be much simpler than matrix-matrix.