Skip to content

Commit

Permalink
Inline Latex for A_mul_Bt etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@dpsanders
dpsanders committed Sep 13, 2015
1 parent 3a457ae commit 382548f
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 39 deletions.
40 changes: 20 additions & 20 deletions base/docs/helpdb.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1041,7 +1041,7 @@ Base.(:(//))
doc"""
At_mul_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ B`
For matrices or vectors $A$ and $B$, calculates $Aᵀ⋅B$
"""
At_mul_B

Expand Down Expand Up @@ -1360,7 +1360,7 @@ airybiprime
doc"""
Ac_rdiv_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ / B`
For matrices or vectors $A$ and $B$, calculates $Aᴴ / B$
"""
Ac_rdiv_B

Expand Down Expand Up @@ -2528,7 +2528,7 @@ redisplay
doc"""
A_mul_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `A Bᴴ`
For matrices or vectors $A$ and $B$, calculates $A⋅Bᴴ$
"""
A_mul_Bc

Expand Down Expand Up @@ -2662,7 +2662,7 @@ watch_file
doc"""
At_rdiv_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ / Bᵀ`
For matrices or vectors $A$ and $B$, calculates $Aᵀ / Bᵀ$
"""
At_rdiv_Bt

Expand All @@ -2676,7 +2676,7 @@ isinteractive
doc"""
At_mul_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ Bᵀ`
For matrices or vectors $A$ and $B$, calculates $Aᵀ⋅Bᵀ$
"""
At_mul_Bt

Expand Down Expand Up @@ -3429,7 +3429,7 @@ Mmap.Anonymous
doc"""
A_rdiv_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `A / Bᴴ`
For matrices or vectors $A$ and $B$, calculates $A / Bᴴ$
"""
A_rdiv_Bc

Expand Down Expand Up @@ -6457,8 +6457,8 @@ doc"""
A_mul_B!(Y, A, B) -> Y
Calculates the matrix-matrix or matrix-vector product `A * B` and stores the
result in `Y`, overwriting the existing value of `Y`.
Calculates the matrix-matrix or matrix-vector product $A⋅B$ and stores the
result in $Y$, overwriting the existing value of $Y$.
```jldoctest
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);
Expand Down Expand Up @@ -6490,7 +6490,7 @@ idct!
doc"""
Ac_rdiv_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ \ Bᴴ`
For matrices or vectors $A$ and $B$, calculates $Aᴴ / Bᴴ$
"""
Ac_rdiv_Bc
Expand Down Expand Up @@ -8789,7 +8789,7 @@ plan_fft
doc"""
A_rdiv_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `A / Bᵀ`
For matrices or vectors $A$ and $B$, calculates $A / Bᵀ$
"""
A_rdiv_Bt

Expand Down Expand Up @@ -9549,7 +9549,7 @@ issubnormal
doc"""
Ac_ldiv_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ \ B`
For matrices or vectors $A$ and $B$, calculates $Aᴴ$ \ $B$
"""
Ac_ldiv_B

Expand Down Expand Up @@ -9807,7 +9807,7 @@ nprocs
doc"""
Ac_mul_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ B`
For matrices or vectors $A$ and $B$, calculates $Aᴴ⋅B$
"""
Ac_mul_B

Expand All @@ -9823,7 +9823,7 @@ qrfact!
doc"""
At_rdiv_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ / B`
For matrices or vectors $A$ and $B$, calculates $Aᵀ / B$
"""
At_rdiv_B

Expand Down Expand Up @@ -10072,7 +10072,7 @@ convert
doc"""
A_ldiv_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `A \ Bᵀ`
For matrices or vectors $A$ and $B$, calculates $A$ \ $Bᵀ$
"""
A_ldiv_Bt

Expand Down Expand Up @@ -10154,7 +10154,7 @@ eigvals
doc"""
A_ldiv_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `A \ Bᴴ`
For matrices or vectors $A$ and $B$, calculates $A$ \ $Bᴴ$
"""
A_ldiv_Bc

Expand Down Expand Up @@ -10786,14 +10786,14 @@ getkey
doc"""
At_ldiv_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ \ Bᵀ`
For matrices or vectors $A$ and $B$, calculates $Aᵀ$ \ $Bᵀ$
"""
At_ldiv_Bt

doc"""
Ac_mul_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ Bᴴ`
For matrices or vectors $A$ and $B$, calculates $Aᴴ Bᴴ$
"""
Ac_mul_Bc

Expand Down Expand Up @@ -10852,7 +10852,7 @@ sprand
doc"""
A_mul_Bt(A, B)
For matrices or vectors `A` and `B`, calculates `A Bᵀ`
For matrices or vectors $A$ and $B$, calculates $A⋅Bᵀ$
"""
A_mul_Bt

Expand Down Expand Up @@ -11388,7 +11388,7 @@ union!
doc"""
At_ldiv_B(A, B)
For matrices or vectors `A` and `B`, calculates `Aᵀ \ B`
For matrices or vectors $A$ and $B$, calculates $Aᵀ$ \ $B$
"""
At_ldiv_B

Expand Down Expand Up @@ -11649,7 +11649,7 @@ ror
doc"""
Ac_ldiv_Bc(A, B)
For matrices or vectors `A` and `B`, calculates `Aᴴ \ Bᴴ`
For matrices or vectors $A$ and $B$, calculates $Aᴴ$ \ $Bᴴ$
"""
Ac_ldiv_Bc

Expand Down
38 changes: 19 additions & 19 deletions doc/stdlib/math.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -413,19 +413,19 @@ Mathematical Operators

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A \ Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A` \\ :math:`Bᴴ`

.. function:: A_ldiv_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A \ Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A` \\ :math:`Bᵀ`

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

.. Docstring generated from Julia source
Calculates the matrix-matrix or matrix-vector product ``A * B`` and stores the result in ``Y``\ , overwriting the existing value of ``Y``\ .
Calculates the matrix-matrix or matrix-vector product :math:`A⋅B` and stores the result in :math:`Y`\ , overwriting the existing value of :math:`Y`\ .

.. doctest::

Expand All @@ -440,97 +440,97 @@ Mathematical Operators

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A⋅Bᴴ`

.. function:: A_mul_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A⋅Bᵀ`

.. function:: A_rdiv_Bc(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A / Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A / Bᴴ`

.. function:: A_rdiv_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``A / Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`A / Bᵀ`

.. function:: Ac_ldiv_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ \ B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ` \\ :math:`B`

.. function:: Ac_ldiv_Bc(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ \ Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ` \\ :math:`Bᴴ`

.. function:: Ac_mul_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ⋅B`

.. function:: Ac_mul_Bc(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ Bᴴ`

.. function:: Ac_rdiv_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ / B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ / B`

.. function:: Ac_rdiv_Bc(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᴴ \ Bᴴ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᴴ / Bᴴ`

.. function:: At_ldiv_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ \ B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ` \\ :math:`B`

.. function:: At_ldiv_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ \ Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ` \\ :math:`Bᵀ`

.. function:: At_mul_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ⋅B`

.. function:: At_mul_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ⋅Bᵀ`

.. function:: At_rdiv_B(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ / B``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ / B`

.. function:: At_rdiv_Bt(A, B)

.. Docstring generated from Julia source
For matrices or vectors ``A`` and ``B``\ , calculates ``Aᵀ / Bᵀ``
For matrices or vectors :math:`A` and :math:`B`\ , calculates :math:`Aᵀ / Bᵀ`

Mathematical Functions
----------------------
Expand Down

0 comments on commit 382548f

Please sign in to comment.