modules/string/help/en_US/tokenpos.xml


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

<?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.1-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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tokenpos">
    <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 delimiters.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>kdf</term>
                <listitem>
                    <para>
                        a two column 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>
            <code>kdf = tokenpos(str [,delimiter])</code> searches the tokens
            included in the string <varname>str</varname>. The
            <varname>delimiter</varname> default value is <literal>[" ",&lt;Tab&gt;]</literal>
            where <literal>&lt;Tab&gt;</literal> stands for
            <code>ascii(9)</code>. 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>