Mercurial > octave

comparison libinterp/corefcn/data.cc @ 30594:0cb3f48da9da

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: clarifies issorted only operates on vectors (bug #61765) * libinterp/corefcn/data.cc (issorted): updates docstring to indicate that issorted currently only works on vectors, or on matrices with the "rows" option.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Wed, 05 Jan 2022 13:28:52 -0500
parents 83f9f8bda883
children 1182fcd6cdaf
comparison
equal deleted inserted replaced
30593:bcaa4c5f5928 30594:0cb3f48da9da
7328 DEFUN (issorted, args, , 7328 DEFUN (issorted, args, ,
7329 doc: /* -*- texinfo -*- 7329 doc: /* -*- texinfo -*-
7330 @deftypefn {} {@var{tf} =} issorted (@var{a}) 7330 @deftypefn {} {@var{tf} =} issorted (@var{a})
7331 @deftypefnx {} {@var{tf} =} issorted (@var{a}, @var{mode}) 7331 @deftypefnx {} {@var{tf} =} issorted (@var{a}, @var{mode})
7332 @deftypefnx {} {@var{tf} =} issorted (@var{a}, "rows", @var{mode}) 7332 @deftypefnx {} {@var{tf} =} issorted (@var{a}, "rows", @var{mode})
7333 Return true if the array is sorted according to @var{mode}, which may be either 7333 Return true if the vector @var{a} is sorted according to @var{mode}, which
7334 @qcode{"ascend"}, @qcode{"descend"}, or @qcode{"either"}. 7334 may be either @qcode{"ascend"}, @qcode{"descend"}, or @qcode{"either"}.
7335 7335
7336 By default, @var{mode} is @qcode{"ascend"}. NaNs are treated in the same 7336 By default, @var{mode} is @qcode{"ascend"}. NaNs are treated in the same
7337 manner as @code{sort}. 7337 manner as @code{sort}.
7338 7338
7339 If the optional argument @qcode{"rows"} is supplied, check whether the array is 7339 If the optional argument @qcode{"rows"} is supplied, check whether the matrix
7340 sorted by rows as output by the function @code{sortrows} (with no options). 7340 is sorted by rows as output by the function @code{sortrows} (with no options).
7341 7341
7342 This function does not support sparse matrices. 7342 This function does not support sparse matrices.
7343 @seealso{sort, sortrows} 7343 @seealso{sort, sortrows}
7344 @end deftypefn */) 7344 @end deftypefn */)
7345 { 7345 {