annotate scripts/miscellaneous/symvar.m @ 7948:af10baa63915 ss-3-1-50

3.1.50 snapshot
author John W. Eaton <jwe@octave.org>
date Fri, 18 Jul 2008 17:42:48 -0400
parents e800c69ee467
children fca0dc2fb042
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7765
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## Copyright (C) 2008 David Bateman
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {} symvar (@var{s})
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## Identifies the argument names in the function defined by a string.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## Common constant names such as @code{pi}, @code{NaN}, @code{Inf},
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @code{eps}, @code{i} or @code{j} are ignored. The arguments that are
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## found are returned in a cell array of strings. If no variables are
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## found then the returned cell array is empty.
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @end deftypefn
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 function args = symvar (s)
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 args = argnames (inline (s));
e800c69ee467 Add symvar function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 endfunction