Mercurial > octave-antonio
comparison scripts/special-matrix/pascal.m @ 20162:2645f9ef8c88 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed specfun, special-matrix, testfun, and time script directories.
* scripts/specfun/expint.m, scripts/specfun/isprime.m,
scripts/specfun/legendre.m, scripts/specfun/primes.m,
scripts/specfun/reallog.m, scripts/specfun/realsqrt.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m,
scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m,
scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m,
scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m,
scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m,
scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m,
scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m,
scripts/testfun/rundemos.m, scripts/testfun/runtests.m,
scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m,
scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m,
scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m,
scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 17:00:11 -0700 |
parents | 9fc020886ae9 |
children |
comparison
equal
deleted
inserted
replaced
20160:03b9d17a2d95 | 20162:2645f9ef8c88 |
---|---|
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}. @var{t} | 23 ## Return the Pascal matrix of order @var{n} if @code{@var{t} = 0}. |
24 ## defaults to 0. Return the pseudo-lower triangular Cholesky@tie{}factor of | 24 ## |
25 ## the Pascal matrix if @code{@var{t} = 1} (The sign of some columns may be | 25 ## The default value of @var{t} is 0. |
26 ## negative). This matrix is its own inverse, that is @code{pascal (@var{n}, | 26 ## |
27 ## 1) ^ 2 == eye (@var{n})}. If @code{@var{t} = -1}, return the true | 27 ## When @code{@var{t} = 1}, return the pseudo-lower triangular |
28 ## Cholesky@tie{}factor with strictly positive values on the diagonal. If | 28 ## Cholesky@tie{}factor of the Pascal matrix (The sign of some columns may be |
29 ## @code{@var{t} = 2}, return a transposed and permuted version of @code{pascal | 29 ## negative). This matrix is its own inverse, that is |
30 ## (@var{n}, 1)}, which is the cube root of the identity matrix. That is, | 30 ## @code{pascal (@var{n}, 1) ^ 2 == eye (@var{n})}. |
31 ## @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}. | 31 ## |
32 ## If @code{@var{t} = -1}, return the true Cholesky@tie{}factor with strictly | |
33 ## positive values on the diagonal. | |
34 ## | |
35 ## If @code{@var{t} = 2}, return a transposed and permuted version of | |
36 ## @code{pascal (@var{n}, 1)}, which is the cube root of the identity matrix. | |
37 ## That is, @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}. | |
32 ## | 38 ## |
33 ## @seealso{chol} | 39 ## @seealso{chol} |
34 ## @end deftypefn | 40 ## @end deftypefn |
35 | 41 |
36 ## Author: Peter Ekberg | 42 ## Author: Peter Ekberg |