External-Libraries.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  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. External Libraries</title>
  14. <meta name="description" content="avram - a virtual machine code interpreter: D. External Libraries">
  15. <meta name="keywords" content="avram - a virtual machine code interpreter: D. External Libraries">
  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="External-Libraries"></a>
  40. <table cellpadding="1" cellspacing="1" border="0">
  41. <tr><td valign="middle" align="left">[<a href="Changes.html#Changes" title="Previous section in reading order"> &lt; </a>]</td>
  42. <td valign="middle" align="left">[<a href="bes.html#bes" 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="Changes.html#Changes" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  45. <td valign="middle" align="left">[<a href="avram.html#Top" 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="External-Libraries-1"></a>
  58. <h1 class="appendix">D. External Libraries</h1>
  59. <p>Various functions are callable from virtual code applications by way
  60. of the <code>library</code> combinator as explained in <a href="Library-combinator.html#Library-combinator">Library combinator</a>. An expression (shown in <code>silly</code> syntax) of the form
  61. <code>library('foo','bar') x</code> applies a function named <code>'bar'</code>
  62. from a library named <code>'foo'</code> to an argument <code>x</code>.
  63. </p>
  64. <p>A brief overview of the libraries and functions can always be had by
  65. executing
  66. </p>
  67. <table><tr><td>&nbsp;</td><td><pre class="example">$ avram --external-libraries
  68. </pre></td></tr></table>
  69. <p>The listing displayed by this command may show some that are not
  70. included here if this version of the documentation is not current or
  71. your installation has been locally enhanced. It may also lack some
  72. that are documented here if your installation is not fully equipped.
  73. </p>
  74. <p>Although the overview from the command line is adequate for a
  75. reminder, it is not informative enough to explain how each function
  76. should be used. The purpose of this section is to provide this
  77. information in greater detail.
  78. </p>
  79. <p>Some general comments are applicable to all libraries.
  80. </p>
  81. <p>Each library documented in this section can generate error messages in
  82. the event of exceptional conditions, that are documented individually.
  83. In addition to those, it&rsquo;s also possible for any library function to
  84. return error messages of
  85. <a name="index-unrecognized-library"></a>
  86. <a name="index-unrecognized-function-name"></a>
  87. </p>
  88. <table><tr><td>&nbsp;</td><td><pre class="example">&lt;'unrecognized library'&gt;
  89. &lt;'unrecognized <var>xxxx</var> function name'&gt;
  90. </pre></td></tr></table>
  91. <p>where <var>xxxx</var> is the name of a library. These indicate either that
  92. the library name is invalid, or the library name is valid but the
  93. function name is invalid, or that they&rsquo;re both valid but the library
  94. wasn&rsquo;t detected on the host when <code>avram</code> was compiled. A virtual
  95. code application can always avoid these errors by testing for the
  96. availability of a function using the <code>have</code> combinator (<a href="Have-combinator.html#Have-combinator">Have combinator</a>).
  97. </p>
  98. <p>In addition, any library function that operates on numerical values or
  99. lists thereof can return these messages in cases of invalid input.
  100. <a name="index-missing-value-1"></a>
  101. <a name="index-invalid-value-1"></a>
  102. <a name="index-bad-vector-specification"></a>
  103. <a name="index-bad-matrix-specification"></a>
  104. </p>
  105. <table><tr><td>&nbsp;</td><td><pre class="example">&lt;'missing value'&gt;
  106. &lt;'invalid value'&gt;
  107. &lt;'bad vector specification'&gt;
  108. &lt;'bad matrix specification'&gt;
  109. </pre></td></tr></table>
  110. <p>These messages indicate that an input parameter that was required to
  111. be a valid representation of a floating point number, a vector,
  112. or a matrix was something other than that (<a href="Type-Conversions.html#Type-Conversions">Type Conversions</a>).
  113. The last could also occur if a parameter that is required to be
  114. a square matrix has unequal numbers of rows and columns.
  115. </p>
  116. <table class="menu" border="0" cellspacing="0">
  117. <tr><td align="left" valign="top"><a href="bes.html#bes">D.1 <code>bes</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> Bessel functions
  118. </td></tr>
  119. <tr><td align="left" valign="top"><a href="complex.html#complex">D.2 <code>complex</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> native complex arithmetic
  120. </td></tr>
  121. <tr><td align="left" valign="top"><a href="fftw.html#fftw">D.3 <code>fftw</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> fast Fourier transforms
  122. </td></tr>
  123. <tr><td align="left" valign="top"><a href="glpk.html#glpk">D.4 <code>glpk</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> simplex linear programming
  124. </td></tr>
  125. <tr><td align="left" valign="top"><a href="gsldif.html#gsldif">D.5 <code>gsldif</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> numerical differentiation
  126. </td></tr>
  127. <tr><td align="left" valign="top"><a href="gslevu.html#gslevu">D.6 <code>gslevu</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> series acceleration
  128. </td></tr>
  129. <tr><td align="left" valign="top"><a href="gslint.html#gslint">D.7 <code>gslint</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> numerical integration
  130. </td></tr>
  131. <tr><td align="left" valign="top"><a href="harminv.html#harminv">D.8 <code>harminv</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> harmonic inversion
  132. </td></tr>
  133. <tr><td align="left" valign="top"><a href="kinsol.html#kinsol">D.9 <code>kinsol</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> constrained non-linear optimization
  134. </td></tr>
  135. <tr><td align="left" valign="top"><a href="lapack.html#lapack">D.10 <code>lapack</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> linear algebra
  136. </td></tr>
  137. <tr><td align="left" valign="top"><a href="math.html#math">D.11 <code>math</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> native floating point arithmetic
  138. </td></tr>
  139. <tr><td align="left" valign="top"><a href="mtwist.html#mtwist">D.12 <code>mtwist</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> random number generation
  140. </td></tr>
  141. <tr><td align="left" valign="top"><a href="minpack.html#minpack">D.13 <code>minpack</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> non-linear optimization
  142. </td></tr>
  143. <tr><td align="left" valign="top"><a href="mpfr.html#mpfr">D.14 <code>mpfr</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> arbitrary precision arithmetic
  144. </td></tr>
  145. <tr><td align="left" valign="top"><a href="lpsolve.html#lpsolve">D.15 <code>lpsolve</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> mixed integer programming
  146. </td></tr>
  147. <tr><td align="left" valign="top"><a href="rmath.html#rmath">D.16 <code>rmath</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> statistical and special functions
  148. </td></tr>
  149. <tr><td align="left" valign="top"><a href="umf.html#umf">D.17 <code>umf</code></a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> sparse matrices
  150. </td></tr>
  151. </table>
  152. <hr size="1">
  153. <table cellpadding="1" cellspacing="1" border="0">
  154. <tr><td valign="middle" align="left">[<a href="Changes.html#Changes" title="Previous section in reading order"> &lt; </a>]</td>
  155. <td valign="middle" align="left">[<a href="bes.html#bes" title="Next section in reading order"> &gt; </a>]</td>
  156. <td valign="middle" align="left"> &nbsp; </td>
  157. <td valign="middle" align="left">[<a href="Changes.html#Changes" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  158. <td valign="middle" align="left">[<a href="avram.html#Top" title="Up section"> Up </a>]</td>
  159. <td valign="middle" align="left">[<a href="Copying.html#Copying" title="Next chapter"> &gt;&gt; </a>]</td>
  160. <td valign="middle" align="left"> &nbsp; </td>
  161. <td valign="middle" align="left"> &nbsp; </td>
  162. <td valign="middle" align="left"> &nbsp; </td>
  163. <td valign="middle" align="left"> &nbsp; </td>
  164. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  165. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  166. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  167. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  168. </tr></table>
  169. <p>
  170. <font size="-1">
  171. This document was generated on <i>December 10, 2012</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.82</i></a>.
  172. </font>
  173. <br>
  174. </p>
  175. </body>
  176. </html>