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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 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 version="5.0-subset Scilab" xml:id="string" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns4="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:db="http://docbook.org/ns/docbook">
<info>
<pubdate>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006)
$</pubdate>
</info>
<refnamediv>
<refname>string</refname>
<refpurpose>conversion to string</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>string(x)
[out, in, text] = string(x)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>x</term>
<listitem>
<para>Boolean, complex, real, integer, polynomial matrix, library or
function</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>converts a matrix into a matrix of strings.</para>
<para>If <literal>x</literal> is a function
<literal>[out, in, text]=string(x)</literal> returns three vectors strings :
<literal>out</literal> is the vector of output variables,
<literal>in</literal> is the vector of input variables, and
<literal>text</literal> is the (column) vector of the source code of the
function.</para>
<para>If <literal>x</literal> is a <literal>lib</literal> variable (library), text
is a character string column vector. The first element contains the path
of library file and the other the name of functions it defines.</para>
<para>Character strings are defined as <literal>'string'</literal>
(between quotes) or <literal>"string"</literal> (between doublequotes);
matrices of strings are defined as usual constant matrices.</para>
<para>Concatenation of strings is made by the <literal>+</literal>
operation.</para>
<para>For complex, real, integer, polynomial matrix <literal>string</literal> output is managed by <link linkend="format">format</link> function (see examples).</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example">string(rand(2, 2))
deff("y = mymacro(x)", "y = x + 1")
[out, in, text] = string(mymacro)
x = 123.356;
disp("Result is " + string(x));
disp("/" + string(~%t) + "/");
disp("/" + string(%i+1) + "/");
disp("/" + string(int16(-123)) + "/");
disp("/" + string(1 + %s + %s^3) + "/");
string(corelib)
v = format();
disp(string(%pi))
format(24);
disp(string(%pi))
format(v(2))
</programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member><link linkend="part">part</link></member>
<member><link linkend="length">length</link></member>
<member><link linkend="quote">quote</link></member>
<member><link linkend="evstr">evstr</link></member>
<member><link linkend="execstr">execstr</link></member>
<member><link linkend="strsubst">strsubst</link></member>
<member><link linkend="strcat">strcat</link></member>
<member><link linkend="strindex">strindex</link></member>
<member><link linkend="sci2exp">sci2exp</link></member>
<member><link linkend="format">format</link></member>
</simplelist>
</refsection>
</refentry>
|