Mercurial > octave-antonio

comparison scripts/linear-algebra/vech.m @ 20160: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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} vech (@var{x}) 21 ## @deftypefn {Function File} {} vech (@var{x})
22 ## Return the vector obtained by eliminating all superdiagonal elements of 22 ## Return the vector obtained by eliminating all superdiagonal elements of
23 ## the square matrix @var{x} and stacking the result one column above the 23 ## the square matrix @var{x} and stacking the result one column above the
24 ## other. This has uses in matrix calculus where the underlying matrix 24 ## other.
25 ## is symmetric and it would be pointless to keep values above the main 25 ##
26 ## diagonal. 26 ## This has uses in matrix calculus where the underlying matrix is symmetric
27 ## and it would be pointless to keep values above the main diagonal.
27 ## @seealso{vec} 28 ## @seealso{vec}
28 ## @end deftypefn 29 ## @end deftypefn
29 30
30 ## See Magnus and Neudecker (1988), Matrix differential calculus with 31 ## See Magnus and Neudecker (1988), Matrix differential calculus with
31 ## applications in statistics and econometrics. 32 ## applications in statistics and econometrics.