Mercurial > hg > octave-nkf
changeset 16982:badc46a0a230
doc: Document 'uniformdata', 'normaldata', 'integerdata' matrices in gallery.m.
* scripts/special-matrix/gallery.m: Document 'uniformdata', 'normaldata',
'integerdata' matrices.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 14 Jul 2013 08:12:53 -0700 |
parents | e86df0d43309 |
children | 4660d047955e |
files | scripts/special-matrix/gallery.m |
diffstat | 1 files changed, 61 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/special-matrix/gallery.m +++ b/scripts/special-matrix/gallery.m @@ -145,6 +145,29 @@ ## ## @end deftypefn ## +## @deftypefn {Function File} {@var{a} =} gallery ("integerdata", @var{imax}, [@var{M} @var{N} @dots{}], @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("integerdata", @var{imax}, @var{M}, @var{N}, @dots{}, @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("integerdata", [@var{imin}, @var{imax}], [@var{M} @var{N} @dots{}], @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("integerdata", [@var{imin}, @var{imax}], @var{M}, @var{N}, @dots{}, @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("integerdata", @dots{}, "@var{class}") +## Create a matrix with random integers in the range [1, @var{imax}]. +## If @var{imin} is given then the integers are in the range +## [@var{imin}, @var{imax}]. +## +## The second input is a matrix of dimensions describing the size of the output. +## The dimensions can also be input as comma-separated arguments. +## +## The input @var{j} is an integer index in the range [0, 2^32-1]. The +## values of the output matrix are always exactly the same +## (reproducibility) for a given size input and @var{j} index. +## +## The final optional argument determines the class of the resulting matrix. +## Possible values for @var{class}: "uint8", "uint16", "uint32", "int8", +## "int16", int32", "single", "double". +## The default is "double". +## +## @end deftypefn +## ## @deftypefn {Function File} {@var{a} =} gallery ("invhess", @var{x}) ## @deftypefnx {Function File} {@var{a} =} gallery ("invhess", @var{x}, @var{y}) ## Create the inverse of an upper Hessenberg matrix. @@ -225,6 +248,25 @@ ## ## @end deftypefn ## +## @deftypefn {Function File} {@var{a} =} gallery ("normaldata", [@var{M} @var{N} @dots{}], @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("normaldata", @var{M}, @var{N}, @dots{}, @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("normaldata", @dots{}, "@var{class}") +## Create a matrix with random samples from the standard normal distribution +## (mean = 0, std = 1). +## +## The first input is a matrix of dimensions describing the size of the output. +## The dimensions can also be input as comma-separated arguments. +## +## The input @var{j} is an integer index in the range [0, 2^32-1]. The +## values of the output matrix are always exactly the same +## (reproducibility) for a given size input and @var{j} index. +## +## The final optional argument determines the class of the resulting matrix. +## Possible values for @var{class}: "single", "double". +## The default is "double". +## +## @end deftypefn +## ## @deftypefn {Function File} {@var{q} =} gallery ("orthog", @var{n}) ## @deftypefnx {Function File} {@var{q} =} gallery ("orthog", @var{n}, @var{k}) ## Create orthogonal and nearly orthogonal matrices. @@ -327,6 +369,25 @@ ## ## @end deftypefn ## +## @deftypefn {Function File} {@var{a} =} gallery ("uniformdata", [@var{M} @var{N} @dots{}], @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("uniformdata", @var{M}, @var{N}, @dots{}, @var{j}) +## @deftypefnx {Function File} {@var{a} =} gallery ("uniformdata", @dots{}, "@var{class}") +## Create a matrix with random samples from the standard uniform distribution +## (range [0,1]). +## +## The first input is a matrix of dimensions describing the size of the output. +## The dimensions can also be input as comma-separated arguments. +## +## The input @var{j} is an integer index in the range [0, 2^32-1]. The +## values of the output matrix are always exactly the same +## (reproducibility) for a given size input and @var{j} index. +## +## The final optional argument determines the class of the resulting matrix. +## Possible values for @var{class}: "single", "double". +## The default is "double". +## +## @end deftypefn +## ## @deftypefn {Function File} {@var{a} =} gallery ("wathen", @var{nx}, @var{ny}) ## @deftypefnx {Function File} {@var{a} =} gallery ("wathen", @var{nx}, @var{ny}, @var{k}) ## Create the Wathen matrix.