comparison libinterp/corefcn/data.cc @ 30892:1a3cc2811090

doc: Update documentation for __sort_rows_idx__. * data.cc (F__sort_rows_idx__): Remove comment about function being unused. Add FIXME note about lack of support for sparse matrices. Update docstring to reference input/output variables and sortrows.m.
author Rik <rik@octave.org>
date Mon, 04 Apr 2022 11:22:26 -0700
parents 79b3c0b5c265
children c9788d7f6e65
comparison
equal deleted inserted replaced
30891:79b3c0b5c265 30892:1a3cc2811090
7247 7247
7248 // Sort the rows of the matrix @var{a} according to the order 7248 // Sort the rows of the matrix @var{a} according to the order
7249 // specified by @var{mode}, which can either be 'ascend' or 'descend' 7249 // specified by @var{mode}, which can either be 'ascend' or 'descend'
7250 // and return the index vector corresponding to the sort order. 7250 // and return the index vector corresponding to the sort order.
7251 // 7251 //
7252 // This function does not yet support sparse matrices. 7252 // FIXME: This function does not yet support sparse matrices.
7253 7253
7254 // FIXME: Is this function used anymore? 12/14/2015
7255 DEFUN (__sort_rows_idx__, args, , 7254 DEFUN (__sort_rows_idx__, args, ,
7256 doc: /* -*- texinfo -*- 7255 doc: /* -*- texinfo -*-
7257 @deftypefn {} {} __sort_rows_idx__ (@var{a}, @var{mode}) 7256 @deftypefn {} {@var{idx} =} __sort_rows_idx__ (@var{A}, @var{mode})
7258 Undocumented internal function. 7257 Called internally from @file{sortrows.m}.
7259 @end deftypefn */) 7258 @end deftypefn */)
7260 { 7259 {
7261 int nargin = args.length (); 7260 int nargin = args.length ();
7262 7261
7263 if (nargin < 1 || nargin > 2) 7262 if (nargin < 1 || nargin > 2)