Skip to content

Commit e1c00cd

Browse files
jiahaotkelman
authored andcommitted
Document basic A_mul_B! methods
Also removes deprecated A_mul_B documentation. Closes #5862. Note: this does _not_ cover all the currently defined methods for A_mul_B!, many of which do _not_ have method signatures of this form. Ref: #5332 created via: git diff d9b1f39~ d9b1f39 | sed 's/base/math/g' | git apply git add doc/stdlib/math.rst git commit -C d9b1f39 [av skip]
1 parent 4baf8e4 commit e1c00cd

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

doc/stdlib/math.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,19 @@ Mathematical Operators
318318

319319
Matrix operator A \\ B\ :sup:`T`
320320

321-
.. function:: A_mul_B(...)
321+
.. function:: A_mul_B!(Y, A, B) -> Y
322322

323-
Matrix operator A B
323+
Calculates the matrix-matrix or matrix-vector product *A B* and stores the
324+
result in *Y*, overwriting the existing value of *Y*.
325+
326+
.. doctest::
327+
328+
julia> A=[1.0 2.0; 3.0 4.0]; B=[1.0 1.0; 1.0 1.0]; A_mul_B!(B, A, B);
329+
330+
julia> B
331+
2x2 Array{Float64,2}:
332+
3.0 3.0
333+
7.0 7.0
324334

325335
.. function:: A_mul_Bc(...)
326336

0 commit comments

Comments
 (0)