Mercurial > hg > octave-nkf

comparison scripts/linear-algebra/commutation_matrix.m @ 20370:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20369:597991b19e40 20370:03b9d17a2d95
21 ## Return the commutation matrix 21 ## Return the commutation matrix
22 ## @tex 22 ## @tex
23 ## $K_{m,n}$ 23 ## $K_{m,n}$
24 ## @end tex 24 ## @end tex
25 ## @ifnottex 25 ## @ifnottex
26 ## K(m,n) 26 ## K(m,n)
27 ## @end ifnottex 27 ## @end ifnottex
28 ## which is the unique 28 ## which is the unique
29 ## @tex 29 ## @tex
30 ## $m n \times m n$ 30 ## $m n \times m n$
31 ## @end tex 31 ## @end tex
32 ## @ifnottex 32 ## @ifnottex
33 ## @var{m}*@var{n} by @var{m}*@var{n} 33 ## @var{m}*@var{n} by @var{m}*@var{n}
34 ## @end ifnottex 34 ## @end ifnottex
35 ## matrix such that 35 ## matrix such that
36 ## @tex 36 ## @tex
37 ## $K_{m,n} \cdot {\rm vec} (A) = {\rm vec} (A^T)$ 37 ## $K_{m,n} \cdot {\rm vec} (A) = {\rm vec} (A^T)$
38 ## @end tex 38 ## @end tex
39 ## @ifnottex 39 ## @ifnottex
40 ## @math{K(m,n) * vec(A) = vec(A')} 40 ## @math{K(m,n) * vec(A) = vec(A')}
41 ## @end ifnottex 41 ## @end ifnottex
42 ## for all 42 ## for all
43 ## @tex 43 ## @tex
44 ## $m\times n$ 44 ## $m\times n$
45 ## @end tex 45 ## @end tex
46 ## @ifnottex 46 ## @ifnottex
47 ## @math{m} by @math{n} 47 ## @math{m} by @math{n}
48 ## @end ifnottex 48 ## @end ifnottex
49 ## matrices 49 ## matrices
50 ## @tex 50 ## @tex
51 ## $A$. 51 ## $A$.
52 ## @end tex 52 ## @end tex
53 ## @ifnottex 53 ## @ifnottex
54 ## @math{A}. 54 ## @math{A}.
55 ## @end ifnottex 55 ## @end ifnottex
56 ## 56 ##
57 ## If only one argument @var{m} is given, 57 ## If only one argument @var{m} is given,
58 ## @tex 58 ## @tex
59 ## $K_{m,m}$ 59 ## $K_{m,m}$
60 ## @end tex 60 ## @end tex
61 ## @ifnottex 61 ## @ifnottex
62 ## @math{K(m,m)} 62 ## @math{K(m,m)}
63 ## @end ifnottex 63 ## @end ifnottex
64 ## is returned. 64 ## is returned.
65 ## 65 ##
66 ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential 66 ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential
67 ## Calculus with Applications in Statistics and Econometrics.} 67 ## Calculus with Applications in Statistics and Econometrics.}
68 ## @end deftypefn 68 ## @end deftypefn
69 69