Mercurial > octave-antonio
comparison scripts/special-matrix/toeplitz.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 |
---|---|
19 | 19 |
20 ## -*- texinfo -*- | 20 ## -*- texinfo -*- |
21 ## @deftypefn {Function File} {} toeplitz (@var{c}) | 21 ## @deftypefn {Function File} {} toeplitz (@var{c}) |
22 ## @deftypefnx {Function File} {} toeplitz (@var{c}, @var{r}) | 22 ## @deftypefnx {Function File} {} toeplitz (@var{c}, @var{r}) |
23 ## Return the Toeplitz matrix constructed from the first column @var{c}, | 23 ## Return the Toeplitz matrix constructed from the first column @var{c}, |
24 ## and (optionally) the first row @var{r}. If the first element of @var{r} | 24 ## and (optionally) the first row @var{r}. |
25 ## is not the same as the first element of @var{c}, the first element of | 25 ## |
26 ## @var{c} is used. If the second argument is omitted, the first row is | 26 ## If the first element of @var{r} is not the same as the first element of |
27 ## taken to be the same as the first column. | 27 ## @var{c}, the first element of @var{c} is used. If the second argument is |
28 ## omitted, the first row is taken to be the same as the first column. | |
28 ## | 29 ## |
29 ## A square Toeplitz matrix has the form: | 30 ## A square Toeplitz matrix has the form: |
30 ## @tex | 31 ## @tex |
31 ## $$ | 32 ## $$ |
32 ## \left[\matrix{c_0 & r_1 & r_2 & \cdots & r_n\cr | 33 ## \left[\matrix{c_0 & r_1 & r_2 & \cdots & r_n\cr |