Update parameters vocabulary
[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">
14   <info>
15     <pubdate>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006) $</pubdate>
16   </info>
17   <refnamediv>
18     <refname>part</refname>
19     <refpurpose> extraction of strings</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>[c]=part(mp,v)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>mp,c</term>
30         <listitem>
31           <para>Matrix of character strings.</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>v</term>
36         <listitem>
37           <para>Integer row vector.</para>
38         </listitem>
39       </varlistentry>
40     </variablelist>
41   </refsection>
42   <refsection>
43     <title>Description</title>
44     <para>
45     Let <literal>s[k]</literal> stands for the <literal>k</literal> character of string <literal>s</literal> ( 
46     or the white space character if <literal>k &gt;length(s)</literal>).</para>
47     <para><literal>part</literal> returns <literal>c</literal>, a matrix of character strings, such that 
48     <literal>c(i,j)</literal> is the string <literal>"s[v(1)]...s[v(n)]"</literal> ( <literal>s=mp(i,j)</literal> ).</para>
49   </refsection>
50   <refsection>
51     <title>Examples</title>
52     <programlisting role="example"><![CDATA[
53 // returns characters position 8 to 11
54 part("How to use ""part"" ?",8:11)
55
56 // returns characters position 2 to 4 for each element
57 // no characters replaced by ''
58 c = part(['a','abc','abcd'],2:4)
59
60 // returns character position 1 for each element and add characters position 4 to 7 of each element
61 c = part(['abcdefg','hijklmn','opqrstu'],[1,4:7]);
62
63 // returns character 4 for each element, add characters position 1 to 7 and add character position 4 for each element
64 c = part(['abcdefg','hijklmn','opqrstu'],[4,1:7,4]);
65
66 // returns character position 1,add again character position 1 and character position 2
67 c=part(['a','abc','abcd'],[1,1,2])
68
69 // a a a  
70 part(['a','abc','abcd'],[1])
71
72 // aa aa aa 
73 part(['a','abc','abcd'],[1,1])
74
75 // aa aab aab 
76 part(['a','abc','abcd'],[1,1,2])
77  
78   ]]></programlisting>
79   </refsection>
80   <refsection>
81     <title>See Also</title>
82     <simplelist type="inline">
83       <member>
84         <link linkend="string">string</link>
85       </member>
86       <member>
87         <link linkend="length">length</link>
88       </member>
89     </simplelist>
90   </refsection>
91 </refentry>