1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) ????-2008 - INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="macrovar">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>macrovar</refname>
<refpurpose> variables of function</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>vars=macrovar(function)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>vars</term>
<listitem>
<para>list <literal>list(in,out,nolocal,called,locals)</literal></para>
</listitem>
</varlistentry>
<varlistentry>
<term>function</term>
<listitem>
<para>name of a function</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
Returns in a list the set of variables used by a function.
<literal>vars</literal> is a list made of five column vectors of character strings</para>
<para><literal>in</literal> input variables (<literal>vars(1)</literal>)</para>
<para><literal>out</literal> output variables (<literal>vars(2)</literal>)</para>
<para><literal>nolocal</literal>referenced variables which are not defined inside the function and which are not functions (<literal>vars(3)</literal>)</para>
<para><literal>called</literal> names of functions called (<literal>vars(4)</literal>)</para>
<para><literal>locals</literal> local variables (<literal>vars(5)</literal>)</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
deff('y=f(x1,x2)','loc=1;y=a*x1+x2-loc')
vars=macrovar(f)
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="string">string</link>
</member>
<member>
<link linkend="macr2lst">macr2lst</link>
</member>
</simplelist>
</refsection>
</refentry>
|