Mercurial > octave-antonio
comparison scripts/special-matrix/hadamard.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 |
---|---|
19 ## Original version by Paul Kienzle distributed as free software in the | 19 ## Original version by Paul Kienzle distributed as free software in the |
20 ## public domain. | 20 ## public domain. |
21 | 21 |
22 ## -*- texinfo -*- | 22 ## -*- texinfo -*- |
23 ## @deftypefn {Function File} {} hadamard (@var{n}) | 23 ## @deftypefn {Function File} {} hadamard (@var{n}) |
24 ## Construct a Hadamard matrix (@nospell{Hn}) of size @var{n}-by-@var{n}. The | 24 ## Construct a Hadamard matrix (@nospell{Hn}) of size @var{n}-by-@var{n}. |
25 ## size @var{n} must be of the form @math{2^k * p} in which | 25 ## |
26 ## p is one of 1, 12, 20 or 28. The returned matrix is normalized, | 26 ## The size @var{n} must be of the form @math{2^k * p} in which p is one of |
27 ## meaning @w{@code{Hn(:,1) == 1}} and @w{@code{Hn(1,:) == 1}}. | 27 ## 1, 12, 20 or 28. The returned matrix is normalized, meaning |
28 ## @w{@code{Hn(:,1) == 1}} and @w{@code{Hn(1,:) == 1}}. | |
28 ## | 29 ## |
29 ## Some of the properties of Hadamard matrices are: | 30 ## Some of the properties of Hadamard matrices are: |
30 ## | 31 ## |
31 ## @itemize @bullet | 32 ## @itemize @bullet |
32 ## @item | 33 ## @item |