octave_packages/m/miscellaneous/symvar.m

   1 ## Copyright (C) 2008-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} symvar (@var{s})
  21 ## Identify the argument names in the function defined by a string.
  22 ## Common constant names such as @code{pi}, @code{NaN}, @code{Inf},
  23 ## @code{eps}, @code{i} or @code{j} are ignored.  The arguments that are
  24 ## found are returned in a cell array of strings.  If no variables are
  25 ## found then the returned cell array is empty.
  26 ## @end deftypefn
  27
  28 function args = symvar (s)
  29   args = argnames (inline (s));
  30 endfunction
  31
  32 ## This function is tested by the tests for argnames().
  33 %!assert (1)