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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) XXXX-2008 - 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-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" version="5.0-subset Scilab" xml:lang="en" xml:id="mtlb_sparse">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>mtlb_sparse</refname>
<refpurpose> convert sparse matrix</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>Y=mtlb_sparse(X)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>X</term>
<listitem>
<para>sparse matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Y</term>
<listitem>
<para>sparse matrix in Matlab format</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para><literal>Y=mtlb_sparse(X)</literal> is used to convert <literal>X</literal>, a Scilab sparse matrix, to
Matlab format. <literal>Y</literal> is the a variable with type 7,
i.e. <literal>type(Y)</literal> is equal to 7.
This function should be used in mexfiles (a Matlab mexfile containing sparse
matrices can be used only if the Scilab sparse matrices are converted
to that format). The functions <literal>full</literal> and <literal>spget</literal> work
with this format.</para>
<para>
Other operations and functions using this format
can be overloaded with Scilab functions using the prefix "%msp".
For instance the function
<literal>%msp_p(x)</literal> (see SCIDIR/macros/percent directory) is used to
display such "type 7" objects.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
X=sparse(rand(2,2)); Y=mtlb_sparse(X);
Y, full(Y), [ij,v,mn]=spget(Y)
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="full">full</link>
</member>
<member>
<link linkend="spget">spget</link>
</member>
</simplelist>
</refsection>
</refentry>
|
