File: tokenpos.xml

package info (click to toggle)
scilab 5.3.3-10
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 330,656 kB
file content (74 lines) | stat: -rw-r--r-- 2,786 bytes parent folder | download
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
<?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 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="tokenpos">
  <info>
    <pubdate>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006) $</pubdate>
  </info>
  <refnamediv>
    <refname>tokenpos</refname>
    <refpurpose> returns the tokens positions in a character string.  </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>kdf=tokenpos(str [,delimiter])</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
        <term>str</term>
        <listitem>
          <para>A character string. The string where to search the tokens.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>delimiter</term>
        <listitem>
          <para>(optional) A character or a vector of characters. The tokens delimeters.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>kdf</term>
        <listitem>
          <para>Two columns matrix, first column gives the index of the beginning of the tokens, the second gives the index of the last character of the tokens.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para><literal>kdf=tokenpos(str [,delimiter]) </literal> searches the tokens included in the
    string <literal>str</literal>. The <literal>delimiter</literal> default value is [" ",&lt;Tab&gt;]
    where &lt;Tab&gt; stands for <literal>ascii(9)</literal>. It returns the indices of the
    first and last characters of each found tokens.</para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[ 
str='This is a character string';
kdf=tokenpos(str)
first=part(str,kdf(1,1):kdf(1,2))
 ]]></programlisting>
  </refsection>
  <refsection role="see also">
<title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="strindex">strindex</link>
      </member>
      <member>
        <link linkend="tokens">tokens</link>
      </member>
    </simplelist>
  </refsection>
</refentry>