blob: 2ada67bf35cb3d66dc8b04d9101d9ed8c8efe574 (
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
81
82
83
84
85
86
87
88
89
90
91
92
|
<?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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="ReadHBSparse" xml:lang="en">
<refnamediv>
<refname>ReadHBSparse</refname>
<refpurpose>read a Harwell-Boeing sparse format file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>[A, description, ref, mtype] = ReadHBSparse([filename])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>filename</term>
<listitem>
<para>(optional) a string given the filename (eventually preceeding
by the path), if filename is not given then the function use <link linkend="uigetfile">uigetfile</link> to get filename
interactively
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>A</term>
<listitem>
<para>the sparse matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>description</term>
<listitem>
<para>a string given some information about the matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ref</term>
<listitem>
<para>a string given the reference of the matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>mtype</term>
<listitem>
<para>a string given the type of the matrix</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>An utility to read the Harwell-Boeing sparse matrix format.
Currently do not work for unassembled matrix. Also the eventual rhs vectors
of the file are not returned. Generally the file name is of the form
ref.mtype where mtype is a 3 letters word abc given some information
(already inside the file) on the matrix :
</para>
<programlisting role=""><![CDATA[
a = R|C|P for real|complex|pattern (no values given)
b = S|H|Z|U for symmetric|hermitian|skew symmetric|asymmetric
c = A|E for assembled|unassembled matrix
(case E is not treated by this func)
]]></programlisting>
</refsection>
<refsection>
<title>References</title>
<para>Users' Guide for the Harwell-Boeing Sparse Matrix Collection Iain S.
Duff, Roger G. Grimes, John G. Lewis. You may found this guide and
numerous sparse matrices (in the Harwell-Boeing format) at the University
of Florida Sparse Matrix Collection
</para>
<para>
web site : <ulink url="http://www.cise.ufl.edu/research/sparse/matrices/">http://www.cise.ufl.edu/research/sparse/matrices/</ulink>
</para>
<para>
maintained by Tim Davis (<ulink url="http://www.cise.ufl.edu/~davis/">http://www.cise.ufl.edu/~davis/</ulink>)
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
[A] = ReadHBSparse(SCI+"/modules/umfpack/examples/arc130.rua");
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="PlotSparse">PlotSparse</link>
</member>
</simplelist>
</refsection>
</refentry>
|
