export transpose! and ctranspose!

jiahao · Nov 11, 2014 · 23210fa · 23210fa
1 parent f734cf4
commit 23210fa
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/base/exports.jl b/base/exports.jl
@@ -632,6 +632,7 @@ export
  cond,
  condskeel,
  cross,
+ ctranspose!,
  ctranspose,
  det,
  diag,
@@ -692,6 +693,7 @@ export
  svdvals,
  sylvester,
  trace,
+ transpose!,
  transpose,
  tril!,
  tril,

diff --git a/doc/stdlib/base.rst b/doc/stdlib/base.rst
@@ -4313,6 +4313,10 @@ Indexing, Assignment, and Concatenation
 
  Like :func:`permutedims`, except the inverse of the given permutation is applied.
 
+.. function:: permutedims!(dest,src,perm)
+
+ Permute the dimensions of array ``src`` and store the result in the array ``dest``. ``perm`` is a vector specifying a permutation of length ``ndims(src)``. The preallocated array ``dest`` should have ``size(dest)=size(src)[perm]`` and is completely overwritten. No in-place permutation is supported and unexpected results will happen if `src` and `dest` have overlapping memory regions.
+
 .. function:: squeeze(A, dims)
 
  Remove the dimensions specified by ``dims`` from array ``A``

diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst
@@ -552,10 +552,18 @@ Linear algebra functions in Julia are largely implemented by calling functions f
 
  The transposition operator (``.'``).
 
+.. function:: transpose!(dest,src)
+
+ Transpose array ``src`` and store the result in the preallocated array ``dest``, which should have a size corresponding to ``(size(src,2),size(src,1))``. No in-place transposition is supported and unexpected results will happen if `src` and `dest` have overlapping memory regions.
+
 .. function:: ctranspose(A)
 
  The conjugate transposition operator (``'``).
 
+.. function:: ctranspose!(dest,src)
+
+ Conjugate transpose array ``src`` and store the result in the preallocated array ``dest``, which should have a size corresponding to ``(size(src,2),size(src,1))``. No in-place transposition is supported and unexpected results will happen if `src` and `dest` have overlapping memory regions.
+
 .. function:: eigs(A, [B,]; nev=6, which="LM", tol=0.0, maxiter=1000, sigma=nothing, ritzvec=true, v0=zeros((0,))) -> (d,[v,],nconv,niter,nmult,resid)
 
  ``eigs`` computes eigenvalues ``d`` of ``A`` using Lanczos or Arnoldi iterations for real symmetric or general nonsymmetric matrices respectively. If ``B`` is provided, the generalized eigen-problem is solved. The following keyword arguments are supported: