← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/umfpack/help/en_US/ReadHBSparse.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/umfpack/help/en_US/ReadHBSparse.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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" version="5.0-subset Scilab" xml:id="ReadHBSparse" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>ReadHBSparse</refname>
5
 
    <refpurpose>read a Harwell-Boeing sparse format file</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[A, description, ref, mtype] = ReadHBSparse([filename])</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Arguments</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>filename</term>
16
 
        <listitem>
17
 
          <para>(optional) a string given the filename (eventually preceeding
18
 
            by the path), if filename is not given then the function use <link linkend="uigetfile">uigetfile</link> to get filename
19
 
            interactively
20
 
          </para>
21
 
        </listitem>
22
 
      </varlistentry>
23
 
      <varlistentry>
24
 
        <term>A</term>
25
 
        <listitem>
26
 
          <para>the sparse matrix</para>
27
 
        </listitem>
28
 
      </varlistentry>
29
 
      <varlistentry>
30
 
        <term>description</term>
31
 
        <listitem>
32
 
          <para>a string given some information about the matrix</para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>ref</term>
37
 
        <listitem>
38
 
          <para>a string given the reference of the matrix</para>
39
 
        </listitem>
40
 
      </varlistentry>
41
 
      <varlistentry>
42
 
        <term>mtype</term>
43
 
        <listitem>
44
 
          <para>a string given the type of the matrix</para>
45
 
        </listitem>
46
 
      </varlistentry>
47
 
    </variablelist>
48
 
  </refsection>
49
 
  <refsection>
50
 
    <title>Description</title>
51
 
    <para>An utility to read the Harwell-Boeing sparse matrix format.
52
 
      Currently do not work for unassembled matrix. Also the eventual rhs vectors
53
 
      of the file are not returned. Generally the file name is of the form
54
 
      ref.mtype where mtype is a 3 letters word abc given some information
55
 
      (already inside the file) on the matrix :
56
 
    </para>
57
 
    <programlisting role=""><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>ReadHBSparse</refname>
 
5
        <refpurpose>read a Harwell-Boeing sparse format file</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>[A, description, ref, mtype] = ReadHBSparse([filename])</synopsis>
 
10
    </refsynopsisdiv>
 
11
    <refsection>
 
12
        <title>Arguments</title>
 
13
        <variablelist>
 
14
            <varlistentry>
 
15
                <term>filename</term>
 
16
                <listitem>
 
17
                    <para>(optional) a string given the filename (eventually preceeding
 
18
                        by the path), if filename is not given then the function use <link linkend="uigetfile">uigetfile</link> to get filename
 
19
                        interactively
 
20
                    </para>
 
21
                </listitem>
 
22
            </varlistentry>
 
23
            <varlistentry>
 
24
                <term>A</term>
 
25
                <listitem>
 
26
                    <para>the sparse matrix</para>
 
27
                </listitem>
 
28
            </varlistentry>
 
29
            <varlistentry>
 
30
                <term>description</term>
 
31
                <listitem>
 
32
                    <para>a string given some information about the matrix</para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>ref</term>
 
37
                <listitem>
 
38
                    <para>a string given the reference of the matrix</para>
 
39
                </listitem>
 
40
            </varlistentry>
 
41
            <varlistentry>
 
42
                <term>mtype</term>
 
43
                <listitem>
 
44
                    <para>a string given the type of the matrix</para>
 
45
                </listitem>
 
46
            </varlistentry>
 
47
        </variablelist>
 
48
    </refsection>
 
49
    <refsection>
 
50
        <title>Description</title>
 
51
        <para>An utility to read the Harwell-Boeing sparse matrix format.
 
52
            Currently do not work for unassembled matrix. Also the eventual rhs vectors
 
53
            of the file are not returned. Generally the file name is of the form
 
54
            ref.mtype where mtype is a 3 letters word abc given some information
 
55
            (already inside the file) on the matrix :
 
56
        </para>
 
57
        <programlisting role=""><![CDATA[ 
58
58
a = R|C|P   for real|complex|pattern (no values given)
59
59
b = S|H|Z|U for symmetric|hermitian|skew symmetric|asymmetric
60
60
c = A|E     for assembled|unassembled matrix 
61
61
            (case E is not treated by this func)
62
62
 ]]></programlisting>
63
 
  </refsection>
64
 
  <refsection>
65
 
    <title>References</title>
66
 
    <para>Users' Guide for the Harwell-Boeing Sparse Matrix Collection Iain S.
67
 
      Duff, Roger G. Grimes, John G. Lewis. You may found this guide and
68
 
      numerous sparse matrices (in the Harwell-Boeing format) at the University
69
 
      of Florida Sparse Matrix Collection 
70
 
    </para>
71
 
    <para>
72
 
      web site : <ulink url="http://www.cise.ufl.edu/research/sparse/matrices/">http://www.cise.ufl.edu/research/sparse/matrices/</ulink>
73
 
    </para>
74
 
    <para>
75
 
      maintained by Tim Davis (<ulink url="http://www.cise.ufl.edu/~davis/">http://www.cise.ufl.edu/~davis/</ulink>)
76
 
    </para>
77
 
  </refsection>
78
 
  <refsection>
79
 
    <title>Examples</title>
80
 
    <programlisting role="example"><![CDATA[ 
 
63
    </refsection>
 
64
    <refsection>
 
65
        <title>References</title>
 
66
        <para>Users' Guide for the Harwell-Boeing Sparse Matrix Collection Iain S.
 
67
            Duff, Roger G. Grimes, John G. Lewis. You may found this guide and
 
68
            numerous sparse matrices (in the Harwell-Boeing format) at the University
 
69
            of Florida Sparse Matrix Collection 
 
70
        </para>
 
71
        <para>
 
72
            web site : <ulink url="http://www.cise.ufl.edu/research/sparse/matrices/">http://www.cise.ufl.edu/research/sparse/matrices/</ulink>
 
73
        </para>
 
74
        <para>
 
75
            maintained by Tim Davis (<ulink url="http://www.cise.ufl.edu/~davis/">http://www.cise.ufl.edu/~davis/</ulink>)
 
76
        </para>
 
77
    </refsection>
 
78
    <refsection>
 
79
        <title>Examples</title>
 
80
        <programlisting role="example"><![CDATA[ 
81
81
[A] = ReadHBSparse(SCI+"/modules/umfpack/examples/arc130.rua");
82
82
 ]]></programlisting>
83
 
  </refsection>
84
 
  <refsection role="see also">
85
 
    <title>See Also</title>
86
 
    <simplelist type="inline">
87
 
      <member>
88
 
        <link linkend="PlotSparse">PlotSparse</link>
89
 
      </member>
90
 
    </simplelist>
91
 
  </refsection>
 
83
    </refsection>
 
84
    <refsection role="see also">
 
85
        <title>See Also</title>
 
86
        <simplelist type="inline">
 
87
            <member>
 
88
                <link linkend="PlotSparse">PlotSparse</link>
 
89
            </member>
 
90
        </simplelist>
 
91
    </refsection>
92
92
</refentry>