# HG changeset patch # User Markus Mützel # Date 1608719024 -3600 # Node ID 8469b3aad7ac7d870ab168758564e84bb304b3c0 # Parent d50d9fd9ab057de2bf10faa818aadfbbd9ff058b ones, zeros, NaN, NA, false, true: Document syntax with "like" (bug #50854). * libinterp/corefcn/data.cc (Fones, Fzeros, FNaN, FNA, Ffalse, Ftrue): Document syntax with "like". diff -r d50d9fd9ab05 -r 8469b3aad7ac libinterp/corefcn/data.cc --- a/libinterp/corefcn/data.cc Tue Dec 22 10:50:12 2020 -0800 +++ b/libinterp/corefcn/data.cc Wed Dec 23 11:23:44 2020 +0100 @@ -4402,11 +4402,12 @@ DEFUN (ones, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} ones (@var{n}) -@deftypefnx {} {} ones (@var{m}, @var{n}) -@deftypefnx {} {} ones (@var{m}, @var{n}, @var{k}, @dots{}) -@deftypefnx {} {} ones ([@var{m} @var{n} @dots{}]) -@deftypefnx {} {} ones (@dots{}, @var{class}) +@deftypefn {} {@var{val} =} ones (@var{n}) +@deftypefnx {} {@var{val} =} ones (@var{m}, @var{n}) +@deftypefnx {} {@var{val} =} ones (@var{m}, @var{n}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} ones ([@var{m} @var{n} @dots{}]) +@deftypefnx {} {@var{val} =} ones (@dots{}, "@var{like}", @var{var})) +@deftypefnx {} {@var{val} =} ones (@dots{}, @var{class}) Return a matrix or N-dimensional array whose elements are all 1. If invoked with a single scalar integer argument @var{n}, return a square @@ -4422,6 +4423,9 @@ val_matrix = val * ones (m, n) @end example +If a variable @var{var} is specified after @qcode{"like"}, the output @var{val} +will have the same data type, complexity, and sparsity as @var{var}. + The optional argument @var{class} specifies the class of the return array and defaults to double. For example: @@ -4486,11 +4490,12 @@ DEFUN (zeros, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} zeros (@var{n}) -@deftypefnx {} {} zeros (@var{m}, @var{n}) -@deftypefnx {} {} zeros (@var{m}, @var{n}, @var{k}, @dots{}) -@deftypefnx {} {} zeros ([@var{m} @var{n} @dots{}]) -@deftypefnx {} {} zeros (@dots{}, @var{class}) +@deftypefn {} {@var{val} =} zeros (@var{n}) +@deftypefnx {} {@var{val} =} zeros (@var{m}, @var{n}) +@deftypefnx {} {@var{val} =} zeros (@var{m}, @var{n}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} zeros ([@var{m} @var{n} @dots{}]) +@deftypefnx {} {@var{val} =} zeros (@dots{}, "@var{like}", @var{var})) +@deftypefnx {} {@var{val} =} zeros (@dots{}, @var{class}) Return a matrix or N-dimensional array whose elements are all 0. If invoked with a single scalar integer argument, return a square @@ -4499,6 +4504,9 @@ If invoked with two or more scalar integer arguments, or a vector of integer values, return an array with the given dimensions. +If a variable @var{var} is specified after @qcode{"like"}, the output @var{val} +will have the same data type, complexity, and sparsity as @var{var}. + The optional argument @var{class} specifies the class of the return array and defaults to double. For example: @@ -4620,11 +4628,12 @@ @c List other form of function in documentation index @findex nan -@deftypefn {} {} NaN -@deftypefnx {} {} NaN (@var{n}) -@deftypefnx {} {} NaN (@var{n}, @var{m}) -@deftypefnx {} {} NaN (@var{n}, @var{m}, @var{k}, @dots{}) -@deftypefnx {} {} NaN (@dots{}, @var{class}) +@deftypefn {} {@var{val} =} NaN +@deftypefnx {} {@var{val} =} NaN (@var{n}) +@deftypefnx {} {@var{val} =} NaN (@var{n}, @var{m}) +@deftypefnx {} {@var{val} =} NaN (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} NaN (@dots{}, "@var{like}", @var{var})) +@deftypefnx {} {@var{val} =} NaN (@dots{}, @var{class}) Return a scalar, matrix, or N-dimensional array whose elements are all equal to the IEEE symbol NaN (Not a Number). @@ -4652,6 +4661,9 @@ taken as the number of rows and columns and any further arguments specify additional matrix dimensions. +If a variable @var{var} is specified after @qcode{"like"}, the output @var{val} +will have the same data type, complexity, and sparsity as @var{var}. + The optional argument @var{class} specifies the return type and may be either @qcode{"double"} or @qcode{"single"}. @seealso{isnan, Inf} @@ -5014,11 +5026,12 @@ DEFUN (NA, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} NA -@deftypefnx {} {} NA (@var{n}) -@deftypefnx {} {} NA (@var{n}, @var{m}) -@deftypefnx {} {} NA (@var{n}, @var{m}, @var{k}, @dots{}) -@deftypefnx {} {} NA (@dots{}, @var{class}) +@deftypefn {} {@var{val} =} NA +@deftypefnx {} {@var{val} =} NA (@var{n}) +@deftypefnx {} {@var{val} =} NA (@var{n}, @var{m}) +@deftypefnx {} {@var{val} =} NA (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} NA (@dots{}, "@var{like}", @var{var})) +@deftypefnx {} {@var{val} =} NA (@dots{}, @var{class}) Return a scalar, matrix, or N-dimensional array whose elements are all equal to the special constant used to designate missing values. @@ -5034,6 +5047,9 @@ taken as the number of rows and columns and any further arguments specify additional matrix dimensions. +If a variable @var{var} is specified after @qcode{"like"}, the output @var{val} +will have the same data type, complexity, and sparsity as @var{var}. + The optional argument @var{class} specifies the return type and may be either @qcode{"double"} or @qcode{"single"}. @seealso{isna} @@ -5050,9 +5066,10 @@ DEFUN (false, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} false (@var{x}) -@deftypefnx {} {} false (@var{n}, @var{m}) -@deftypefnx {} {} false (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefn {} {@var{val} =} false (@var{x}) +@deftypefnx {} {@var{val} =} false (@var{n}, @var{m}) +@deftypefnx {} {@var{val} =} false (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} false (@dots{}, "@var{like}", @var{var})) Return a matrix or N-dimensional array whose elements are all logical 0. If invoked with a single scalar integer argument, return a square @@ -5060,6 +5077,9 @@ If invoked with two or more scalar integer arguments, or a vector of integer values, return an array with given dimensions. + +If a logical variable @var{var} is specified after @qcode{"like"}, the output +@var{val} will have the same sparsity as @var{var}. @seealso{true} @end deftypefn */) { @@ -5078,9 +5098,10 @@ DEFUN (true, args, , doc: /* -*- texinfo -*- -@deftypefn {} {} true (@var{x}) -@deftypefnx {} {} true (@var{n}, @var{m}) -@deftypefnx {} {} true (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefn {} {@var{val} =} true (@var{x}) +@deftypefnx {} {@var{val} =} true (@var{n}, @var{m}) +@deftypefnx {} {@var{val} =} true (@var{n}, @var{m}, @var{k}, @dots{}) +@deftypefnx {} {@var{val} =} true (@dots{}, "@var{like}", @var{var})) Return a matrix or N-dimensional array whose elements are all logical 1. If invoked with a single scalar integer argument, return a square @@ -5088,6 +5109,9 @@ If invoked with two or more scalar integer arguments, or a vector of integer values, return an array with given dimensions. + +If a logical variable @var{var} is specified after @qcode{"like"}, the output +@var{val} will have the same sparsity as @var{var}. @seealso{false} @end deftypefn */) {