Skip to content

Commit

Permalink
Document basic A_mul_B! methods
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jiahao committed Jan 2, 2015
1 parent 38f1c36 commit d9b1f39
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2924,9 +2924,19 @@ Mathematical Operators

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

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

Matrix operator A B
Calculates the matrix-matrix or matrix-vector product *A B* and stores the
result in *Y*, overwriting the existing value of *Y*.

.. doctest::

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);

julia> B
2x2 Array{Float64,2}:
3.0 3.0
7.0 7.0

.. function:: A_mul_Bc(...)

Expand Down

0 comments on commit d9b1f39

Please sign in to comment.