← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/compatibility_functions/help/en_US/mtlb_sort.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:
modules/compatibility_functions/help/en_US/mtlb_sort.xml
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_sort">
14
 
  <refnamediv>
15
 
    <refname>mtlb_sort</refname>
16
 
    <refpurpose>Matlab sort emulation
17
 
      function
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>P = mtlb_sort(X)
23
 
      P = mtlb_sort(X,dim[,mode])
24
 
    </synopsis>
25
 
  </refsynopsisdiv>
26
 
  <refsection>
27
 
    <title>Arguments</title>
28
 
    <variablelist>
29
 
      <varlistentry>
30
 
        <term>X</term>
31
 
        <listitem>
32
 
          <para>a scalar, vector, matrix of reals, booleans or a string</para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
    </variablelist>
36
 
    <variablelist>
37
 
      <varlistentry>
38
 
        <term>dim</term>
39
 
        <listitem>
40
 
          <para>a positive scalar integer</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>mode</term>
45
 
        <listitem>
46
 
          <para>a string ("ascend" or "descend")</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      Matlab <literal>sort</literal> and Scilab <literal>gsort</literal> behave
55
 
      differently in some particular cases:
56
 
    </para>
57
 
    <itemizedlist>
58
 
      <listitem>
59
 
        <para>
60
 
          For a vector <literal>X</literal> the Matlab
61
 
          <literal>sort(X,'g','i')</literal> function call is equivalent to the
62
 
          Scilab <literal>gsort(X)</literal> function call.
63
 
        </para>
64
 
      </listitem>
65
 
      <listitem>
66
 
        <para>
67
 
          The value <literal>1</literal> (resp. <literal>2</literal>) of the Matlab
68
 
          dim is equivalent to the Scilab <literal>"r"</literal> flag (resp.
69
 
          <literal>"c"</literal>).
70
 
        </para>
71
 
      </listitem>
72
 
      <listitem>
73
 
        <para>
74
 
          The Matlab "<literal>ascend"</literal> (resp.
75
 
          <literal>"descend"</literal>) mode is equivalent to the Scilab
76
 
          <literal>"i"</literal> (resp. <literal>"d"</literal>) flag.
77
 
        </para>
78
 
      </listitem>
79
 
    </itemizedlist>
80
 
    <para>
81
 
      The function <literal>mtlb_sort(X[,dim[,mode]])</literal> is used by
82
 
      <literal>mfile2sci</literal> to replace <literal>sort(X[,dim[,mode]])</literal> when
83
 
      it was not possible to know what were the inputs while porting Matlab code
84
 
      to Scilab. This function will determine the correct semantic at run time.
85
 
      If you want to have a more efficient code it is possible to replace
86
 
      <literal>mtlb_sort</literal> call by <link linkend="gsort">gsort</link> call.
87
 
    </para>
88
 
    <para>
89
 
      Caution: <literal>mtlb_sort</literal> has not to be used for hand coded
90
 
      functions.
91
 
    </para>
92
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>mtlb_sort</refname>
 
16
        <refpurpose>Matlab sort emulation
 
17
            function
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>P = mtlb_sort(X)
 
23
            P = mtlb_sort(X,dim[,mode])
 
24
        </synopsis>
 
25
    </refsynopsisdiv>
 
26
    <refsection>
 
27
        <title>Arguments</title>
 
28
        <variablelist>
 
29
            <varlistentry>
 
30
                <term>X</term>
 
31
                <listitem>
 
32
                    <para>a scalar, vector, matrix of reals, booleans or a string</para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
        </variablelist>
 
36
        <variablelist>
 
37
            <varlistentry>
 
38
                <term>dim</term>
 
39
                <listitem>
 
40
                    <para>a positive scalar integer</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>mode</term>
 
45
                <listitem>
 
46
                    <para>a string ("ascend" or "descend")</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            Matlab <literal>sort</literal> and Scilab <literal>gsort</literal> behave
 
55
            differently in some particular cases:
 
56
        </para>
 
57
        <itemizedlist>
 
58
            <listitem>
 
59
                <para>
 
60
                    For a vector <literal>X</literal> the Matlab
 
61
                    <literal>sort(X,'g','i')</literal> function call is equivalent to the
 
62
                    Scilab <literal>gsort(X)</literal> function call.
 
63
                </para>
 
64
            </listitem>
 
65
            <listitem>
 
66
                <para>
 
67
                    The value <literal>1</literal> (resp. <literal>2</literal>) of the Matlab
 
68
                    dim is equivalent to the Scilab <literal>"r"</literal> flag (resp.
 
69
                    <literal>"c"</literal>).
 
70
                </para>
 
71
            </listitem>
 
72
            <listitem>
 
73
                <para>
 
74
                    The Matlab "<literal>ascend"</literal> (resp.
 
75
                    <literal>"descend"</literal>) mode is equivalent to the Scilab
 
76
                    <literal>"i"</literal> (resp. <literal>"d"</literal>) flag.
 
77
                </para>
 
78
            </listitem>
 
79
        </itemizedlist>
 
80
        <para>
 
81
            The function <literal>mtlb_sort(X[,dim[,mode]])</literal> is used by
 
82
            <literal>mfile2sci</literal> to replace <literal>sort(X[,dim[,mode]])</literal> when
 
83
            it was not possible to know what were the inputs while porting Matlab code
 
84
            to Scilab. This function will determine the correct semantic at run time.
 
85
            If you want to have a more efficient code it is possible to replace
 
86
            <literal>mtlb_sort</literal> call by <link linkend="gsort">gsort</link> call.
 
87
        </para>
 
88
        <para>
 
89
            Caution: <literal>mtlb_sort</literal> has not to be used for hand coded
 
90
            functions.
 
91
        </para>
 
92
    </refsection>
93
93
</refentry>