products.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. ?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>Special Products</title>
  6. <meta name="GENERATOR" content="Quanta Plus" />
  7. <meta name="AUTHOR" content="Gunter Winkler" />
  8. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  9. <link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
  10. <link rel="stylesheet" href="ublas.css" type="text/css" />
  11. <script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
  12. <script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
  13. </head>
  14. <body>
  15. <h1><img src="../../../../boost.png" align="middle" />Special Products </h1>
  16. <div class="toc" id="toc"></div>
  17. <h2>Functions</h2>
  18. <table summary="" border=0 cellpadding=0 cellspacing=0>
  19. <tr>
  20. <td class="memItemLeft" nowrap align=right valign=top>template&lt;class V, class E1, class E2&gt; BOOST_UBLAS_INLINE V &amp;&nbsp;</td>
  21. <td class="memItemRight" valign=bottom><a class="el" href="#ga8">axpy_prod</a> (const matrix_expression&lt; E1 &gt; &amp;e1, const vector_expression&lt; E2 &gt; &amp;e2, V &amp;v, bool init=true)</td></tr>
  22. <tr>
  23. <td class="mdescLeft">&nbsp;</td>
  24. <td class="mdescRight">computes <code>v += A x</code> or <code>v = A x</code> in an optimized fashion. <a href="#ga8"></a><br /><br /></td></tr>
  25. <tr>
  26. <td class="memItemLeft" nowrap align=right valign=top>template&lt;class V, class E1, class E2&gt; BOOST_UBLAS_INLINE V &amp;&nbsp;</td>
  27. <td class="memItemRight" valign=bottom><a class="el" href="#ga9">axpy_prod</a> (const vector_expression&lt; E1 &gt; &amp;e1, const matrix_expression&lt; E2 &gt; &amp;e2, V &amp;v, bool init=true)</td></tr>
  28. <tr>
  29. <td class="mdescLeft">&nbsp;</td>
  30. <td class="mdescRight">computes <code>v += A<sup>T</sup> x</code> or <code>v = A<sup>T</sup> x</code> in an optimized fashion. <a href="#ga9"></a><br /><br /></td></tr>
  31. <tr>
  32. <td class="memItemLeft" nowrap align=right valign=top>template&lt;class M, class E1, class E2&gt; BOOST_UBLAS_INLINE M &amp;&nbsp;</td>
  33. <td class="memItemRight" valign=bottom><a class="el" href="#ga7">axpy_prod</a> (const matrix_expression&lt; E1 &gt; &amp;e1, const matrix_expression&lt; E2 &gt; &amp;e2, M &amp;m, bool init=true)</td></tr>
  34. <tr>
  35. <td class="mdescLeft">&nbsp;</td>
  36. <td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="#ga7"></a><br /><br /></td></tr>
  37. <tr>
  38. <td class="memItemLeft" nowrap align=right valign=top>template&lt;class M, class E1, class E2&gt; BOOST_UBLAS_INLINE M &amp;&nbsp;</td>
  39. <td class="memItemRight" valign=bottom><a class="el" href="#ga6">opb_prod</a> (const matrix_expression&lt; E1 &gt; &amp;e1, const matrix_expression&lt; E2 &gt; &amp;e2, M &amp;m, bool init=true)</td></tr>
  40. <tr>
  41. <td class="mdescLeft">&nbsp;</td>
  42. <td class="mdescRight">computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion. <a href="#ga6"></a><br /><br /></td></tr>
  43. </table>
  44. <hr />
  45. <a class="anchor" name="ga8" doxytag="boost::numeric::ublas::axpy_prod" ></a>
  46. <table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
  47. <tr>
  48. <td class="mdRow">
  49. <table summary="" cellpadding="0" cellspacing="0" border="0">
  50. <tr>
  51. <td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE V&amp; axpy_prod </td>
  52. <td class="md" valign="top">(&nbsp;</td>
  53. <td class="md" nowrap valign="top">const matrix_expression&lt; E1 &gt; &amp;&nbsp;</td>
  54. <td class="mdname" nowrap> <em>e1</em>, </td>
  55. </tr>
  56. <tr>
  57. <td class="md" nowrap align="right"></td>
  58. <td></td>
  59. <td class="md" nowrap>const vector_expression&lt; E2 &gt; &amp;&nbsp;</td>
  60. <td class="mdname" nowrap> <em>e2</em>, </td>
  61. </tr>
  62. <tr>
  63. <td class="md" nowrap align="right"></td>
  64. <td></td>
  65. <td class="md" nowrap>V &amp;&nbsp;</td>
  66. <td class="mdname" nowrap> <em>v</em>, </td>
  67. </tr>
  68. <tr>
  69. <td class="md" nowrap align="right"></td>
  70. <td></td>
  71. <td class="md" nowrap>bool&nbsp;</td>
  72. <td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
  73. </tr>
  74. <tr>
  75. <td></td>
  76. <td class="md">)&nbsp;</td>
  77. <td class="md" colspan="2"></td>
  78. </tr>
  79. </table>
  80. </td>
  81. </tr>
  82. </table>
  83. <table summary="" cellspacing=5 cellpadding=0 border=0>
  84. <tr>
  85. <td>
  86. &nbsp;
  87. </td>
  88. <td>
  89. <p>
  90. computes <code>v += A x</code> or <code>v = A x</code> in an optimized fashion.
  91. </p>
  92. <dl compact><dt><b>Parameters:</b></dt><dd>
  93. <table summary="" border="0" cellspacing="2" cellpadding="0">
  94. <tr><td></td><td valign=top><em>e1</em>&nbsp;</td><td>the matrix expression <code>A</code> </td></tr>
  95. <tr><td></td><td valign=top><em>e2</em>&nbsp;</td><td>the vector expression <code>x</code> </td></tr>
  96. <tr><td></td><td valign=top><em>v</em>&nbsp;</td><td>the result vector <code>v</code> </td></tr>
  97. <tr><td></td><td valign=top><em>init</em>&nbsp;</td><td>a boolean parameter</td></tr>
  98. </table>
  99. </dl>
  100. <code>axpy_prod(A, x, v, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>v.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
  101. Up to now there are some specialisation for compressed matrices that give a large speed up compared to prod. </td>
  102. </tr>
  103. </table>
  104. <a class="anchor" name="ga9" doxytag="boost::numeric::ublas::axpy_prod" ></a>
  105. <table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
  106. <tr>
  107. <td class="mdRow">
  108. <table summary="" cellpadding="0" cellspacing="0" border="0">
  109. <tr>
  110. <td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE V&amp; axpy_prod </td>
  111. <td class="md" valign="top">(&nbsp;</td>
  112. <td class="md" nowrap valign="top">const vector_expression&lt; E1 &gt; &amp;&nbsp;</td>
  113. <td class="mdname" nowrap> <em>e1</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="md" nowrap align="right"></td>
  117. <td></td>
  118. <td class="md" nowrap>const matrix_expression&lt; E2 &gt; &amp;&nbsp;</td>
  119. <td class="mdname" nowrap> <em>e2</em>, </td>
  120. </tr>
  121. <tr>
  122. <td class="md" nowrap align="right"></td>
  123. <td></td>
  124. <td class="md" nowrap>V &amp;&nbsp;</td>
  125. <td class="mdname" nowrap> <em>v</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="md" nowrap align="right"></td>
  129. <td></td>
  130. <td class="md" nowrap>bool&nbsp;</td>
  131. <td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
  132. </tr>
  133. <tr>
  134. <td></td>
  135. <td class="md">)&nbsp;</td>
  136. <td class="md" colspan="2"></td>
  137. </tr>
  138. </table>
  139. </td>
  140. </tr>
  141. </table>
  142. <table summary="" cellspacing=5 cellpadding=0 border=0>
  143. <tr>
  144. <td>
  145. &nbsp;
  146. </td>
  147. <td>
  148. <p>
  149. computes <code>v += A<sup>T</sup> x</code> or <code>v = A<sup>T</sup> x</code> in an optimized fashion.
  150. </p>
  151. <dl compact><dt><b>Parameters:</b></dt><dd>
  152. <table summary="" border="0" cellspacing="2" cellpadding="0">
  153. <tr><td></td><td valign=top><em>e1</em>&nbsp;</td><td>the vector expression <code>x</code> </td></tr>
  154. <tr><td></td><td valign=top><em>e2</em>&nbsp;</td><td>the matrix expression <code>A</code> </td></tr>
  155. <tr><td></td><td valign=top><em>v</em>&nbsp;</td><td>the result vector <code>v</code> </td></tr>
  156. <tr><td></td><td valign=top><em>init</em>&nbsp;</td><td>a boolean parameter</td></tr>
  157. </table>
  158. </dl>
  159. <code>axpy_prod(x, A, v, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>v.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
  160. Up to now there are some specialisation for compressed matrices that give a large speed up compared to prod. </td>
  161. </tr>
  162. </table>
  163. <a class="anchor" name="ga7" doxytag="boost::numeric::ublas::axpy_prod" ></a>
  164. <table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
  165. <tr>
  166. <td class="mdRow">
  167. <table summary="" cellpadding="0" cellspacing="0" border="0">
  168. <tr>
  169. <td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE M&amp; axpy_prod </td>
  170. <td class="md" valign="top">(&nbsp;</td>
  171. <td class="md" nowrap valign="top">const matrix_expression&lt; E1 &gt; &amp;&nbsp;</td>
  172. <td class="mdname" nowrap> <em>e1</em>, </td>
  173. </tr>
  174. <tr>
  175. <td class="md" nowrap align="right"></td>
  176. <td></td>
  177. <td class="md" nowrap>const matrix_expression&lt; E2 &gt; &amp;&nbsp;</td>
  178. <td class="mdname" nowrap> <em>e2</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="md" nowrap align="right"></td>
  182. <td></td>
  183. <td class="md" nowrap>M &amp;&nbsp;</td>
  184. <td class="mdname" nowrap> <em>m</em>, </td>
  185. </tr>
  186. <tr>
  187. <td class="md" nowrap align="right"></td>
  188. <td></td>
  189. <td class="md" nowrap>bool&nbsp;</td>
  190. <td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td class="md">)&nbsp;</td>
  195. <td class="md" colspan="2"></td>
  196. </tr>
  197. </table>
  198. </td>
  199. </tr>
  200. </table>
  201. <table summary="" cellspacing=5 cellpadding=0 border=0>
  202. <tr>
  203. <td>
  204. &nbsp;
  205. </td>
  206. <td>
  207. <p>
  208. computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion.
  209. </p>
  210. <dl compact><dt><b>Parameters:</b></dt><dd>
  211. <table summary="" border="0" cellspacing="2" cellpadding="0">
  212. <tr><td></td><td valign=top><em>e1</em>&nbsp;</td><td>the matrix expression <code>A</code> </td></tr>
  213. <tr><td></td><td valign=top><em>e2</em>&nbsp;</td><td>the matrix expression <code>X</code> </td></tr>
  214. <tr><td></td><td valign=top><em>m</em>&nbsp;</td><td>the result matrix <code>M</code> </td></tr>
  215. <tr><td></td><td valign=top><em>init</em>&nbsp;</td><td>a boolean parameter</td></tr>
  216. </table>
  217. </dl>
  218. <code>axpy_prod(A, X, M, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>M.clear()</code> before <code>axpy_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
  219. Up to now there are no specialisations. </td>
  220. </tr>
  221. </table>
  222. <a class="anchor" name="ga6" doxytag="boost::numeric::ublas::opb_prod" ></a>
  223. <table summary="" class="mdTable" width="95%" cellpadding="2" cellspacing="0">
  224. <tr>
  225. <td class="mdRow">
  226. <table summary="" cellpadding="0" cellspacing="0" border="0">
  227. <tr>
  228. <td class="md" nowrap valign="top"> BOOST_UBLAS_INLINE M&amp; opb_prod </td>
  229. <td class="md" valign="top">(&nbsp;</td>
  230. <td class="md" nowrap valign="top">const matrix_expression&lt; E1 &gt; &amp;&nbsp;</td>
  231. <td class="mdname" nowrap> <em>e1</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="md" nowrap align="right"></td>
  235. <td></td>
  236. <td class="md" nowrap>const matrix_expression&lt; E2 &gt; &amp;&nbsp;</td>
  237. <td class="mdname" nowrap> <em>e2</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="md" nowrap align="right"></td>
  241. <td></td>
  242. <td class="md" nowrap>M &amp;&nbsp;</td>
  243. <td class="mdname" nowrap> <em>m</em>, </td>
  244. </tr>
  245. <tr>
  246. <td class="md" nowrap align="right"></td>
  247. <td></td>
  248. <td class="md" nowrap>bool&nbsp;</td>
  249. <td class="mdname" nowrap> <em>init</em> = <code>true</code></td>
  250. </tr>
  251. <tr>
  252. <td></td>
  253. <td class="md">)&nbsp;</td>
  254. <td class="md" colspan="2"></td>
  255. </tr>
  256. </table>
  257. </td>
  258. </tr>
  259. </table>
  260. <table summary="" cellspacing=5 cellpadding=0 border=0>
  261. <tr>
  262. <td>
  263. &nbsp;
  264. </td>
  265. <td>
  266. <p>
  267. computes <code>M += A X</code> or <code>M = A X</code> in an optimized fashion.
  268. </p>
  269. <dl compact><dt><b>Parameters:</b></dt><dd>
  270. <table summary="" border="0" cellspacing="2" cellpadding="0">
  271. <tr><td></td><td valign=top><em>e1</em>&nbsp;</td><td>the matrix expression <code>A</code> </td></tr>
  272. <tr><td></td><td valign=top><em>e2</em>&nbsp;</td><td>the matrix expression <code>X</code> </td></tr>
  273. <tr><td></td><td valign=top><em>m</em>&nbsp;</td><td>the result matrix <code>M</code> </td></tr>
  274. <tr><td></td><td valign=top><em>init</em>&nbsp;</td><td>a boolean parameter</td></tr>
  275. </table>
  276. </dl>
  277. <code>opb_prod(A, X, M, init)</code> implements the well known axpy-product. Setting <em>init</em> to <code>true</code> is equivalent to call <code>M.clear()</code> before <code>opb_prod</code>. Currently <em>init</em> defaults to <code>true</code>, but this may change in the future.<p>
  278. This function may give a speedup if <code>A</code> has less columns than rows, because the product is computed as a sum of outer products. </td>
  279. </tr>
  280. </table>
  281. <hr />
  282. <p>Copyright (&copy;) 2000-2004 Michael Stevens, Mathias Koch,
  283. Joerg Walter, Gunter Winkler<br />
  284. Use, modification and distribution are subject to the
  285. Boost Software License, Version 1.0.
  286. (See accompanying file LICENSE_1_0.txt
  287. or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
  288. http://www.boost.org/LICENSE_1_0.txt
  289. </a>).
  290. </p>
  291. <script type="text/javascript">
  292. (function($) {
  293. $('#toc').toc();
  294. })(jQuery);
  295. </script>
  296. </body>
  297. </html>