summaryrefslogtreecommitdiff
path: root/modules/umfpack/help/en_US/PlotSparse.xml
blob: 21a5028d73dffc0582939c8f278b42606eda904d (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
70
71
72
73
74
75
76
77
78
79
80
<?xml version="1.0" encoding="UTF-8"?>
<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="PlotSparse">
    <refnamediv>
        <refname>PlotSparse</refname>
        <refpurpose>plot the pattern of non nul elements of a sparse matrix  </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>PlotSparse(A [,style])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>A  </term>
                <listitem>
                    <para>a sparse matrix</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style  </term>
                <listitem>
                    <para>(optional) a string given the color and/or the marker type of the form "[color][mark]" 
                        where color may be a number referring the color you want to use (in the current colormap). 
                        If you use the std colormap then color may be one of the following letters :
                    </para>
                    <programlisting role="no-scilab-exec"><![CDATA[ 
k  for black       b  for blue
r  for red         g  for green
c  for cyan        m  for magenta
y  for yellow      t  for turquoise
G  a dark green
 ]]></programlisting>
                    <para>
                        mark must be one of the following :
                    </para>
                    <programlisting role="no-scilab-exec"><![CDATA[ 
.  point           +  plus 
x  cross           *  circled plus 
D  filled diamond  d  diamond
^  upper triangle  v  down triangle
o  circle
 ]]></programlisting>
                    <para>
                        by default you have "b." (in fact the 2d color) and this is also forced in case of error. 
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            plot the pattern of non nul elements of a sparse matrix :
            each non nul element is drawn with a marker. For "big" 
            matrix use essentially the point . as marker
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
[A,description,ref,mtype] = ReadHBSparse(SCI+"/modules/umfpack/examples/arc130.rua");
PlotSparse(A,"y+")
xtitle(ref + "." + mtype + " : " + description)
 ]]></programlisting>
        <scilab:image>
            [A,description,ref,mtype] = ReadHBSparse(SCI+"/modules/umfpack/examples/arc130.rua");
            PlotSparse(A,"y+")
            xtitle(ref + "." + mtype + " : " + description)
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="ReadHBSparse">ReadHBSparse</link>
            </member>
        </simplelist>
    </refsection>
</refentry>