libs/numeric/ublas/doc/html/classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>ublas: boost::numeric::ublas::diagonal_adaptor&lt; M &gt; Class Template Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head>
   9 <body>
  10 <!-- Generated by Doxygen 1.6.1 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul>
  14       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  17       <li><a href="files.html"><span>Files</span></a></li>
  18     </ul>
  19   </div>
  20   <div class="tabs">
  21     <ul>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><b>boost</b>::<b>numeric</b>::<b>ublas</b>::<a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>boost::numeric::ublas::diagonal_adaptor&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::diagonal_adaptor" --><!-- doxytag: inherits="boost::numeric::ublas::banded_adaptor" -->
  32 <p>A diagonal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> adaptator: convert a any <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> into a diagonal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> expression.
  33 <a href="#_details">More...</a></p>
  34
  35 <p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__adaptor.html">boost::numeric::ublas::banded_adaptor&lt; M &gt;</a>.</p>
  36
  37 <p><a href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor-members.html">List of all members.</a></p>
  38 <table border="0" cellpadding="0" cellspacing="0">
  39 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
  40 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23836f0613d080624a65fb8d373c2029"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_adaptor::matrix_type" ref="a23836f0613d080624a65fb8d373c2029" args="" -->
  41 typedef M&nbsp;</td><td class="memItemRight" valign="bottom"><b>matrix_type</b></td></tr>
  42 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a507eee814b5ffaabf515af05408cf3e3"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_adaptor::adaptor_type" ref="a507eee814b5ffaabf515af05408cf3e3" args="" -->
  43 typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__adaptor.html">banded_adaptor</a>&lt; M &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>adaptor_type</b></td></tr>
  44 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  45 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65b03c410d81085e07fcfc574aa89f78"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_adaptor::diagonal_adaptor" ref="a65b03c410d81085e07fcfc574aa89f78" args="(matrix_type &amp;data)" -->
  46 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>diagonal_adaptor</b> (matrix_type &amp;data)</td></tr>
  47 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cf0cdade27d1aa63d4686ebdf7b2eed"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_adaptor::operator=" ref="a9cf0cdade27d1aa63d4686ebdf7b2eed" args="(const diagonal_adaptor &amp;m)" -->
  48 BOOST_UBLAS_INLINE <br class="typebreak"/>
  49 <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a> &amp;m)</td></tr>
  50 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a6c487774252bb6848187218c76dee61d"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_adaptor::operator=" ref="a6c487774252bb6848187218c76dee61d" args="(const matrix_expression&lt; AE &gt; &amp;ae)" -->
  51 template&lt;class AE &gt; </td></tr>
  52 <tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <br class="typebreak"/>
  53 <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix__expression.html">matrix_expression</a>&lt; AE &gt; &amp;ae)</td></tr>
  54 </table>
  55 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  56 <h3>template&lt;class M&gt;<br/>
  57  class boost::numeric::ublas::diagonal_adaptor&lt; M &gt;</h3>
  58
  59 <p>For a <img class="formulaInl" alt="$(m\times m)$" src="form_8.png"/>-dimensional <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>, the <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html" title="A diagonal matrix adaptator: convert a any matrix into a diagonal matrix expression...">diagonal_adaptor</a></code> will provide a diagonal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> with <img class="formulaInl" alt="$0 \leq i < m$" src="form_3.png"/> and <img class="formulaInl" alt="$0 \leq j < m$" src="form_9.png"/>, if <img class="formulaInl" alt="$i\neq j$" src="form_10.png"/> then <img class="formulaInl" alt="$b_{i,j}=0$" src="form_7.png"/>.</p>
  60 <p>Storage and location are based on those of the underlying <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>. This is important because a <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html" title="A diagonal matrix adaptator: convert a any matrix into a diagonal matrix expression...">diagonal_adaptor</a></code> does not copy the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> data to a new place. Therefore, modifying values in a <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html" title="A diagonal matrix adaptator: convert a any matrix into a diagonal matrix expression...">diagonal_adaptor</a></code> <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> will also modify the underlying <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> too.</p>
  61 <dl><dt><b>Template Parameters:</b></dt><dd>
  62   <table border="0" cellspacing="2" cellpadding="0">
  63     <tr><td valign="top"></td><td valign="top"><em>M</em>&nbsp;</td><td>the type of <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> used to generate the diagonal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> </td></tr>
  64   </table>
  65   </dd>
  66 </dl>
  67 </div>
  68 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Jul 4 20:31:06 2010 for ublas by&nbsp;
  69 <a href="http://www.doxygen.org/index.html">
  70 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  71 </body>
  72 </html>