umf.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
  2. <html>
  3. <!-- Created on December 10, 2012 by texi2html 1.82
  4. texi2html was written by:
  5. Lionel Cons <[email protected]> (original author)
  6. Karl Berry <[email protected]>
  7. Olaf Bachmann <[email protected]>
  8. and many others.
  9. Maintained by: Many creative people.
  10. Send bugs and suggestions to <[email protected]>
  11. -->
  12. <head>
  13. <title>avram - a virtual machine code interpreter: D.17 umf</title>
  14. <meta name="description" content="avram - a virtual machine code interpreter: D.17 umf">
  15. <meta name="keywords" content="avram - a virtual machine code interpreter: D.17 umf">
  16. <meta name="resource-type" content="document">
  17. <meta name="distribution" content="global">
  18. <meta name="Generator" content="texi2html 1.82">
  19. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  20. <style type="text/css">
  21. <!--
  22. a.summary-letter {text-decoration: none}
  23. blockquote.smallquotation {font-size: smaller}
  24. pre.display {font-family: serif}
  25. pre.format {font-family: serif}
  26. pre.menu-comment {font-family: serif}
  27. pre.menu-preformatted {font-family: serif}
  28. pre.smalldisplay {font-family: serif; font-size: smaller}
  29. pre.smallexample {font-size: smaller}
  30. pre.smallformat {font-family: serif; font-size: smaller}
  31. pre.smalllisp {font-size: smaller}
  32. span.roman {font-family:serif; font-weight:normal;}
  33. span.sansserif {font-family:sans-serif; font-weight:normal;}
  34. ul.toc {list-style: none}
  35. -->
  36. </style>
  37. </head>
  38. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  39. <a name="umf"></a>
  40. <table cellpadding="1" cellspacing="1" border="0">
  41. <tr><td valign="middle" align="left">[<a href="rmath-exceptions.html#rmath-exceptions" title="Previous section in reading order"> &lt; </a>]</td>
  42. <td valign="middle" align="left">[<a href="umf-input-parameters.html#umf-input-parameters" title="Next section in reading order"> &gt; </a>]</td>
  43. <td valign="middle" align="left"> &nbsp; </td>
  44. <td valign="middle" align="left">[<a href="External-Libraries.html#External-Libraries" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  45. <td valign="middle" align="left">[<a href="External-Libraries.html#External-Libraries" title="Up section"> Up </a>]</td>
  46. <td valign="middle" align="left">[<a href="Copying.html#Copying" title="Next chapter"> &gt;&gt; </a>]</td>
  47. <td valign="middle" align="left"> &nbsp; </td>
  48. <td valign="middle" align="left"> &nbsp; </td>
  49. <td valign="middle" align="left"> &nbsp; </td>
  50. <td valign="middle" align="left"> &nbsp; </td>
  51. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  52. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  53. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  54. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  55. </tr></table>
  56. <hr size="1">
  57. <a name="umf-1"></a>
  58. <h2 class="section">D.17 <code>umf</code></h2>
  59. <p>Systems of equations described by sparse matrices (i.e., matrices
  60. <a name="index-sparse-matrices"></a>
  61. containing mostly zeros) arise in certain practical problems. The
  62. usual array representation in which zeros are explicitly stored would
  63. be prohibitive for large matrices occurring in many problems of
  64. interest. A more sophisticated approach is used by the <code>umf</code>
  65. library to manage memory efficiently, which is documented at
  66. <a href="http://www.cise.ufl.edu/research/sparse/SuiteSparse/current/SuiteSparse/UMFPACK/Doc/">http://www.cise.ufl.edu/research/sparse/SuiteSparse/current/SuiteSparse/UMFPACK/Doc/</a>.
  67. </p>
  68. <p>A virtual code interface to functions for solving sparse systems of
  69. equations by these methods is afforded by library functions of the form
  70. </p>
  71. <table><tr><td>&nbsp;</td><td><pre class="example">library('umf',f)
  72. </pre></td></tr></table>
  73. <p>where the library function name, <code>f</code> is a character string
  74. of the form <code><var>tt</var>_<var>m</var>_<var>rrr</var></code>.
  75. </p>
  76. <ul>
  77. <li> <var>tt</var>
  78. can be either <code>di</code> for real matrices, or <code>zi</code> for complex.
  79. </li><li> <var>m</var>
  80. can be one of <code>a</code>, <code>t</code>, or <code>c</code> for solving a system
  81. given either by a matrix, its transpose, or its conjugate transpose,
  82. respectively,
  83. <a name="index-conjugate-transpose"></a>
  84. corresponding to mnemonics <code>A</code>, <code>Aat</code> and <code>At</code> used in
  85. the C language API.
  86. </li><li> <var>rrr</var>
  87. is either <code>trp</code> or <code>col</code>, to indicate a sparse matrix expressed
  88. either as a list of triples, or in packed column form, as documented below.
  89. </li></ul>
  90. <p>The complete set of function names for this library interface is as
  91. follows.
  92. </p>
  93. <table><tr><td>&nbsp;</td><td><pre class="example">di_a_trp di_a_col zi_a_trp zi_a_col
  94. di_t_trp di_t_col zi_t_trp zi_t_col
  95. zi_c_trp zi_c_col
  96. </pre></td></tr></table>
  97. <p>Not all combinations are represented, because the conjugate transpose
  98. is relevant only to complex matrices.
  99. </p>
  100. <table class="menu" border="0" cellspacing="0">
  101. <tr><td align="left" valign="top"><a href="umf-input-parameters.html#umf-input-parameters">D.17.1 <code>umf</code> input parameters</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  102. </td></tr>
  103. <tr><td align="left" valign="top"><a href="umf-output.html#umf-output">D.17.2 <code>umf</code> output</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  104. </td></tr>
  105. <tr><td align="left" valign="top"><a href="umf-exceptions.html#umf-exceptions">D.17.3 <code>umf</code> exceptions</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  106. </td></tr>
  107. <tr><td align="left" valign="top"><a href="Additional-umf-notes.html#Additional-umf-notes">D.17.4 Additional <code>umf</code> notes</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
  108. </td></tr>
  109. </table>
  110. <hr size="1">
  111. <table cellpadding="1" cellspacing="1" border="0">
  112. <tr><td valign="middle" align="left">[<a href="rmath-exceptions.html#rmath-exceptions" title="Previous section in reading order"> &lt; </a>]</td>
  113. <td valign="middle" align="left">[<a href="umf-input-parameters.html#umf-input-parameters" title="Next section in reading order"> &gt; </a>]</td>
  114. <td valign="middle" align="left"> &nbsp; </td>
  115. <td valign="middle" align="left">[<a href="External-Libraries.html#External-Libraries" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  116. <td valign="middle" align="left">[<a href="External-Libraries.html#External-Libraries" title="Up section"> Up </a>]</td>
  117. <td valign="middle" align="left">[<a href="Copying.html#Copying" title="Next chapter"> &gt;&gt; </a>]</td>
  118. <td valign="middle" align="left"> &nbsp; </td>
  119. <td valign="middle" align="left"> &nbsp; </td>
  120. <td valign="middle" align="left"> &nbsp; </td>
  121. <td valign="middle" align="left"> &nbsp; </td>
  122. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  123. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  124. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  125. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  126. </tr></table>
  127. <p>
  128. <font size="-1">
  129. This document was generated on <i>December 10, 2012</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.82</i></a>.
  130. </font>
  131. <br>
  132. </p>
  133. </body>
  134. </html>