scilab-getfem++ 4.2.1~beta1~svn4635~dfsg-3+b1 / usr / lib / x86_64-linux-gnu / scilab-getfem++ / help / en_US / sparses / sp_luinc.xml

This file is indexed.

/usr/lib/x86_64-linux-gnu/scilab-getfem++/help/en_US/sparses/sp_luinc.xml is in scilab-getfem++ 4.2.1~beta1~svn4635~dfsg-3+b1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="sp_luinc" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <info>
    <pubdate>$LastChangedDate: 2009-09-16 $</pubdate>
  </info>

  <refnamediv>
    <refname>sp_lu</refname>

    <refpurpose>Performs an incomplete LU decomposition on a sparse matrix</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>[L[,U]] = sp_luinc(M[,alpha])</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>M</term>

        <listitem>
          <para>the real sparse matrix on which we will perform the
          LU decomposition</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>alpha</term>

        <listitem>
          <para>a coefficient used in the partial pivoting (default
          value: 1).</para>
	  <para>partial pivoting and Markowitz criterion:</para>
          <para>|a[p][k]| >= alpha * max_i |a[i][k]|</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>L</term>

        <listitem>
          <para>the L sparse matrix from the LU decomposition </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>U</term>

        <listitem>
          <para>the U sparse matrix from the LU decomposition</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>

    <para>Performs an incomplete LU decomposition on a sparse
    matrix.</para>
    <para>At the end of the decomposition, the number of non zeros
    elements in the L and U matrixes is less or equal to the number of
    non zeros elements in the M matrix.</para>
  </refsection>

  <refsection>
    <title>Example</title>

    <programlisting role="example"><![CDATA[ 
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="sp_lu">sp_lu</link></member>
      <member><link linkend="sp_chol">sp_chol</link></member>
      <member><link linkend="sp_cholinc">sp_cholinc</link></member>
      <member><link linkend="sp_cgs">sp_cgs</link></member>
      <member><link linkend="sp_cgne">sp_sgne</link></member>
      <member><link linkend="sp_gmres">sp_gmres</link></member>
      <member><link linkend="sp_mgcr">sp_mgcr</link></member>
      <member><link linkend="sp_chsolve">sp_chsolve</link></member>
      <member><link linkend="sp_lusolve">sp_lusolve</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>

    <simplelist type="vert">
      <member>Yann COLLETTE</member>
    </simplelist>
  </refsection>
</refentry>

APT Browse - Built by Thomas Orozco.