Mercurial > octave-antonio
comparison scripts/special-matrix/pascal.m @ 12639:4d777e05d47c stable
doc: Review and update documentation for "Matrix Manipulation" chapter.
* matrix.txi, arrayfun.m, blkdiag.m, fliplr.m, flipud.m, logspace.m,
postpad.m, prepad.m, randi.m, repmat.m, rot90.m, rotdim.m, shiftdim.m,
sortrows.m, vech.m, xor.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m,
pascal.m, rosser.m, sylvester_matrix.m, toeplitz.m, vander.m, wilkinson.m,
bsxfun.cc, find.cc, lookup.cc, rand.cc, tril.cc, data.cc, arrayfun.m,
blkdiag.m, fliplr.m, flipud.m, logspace.m, postpad.m, prepad.m, randi.m,
repmat.m, rot90.m, rotdim.m, shiftdim.m, sortrows.m, vech.m, xor.m, hadamard.m,
hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m, sylvester_matrix.m,
toeplitz.m, vander.m, wilkinson.m, bsxfun.cc (bsxfun), find.cc (find),
lookup.cc (lookup), rand.cc (rand, randn, rande, randg, randp),
tril.cc (triu), data.cc (all, any, horzcat, vertcat, cat, permute, ipermute,
ones, zeros, eye, linspace, resize, reshape, issorted, diff):
Improve docstrings
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 01 May 2011 08:55:15 -0700 |
parents | f5a5e5252b5a |
children | d4404589498c |
comparison
equal
deleted
inserted
replaced
12637:d02798e9eeae | 12639:4d777e05d47c |
---|---|
18 ## <http://www.gnu.org/licenses/>. | 18 ## <http://www.gnu.org/licenses/>. |
19 | 19 |
20 ## -*- texinfo -*- | 20 ## -*- texinfo -*- |
21 ## @deftypefn {Function File} {} pascal (@var{n}) | 21 ## @deftypefn {Function File} {} pascal (@var{n}) |
22 ## @deftypefnx {Function File} {} pascal (@var{n}, @var{t}) | 22 ## @deftypefnx {Function File} {} pascal (@var{n}, @var{t}) |
23 ## Return the Pascal matrix of order @var{n} if @code{@var{t} = 0}. | 23 ## Return the Pascal matrix of order @var{n} if @code{@var{t} = 0}. @var{t} |
24 ## @var{t} defaults to 0. Return the pseudo-lower triangular | 24 ## defaults to 0. Return the pseudo-lower triangular Cholesky@tie{}factor of |
25 ## Cholesky@tie{}factor of the Pascal matrix if @code{@var{t} = 1} (The sign | 25 ## the Pascal matrix if @code{@var{t} = 1} (The sign of some columns may be |
26 ## of some columns may be negative). This matrix is its own | 26 ## negative). This matrix is its own inverse, that is @code{pascal (@var{n}, |
27 ## inverse, that is @code{pascal (@var{n}, 1) ^ 2 == eye (@var{n})}. | 27 ## 1) ^ 2 == eye (@var{n})}. If @code{@var{t} = -1}, return the true |
28 ## If @code{@var{t} = -1}, return the true Cholesky@tie{}factor with strictly | 28 ## Cholesky@tie{}factor with strictly positive values on the diagonal. If |
29 ## positive values on the diagonal. | 29 ## @code{@var{t} = 2}, return a transposed and permuted version of @code{pascal |
30 ## If @code{@var{t} = 2}, return a transposed and permuted version of | 30 ## (@var{n}, 1)}, which is the cube root of the identity matrix. That is, |
31 ## @code{pascal (@var{n}, 1)}, which is the cube root of the identity | 31 ## @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}. |
32 ## matrix. That is, @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}. | |
33 ## | 32 ## |
34 ## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz, | 33 ## @seealso{chol} |
35 ## hadamard, wilkinson, compan, rosser} | |
36 ## @end deftypefn | 34 ## @end deftypefn |
37 | 35 |
38 ## Author: Peter Ekberg | 36 ## Author: Peter Ekberg |
39 ## (peda) | 37 ## (peda) |
40 | 38 |