← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/sparse/help/en_US/sparseconvert/mtlb_sparse.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/sparse/help/en_US/sparseconvert/mtlb_sparse.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_sparse">
14
 
  <refnamediv>
15
 
    <refname>mtlb_sparse</refname>
16
 
    <refpurpose>  convert sparse matrix</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>Y=mtlb_sparse(X)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>X</term>
27
 
        <listitem>
28
 
          <para>sparse matrix</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>Y</term>
33
 
        <listitem>
34
 
          <para>sparse matrix in Matlab format</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
    </variablelist>
38
 
  </refsection>
39
 
  <refsection>
40
 
    <title>Description</title>
41
 
    <para>
42
 
      <literal>Y=mtlb_sparse(X)</literal> is used to convert <literal>X</literal>, a Scilab sparse matrix, to 
43
 
      Matlab format. <literal>Y</literal> is the a variable with type 7,
44
 
      i.e. <literal>type(Y)</literal> is equal to 7.
45
 
      This function should be used in mexfiles (a Matlab mexfile containing sparse
46
 
      matrices can be used only if the Scilab sparse matrices are converted
47
 
      to that format). The functions <literal>full</literal> and <literal>spget</literal>  work
48
 
      with this format.
49
 
    </para>
50
 
    <para>
51
 
      Other operations and functions using this format
52
 
      can be overloaded with Scilab functions using the prefix "%msp". 
53
 
      For instance the function 
54
 
      <literal>%msp_p(x)</literal> (see SCI/modules/overloading/macros directory) is used to
55
 
      display such "type 7" objects.
56
 
    </para>
57
 
  </refsection>
58
 
  <refsection>
59
 
    <title>Examples</title>
60
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>mtlb_sparse</refname>
 
16
        <refpurpose>  convert sparse matrix</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>Y=mtlb_sparse(X)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>X</term>
 
27
                <listitem>
 
28
                    <para>sparse matrix</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>Y</term>
 
33
                <listitem>
 
34
                    <para>sparse matrix in Matlab format</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
        </variablelist>
 
38
    </refsection>
 
39
    <refsection>
 
40
        <title>Description</title>
 
41
        <para>
 
42
            <literal>Y=mtlb_sparse(X)</literal> is used to convert <literal>X</literal>, a Scilab sparse matrix, to 
 
43
            Matlab format. <literal>Y</literal> is the a variable with type 7,
 
44
            i.e. <literal>type(Y)</literal> is equal to 7.
 
45
            This function should be used in mexfiles (a Matlab mexfile containing sparse
 
46
            matrices can be used only if the Scilab sparse matrices are converted
 
47
            to that format). The functions <literal>full</literal> and <literal>spget</literal>  work
 
48
            with this format.
 
49
        </para>
 
50
        <para>
 
51
            Other operations and functions using this format
 
52
            can be overloaded with Scilab functions using the prefix "%msp". 
 
53
            For instance the function 
 
54
            <literal>%msp_p(x)</literal> (see SCI/modules/overloading/macros directory) is used to
 
55
            display such "type 7" objects.
 
56
        </para>
 
57
    </refsection>
 
58
    <refsection>
 
59
        <title>Examples</title>
 
60
        <programlisting role="example"><![CDATA[ 
61
61
X=sparse(rand(2,2)); Y=mtlb_sparse(X);
62
62
Y, full(Y), [ij,v,mn]=spget(Y)
63
63
 ]]></programlisting>
64
 
  </refsection>
65
 
  <refsection role="see also">
66
 
    <title>See Also</title>
67
 
    <simplelist type="inline">
68
 
      <member>
69
 
        <link linkend="full">full</link>
70
 
      </member>
71
 
      <member>
72
 
        <link linkend="spget">spget</link>
73
 
      </member>
74
 
    </simplelist>
75
 
  </refsection>
 
64
    </refsection>
 
65
    <refsection role="see also">
 
66
        <title>See Also</title>
 
67
        <simplelist type="inline">
 
68
            <member>
 
69
                <link linkend="full">full</link>
 
70
            </member>
 
71
            <member>
 
72
                <link linkend="spget">spget</link>
 
73
            </member>
 
74
        </simplelist>
 
75
    </refsection>
76
76
</refentry>