Mercurial > octave-antonio

comparison scripts/special-matrix/gallery.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 941e782d0429
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
155 ## [@var{imin}, @var{imax}]. 155 ## [@var{imin}, @var{imax}].
156 ## 156 ##
157 ## The second input is a matrix of dimensions describing the size of the output. 157 ## The second input is a matrix of dimensions describing the size of the output.
158 ## The dimensions can also be input as comma-separated arguments. 158 ## The dimensions can also be input as comma-separated arguments.
159 ## 159 ##
160 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The 160 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The values
161 ## values of the output matrix are always exactly the same 161 ## of the output matrix are always exactly the same (reproducibility) for a
162 ## (reproducibility) for a given size input and @var{j} index. 162 ## given size input and @var{j} index.
163 ## 163 ##
164 ## The final optional argument determines the class of the resulting matrix. 164 ## The final optional argument determines the class of the resulting matrix.
165 ## Possible values for @var{class}: @qcode{"uint8"}, @qcode{"uint16"}, 165 ## Possible values for @var{class}: @qcode{"uint8"}, @qcode{"uint16"},
166 ## @qcode{"uint32"}, @qcode{"int8"}, @qcode{"int16"}, int32", @qcode{"single"}, 166 ## @qcode{"uint32"}, @qcode{"int8"}, @qcode{"int16"}, int32", @qcode{"single"},
167 ## @qcode{"double"}. The default is @qcode{"double"}. 167 ## @qcode{"double"}. The default is @qcode{"double"}.
179 ## 179 ##
180 ## @end deftypefn 180 ## @end deftypefn
181 ## 181 ##
182 ## @deftypefn {Function File} {@var{a} =} gallery ("ipjfact", @var{n}) 182 ## @deftypefn {Function File} {@var{a} =} gallery ("ipjfact", @var{n})
183 ## @deftypefnx {Function File} {@var{a} =} gallery ("ipjfact", @var{n}, @var{k}) 183 ## @deftypefnx {Function File} {@var{a} =} gallery ("ipjfact", @var{n}, @var{k})
184 ## Create an Hankel matrix with factorial elements. 184 ## Create a Hankel matrix with factorial elements.
185 ## 185 ##
186 ## @end deftypefn 186 ## @end deftypefn
187 ## 187 ##
188 ## @deftypefn {Function File} {@var{a} =} gallery ("jordbloc", @var{n}) 188 ## @deftypefn {Function File} {@var{a} =} gallery ("jordbloc", @var{n})
189 ## @deftypefnx {Function File} {@var{a} =} gallery ("jordbloc", @var{n}, @var{lambda}) 189 ## @deftypefnx {Function File} {@var{a} =} gallery ("jordbloc", @var{n}, @var{lambda})
255 ## (mean = 0, std = 1). 255 ## (mean = 0, std = 1).
256 ## 256 ##
257 ## The first input is a matrix of dimensions describing the size of the output. 257 ## The first input is a matrix of dimensions describing the size of the output.
258 ## The dimensions can also be input as comma-separated arguments. 258 ## The dimensions can also be input as comma-separated arguments.
259 ## 259 ##
260 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The 260 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The values
261 ## values of the output matrix are always exactly the same 261 ## of the output matrix are always exactly the same (reproducibility) for a
262 ## (reproducibility) for a given size input and @var{j} index. 262 ## given size input and @var{j} index.
263 ## 263 ##
264 ## The final optional argument determines the class of the resulting matrix. 264 ## The final optional argument determines the class of the resulting matrix.
265 ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}. 265 ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}.
266 ## The default is @qcode{"double"}. 266 ## The default is @qcode{"double"}.
267 ## 267 ##
378 ## (range [0,1]). 378 ## (range [0,1]).
379 ## 379 ##
380 ## The first input is a matrix of dimensions describing the size of the output. 380 ## The first input is a matrix of dimensions describing the size of the output.
381 ## The dimensions can also be input as comma-separated arguments. 381 ## The dimensions can also be input as comma-separated arguments.
382 ## 382 ##
383 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The 383 ## The input @var{j} is an integer index in the range [0, 2^32-1]. The values
384 ## values of the output matrix are always exactly the same 384 ## of the output matrix are always exactly the same (reproducibility) for a
385 ## (reproducibility) for a given size input and @var{j} index. 385 ## given size input and @var{j} index.
386 ## 386 ##
387 ## The final optional argument determines the class of the resulting matrix. 387 ## The final optional argument determines the class of the resulting matrix.
388 ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}. 388 ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}.
389 ## The default is @qcode{"double"}. 389 ## The default is @qcode{"double"}.
390 ## 390 ##