summaryrefslogtreecommitdiff
path: root/modules/string/help/en_US/convstr.xml
blob: 78fb9d79ca96b848508ed7dfe6b1a63ea7ab3cdd (plain)
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
<?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="convstr">
    <refnamediv>
        <refname>convstr</refname>
        <refpurpose>case conversion</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>[y] = convstr(str, [flag])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>str, y</term>
                <listitem>
                    <para>a matrix of character strings.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>flag</term>
                <listitem>
                    <para>a character option with possible values:</para>
                    <variablelist>
                        <varlistentry>
                            <term>'u'</term>
                            <listitem>
                                <para>for upper;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>'l'</term>
                            <listitem>
                                <para>for lower.</para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The <function>convstr</function> function converts the matrix of strings
            <varname>str</varname> into lower case (for <varname>flag</varname> =
            <literal>"l"</literal>; default value) or upper case (for
            <varname>flag</varname> = <literal>"u"</literal>).
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
A=['this','is';'my','matrix'];
convstr(A,'u')
 ]]></programlisting>
    </refsection>
</refentry>