~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/compatibility_functions/help/en_US/mtlb_strcmp.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
    *
12
12
    -->
13
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="mtlb_strcmp">
14
 
  <refnamediv>
15
 
    <refname>mtlb_strcmp</refname>
16
 
    <refpurpose>Matlab strcmp emulation function</refpurpose>
17
 
  </refnamediv>
18
 
  <refsection>
19
 
    <title>Description</title>
20
 
    <para>
21
 
      There is no Scilab function equivalent for Matlab <literal>strcmp</literal>, there is equivalent instructions.
22
 
    </para>
23
 
    <para>
24
 
      The function <literal>mtlb_strcmp(A,B)</literal> is used by
25
 
      <literal>mfile2sci</literal> to replace <literal>strcmp(A,B)</literal> when it was not
26
 
      possible to know what were the inputs while porting Matlab code to Scilab. This function will
27
 
      determine the correct semantic at run time. If you want to have a
28
 
      more efficient code it is possible to replace <literal>mtlb_strcmp</literal> calls:
29
 
    </para>
30
 
    <itemizedlist>
31
 
      <listitem>
32
 
        <para>
33
 
          If <literal>A</literal> and <literal>B</literal> are character strings
34
 
          <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>A==B</literal>
35
 
        </para>
36
 
      </listitem>
37
 
      <listitem>
38
 
        <para>
39
 
          If <literal>A</literal> and/or <literal>B</literal> is not a character string
40
 
          <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>0</literal>
41
 
        </para>
42
 
      </listitem>
43
 
    </itemizedlist>
44
 
    <para>
45
 
      Caution: <literal>mtlb_strcmp</literal> has not to be used for hand coded functions.
46
 
    </para>
47
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>mtlb_strcmp</refname>
 
16
        <refpurpose>Matlab strcmp emulation function</refpurpose>
 
17
    </refnamediv>
 
18
    <refsection>
 
19
        <title>Description</title>
 
20
        <para>
 
21
            There is no Scilab function equivalent for Matlab <literal>strcmp</literal>, there is equivalent instructions.
 
22
        </para>
 
23
        <para>
 
24
            The function <literal>mtlb_strcmp(A,B)</literal> is used by
 
25
            <literal>mfile2sci</literal> to replace <literal>strcmp(A,B)</literal> when it was not
 
26
            possible to know what were the inputs while porting Matlab code to Scilab. This function will
 
27
            determine the correct semantic at run time. If you want to have a
 
28
            more efficient code it is possible to replace <literal>mtlb_strcmp</literal> calls:
 
29
        </para>
 
30
        <itemizedlist>
 
31
            <listitem>
 
32
                <para>
 
33
                    If <literal>A</literal> and <literal>B</literal> are character strings
 
34
                    <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>A==B</literal>
 
35
                </para>
 
36
            </listitem>
 
37
            <listitem>
 
38
                <para>
 
39
                    If <literal>A</literal> and/or <literal>B</literal> is not a character string
 
40
                    <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>0</literal>
 
41
                </para>
 
42
            </listitem>
 
43
        </itemizedlist>
 
44
        <para>
 
45
            Caution: <literal>mtlb_strcmp</literal> has not to be used for hand coded functions.
 
46
        </para>
 
47
    </refsection>
48
48
</refentry>