Skip to content

Commit d9b1f39

Browse files
committed
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
1 parent 38f1c36 commit d9b1f39

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

doc/stdlib/base.rst

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

29252925
Matrix operator A \\ B\ :sup:`T`
29262926

2927-
.. function:: A_mul_B(...)
2927+
.. function:: A_mul_B!(Y, A, B) -> Y
29282928

2929-
Matrix operator A B
2929+
Calculates the matrix-matrix or matrix-vector product *A B* and stores the
2930+
result in *Y*, overwriting the existing value of *Y*.
2931+
2932+
.. doctest::
2933+
2934+
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);
2935+
2936+
julia> B
2937+
2x2 Array{Float64,2}:
2938+
3.0 3.0
2939+
7.0 7.0
29302940

29312941
.. function:: A_mul_Bc(...)
29322942

0 commit comments

Comments
 (0)