comparison scripts/special-matrix/hankel.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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} hankel (@var{c}) 20 ## @deftypefn {Function File} {} hankel (@var{c})
21 ## @deftypefnx {Function File} {} hankel (@var{c}, @var{r}) 21 ## @deftypefnx {Function File} {} hankel (@var{c}, @var{r})
22 ## Return the Hankel matrix constructed from the first column @var{c}, and 22 ## Return the Hankel matrix constructed from the first column @var{c}, and
23 ## (optionally) the last row @var{r}. If the last element of @var{c} is 23 ## (optionally) the last row @var{r}.
24 ## not the same as the first element of @var{r}, the last element of
25 ## @var{c} is used. If the second argument is omitted, it is assumed to
26 ## be a vector of zeros with the same size as @var{c}.
27 ## 24 ##
28 ## A Hankel matrix formed from an m-vector @var{c}, and an n-vector 25 ## If the last element of @var{c} is not the same as the first element of
29 ## @var{r}, has the elements 26 ## @var{r}, the last element of @var{c} is used. If the second argument is
27 ## omitted, it is assumed to be a vector of zeros with the same size as @var{c}.
28 ##
29 ## A Hankel matrix formed from an m-vector @var{c}, and an n-vector @var{r},
30 ## has the elements
30 ## @tex 31 ## @tex
31 ## $$ 32 ## $$
32 ## H(i, j) = \cases{c_{i+j-1},&$i+j-1\le m$;\cr r_{i+j-m},&otherwise.\cr} 33 ## H(i, j) = \cases{c_{i+j-1},&$i+j-1\le m$;\cr r_{i+j-m},&otherwise.\cr}
33 ## $$ 34 ## $$
34 ## @end tex 35 ## @end tex