From cadf2fc4d75bfc1faae0f043243ebe927fc5726b Mon Sep 17 00:00:00 2001 From: Ed Schmerling Date: Mon, 18 Jul 2016 19:52:33 -0700 Subject: [PATCH] Document recursive (c)transpose --- base/docs/helpdb/Base.jl | 8 ++++++-- doc/stdlib/linalg.rst | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/base/docs/helpdb/Base.jl b/base/docs/helpdb/Base.jl index 698602b5f1854..6ea5e3f1339cd 100644 --- a/base/docs/helpdb/Base.jl +++ b/base/docs/helpdb/Base.jl @@ -2629,7 +2629,9 @@ find(f, A) """ ctranspose(A) -The conjugate transposition operator (`'`). + +The conjugate transposition operator (`'`). Operates recursively on arrays with vector or +matrix element type (e.g., block matrices). """ ctranspose @@ -4726,7 +4728,9 @@ lock """ transpose(A) -The transposition operator (`.'`). +The transposition operator (`.'`). Operates recursively on arrays with vector or matrix +element type (e.g., block matrices). Non-recursive behavior may be obtained in such cases +by calling `permutedims(A, [2,1])`. """ transpose diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst index 713d6c55912b6..6b0289dc503af 100644 --- a/doc/stdlib/linalg.rst +++ b/doc/stdlib/linalg.rst @@ -1275,7 +1275,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f .. Docstring generated from Julia source - The transposition operator (``.'``\ ). + The transposition operator (``.'``\ ). Operates recursively on arrays with vector or matrix element type (e.g., block matrices). Non-recursive behavior may be obtained in such cases by calling ``permutedims(A, [2,1])``\ . .. function:: transpose!(dest,src) @@ -1287,7 +1287,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f .. Docstring generated from Julia source - The conjugate transposition operator (``'``\ ). + The conjugate transposition operator (``'``\ ). Operates recursively on arrays with vector or matrix element type (e.g., block matrices). .. function:: ctranspose!(dest,src)