Mercurial > octave-antonio

diff scripts/special-matrix/pascal.m @ 20162:2645f9ef8c88 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 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
line wrap: on
line diff
--- a/scripts/special-matrix/pascal.m	Sun May 03 15:36:23 2015 -0700
+++ b/scripts/special-matrix/pascal.m	Sun May 03 17:00:11 2015 -0700
@@ -20,15 +20,21 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {} pascal (@var{n})
 ## @deftypefnx {Function File} {} pascal (@var{n}, @var{t})
-## Return the Pascal matrix of order @var{n} if @code{@var{t} = 0}.  @var{t}
-## defaults to 0.  Return the pseudo-lower triangular Cholesky@tie{}factor of
-## the Pascal matrix if @code{@var{t} = 1} (The sign of some columns may be
-## negative).  This matrix is its own inverse, that is @code{pascal (@var{n},
-## 1) ^ 2 == eye (@var{n})}.  If @code{@var{t} = -1}, return the true
-## Cholesky@tie{}factor with strictly positive values on the diagonal.  If
-## @code{@var{t} = 2}, return a transposed and permuted version of @code{pascal
-## (@var{n}, 1)}, which is the cube root of the identity matrix.  That is,
-## @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}.
+## Return the Pascal matrix of order @var{n} if @code{@var{t} = 0}.
+##
+## The default value of @var{t} is 0.
+##
+## When @code{@var{t} = 1}, return the pseudo-lower triangular
+## Cholesky@tie{}factor of the Pascal matrix (The sign of some columns may be
+## negative).  This matrix is its own inverse, that is
+## @code{pascal (@var{n}, 1) ^ 2 == eye (@var{n})}.
+##
+## If @code{@var{t} = -1}, return the true Cholesky@tie{}factor with strictly
+## positive values on the diagonal.
+##
+## If @code{@var{t} = 2}, return a transposed and permuted version of
+## @code{pascal (@var{n}, 1)}, which is the cube root of the identity matrix.
+## That is, @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}.
 ##
 ## @seealso{chol}
 ## @end deftypefn