Online help : converted XML files that valid the new scilab.rnc schema.
[scilab.git] / scilab / modules / string / help / en_US / part.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - 
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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="part"><info><pubdate>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006) $</pubdate></info><refnamediv><refname>part</refname><refpurpose> extraction of strings</refpurpose></refnamediv>
14   
15   
16   
17   
18   
19   <refsynopsisdiv><title>Calling Sequence</title><synopsis>[c]=part(mp,v)</synopsis></refsynopsisdiv>
20   <refsection><title>Parameters</title>
21     <variablelist>
22       <varlistentry>
23         <term>mp,c</term>
24         <listitem>
25           <para>string matrices</para>
26         </listitem>
27       </varlistentry>
28       <varlistentry>
29         <term>v</term>
30         <listitem>
31           <para>integer vector.</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35   </refsection>
36   <refsection><title>Description</title>
37     <para>
38     Let <literal>s[k]</literal> stands for the <literal>k</literal> character of string <literal>s</literal> ( 
39     or the white space character if <literal>k &gt;length(s)</literal>).</para>
40     <para><literal>part</literal> returns <literal>c</literal>, a matrix of character strings, such that 
41     <literal>c(i,j)</literal> is the string <literal>"s[v(1)]...s[v(n)]"</literal> ( <literal>s=mp(i,j)</literal> ).</para>
42   </refsection>
43   <refsection><title>Examples</title><programlisting role="example"><![CDATA[
44
45 c=part(['a','abc','abcd'],[1,1,2])
46  
47   ]]></programlisting></refsection>
48   <refsection><title>See Also</title><simplelist type="inline">
49     <member>
50       <link linkend="string">string</link>
51     </member>
52     <member>
53       <link linkend="length">length</link>
54     </member>
55   </simplelist></refsection>
56 </refentry>