Add license header (string module)
[scilab.git] / scilab / modules / string / help / en_US / part.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
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 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
14 <MAN>
15   <LANGUAGE>eng</LANGUAGE>
16   <TITLE>part</TITLE>
17   <TYPE>Scilab Function</TYPE>
18   <DATE>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006) $</DATE>
19   <SHORT_DESCRIPTION name="part"> extraction of strings</SHORT_DESCRIPTION>
20   <CALLING_SEQUENCE>
21     <CALLING_SEQUENCE_ITEM>[c]=part(mp,v)  </CALLING_SEQUENCE_ITEM>
22   </CALLING_SEQUENCE>
23   <PARAM>
24     <PARAM_INDENT>
25       <PARAM_ITEM>
26         <PARAM_NAME>mp,c</PARAM_NAME>
27         <PARAM_DESCRIPTION>
28           <SP>: string matrices</SP>
29         </PARAM_DESCRIPTION>
30       </PARAM_ITEM>
31       <PARAM_ITEM>
32         <PARAM_NAME>v</PARAM_NAME>
33         <PARAM_DESCRIPTION>
34           <SP>: integer vector.</SP>
35         </PARAM_DESCRIPTION>
36       </PARAM_ITEM>
37     </PARAM_INDENT>
38   </PARAM>
39   <DESCRIPTION>
40     <P>
41     Let <VERB>s[k]</VERB> stands for the <VERB>k</VERB> character of string <VERB>s</VERB> ( 
42     or the white space character if <VERB>k &gt;length(s)</VERB>).</P>
43     <P><VERB>part</VERB> returns <VERB>c</VERB>, a matrix of character strings, such that 
44     <VERB>c(i,j)</VERB> is the string <VERB>&quot;s[v(1)]...s[v(n)]&quot;</VERB> ( <VERB>s=mp(i,j)</VERB> ).</P>
45   </DESCRIPTION>
46   <EXAMPLE>
47 <![CDATA[
48 c=part(['a','abc','abcd'],[1,1,2])
49  ]]>
50   </EXAMPLE>
51   <SEE_ALSO>
52     <SEE_ALSO_ITEM>
53       <LINK>string</LINK>
54     </SEE_ALSO_ITEM>
55     <SEE_ALSO_ITEM>
56       <LINK>length</LINK>
57     </SEE_ALSO_ITEM>
58   </SEE_ALSO>
59 </MAN>