blob: 18b8689f475de15d66807bc901ddf2593138f32b (
plain)
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
72
73
74
75
76
77
78
79
80
|
<?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.1-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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fun2string">
<refnamediv>
<refname>fun2string</refname>
<refpurpose>generates ASCII definition of a Scilab function</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>txt = fun2string(fun, name)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>fun</term>
<listitem>
<para>
a <literal>function</literal> type variable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>name</term>
<listitem>
<para>a character string, the generated function name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>txt</term>
<listitem>
<para>a column vector of strings, the text giving the Scilab instructions.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
Given a loaded Scilab function pseudo-code <function>fun2string</function> allows to
re-generate the code. The generated
code is indented and beautified.
</para>
<para>
The mechanism is similar, but simpler than the <function>mfile2sci</function> one. It may
be adapted for syntax translations.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
txt = fun2string(asinh,'foo');
write(%io(2),txt,'(a)')
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="exec">exec</link>
</member>
<member>
<link linkend="edit">edit</link>
</member>
<member>
<link linkend="macrovar">macrovar</link>
</member>
</simplelist>
</refsection>
</refentry>
|
