libs/numeric/ublas/doc/html/classboost_1_1numeric_1_1ublas_1_1diagonal__matrix.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_matrix&lt; T, L, A &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__matrix.html">diagonal_matrix</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>boost::numeric::ublas::diagonal_matrix&lt; T, L, A &gt; Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::diagonal_matrix" --><!-- doxytag: inherits="boost::numeric::ublas::banded_matrix" -->
  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> of values of type <code>T</code>, which is a specialization of a banded <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>.
  33 <a href="#_details">More...</a></p>
  34
  35 <p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__matrix.html">boost::numeric::ublas::banded_matrix&lt; T, L, A &gt;</a>.</p>
  36
  37 <p><a href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix-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="aea44e5be2be0319e8115fa90e4eafba6"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::size_type" ref="aea44e5be2be0319e8115fa90e4eafba6" args="" -->
  41 typedef A::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
  42 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf9ca4a93ecfb01faa5e905b02b0a23b"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::matrix_type" ref="aaf9ca4a93ecfb01faa5e905b02b0a23b" args="" -->
  43 typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__matrix.html">banded_matrix</a>&lt; T, L, A &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>matrix_type</b></td></tr>
  44 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97e4502fab3b22100288d4a742479c96"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::array_type" ref="a97e4502fab3b22100288d4a742479c96" args="" -->
  45 typedef A&nbsp;</td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
  46 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  47 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80fe5323f7625ebb8821abb7f72d0c26"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::diagonal_matrix" ref="a80fe5323f7625ebb8821abb7f72d0c26" args="(size_type size)" -->
  48 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size)</td></tr>
  49 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae46a8935e189c46fe5c5e4427b4a6173"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::diagonal_matrix" ref="ae46a8935e189c46fe5c5e4427b4a6173" args="(size_type size, const array_type &amp;data)" -->
  50 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size, const array_type &amp;data)</td></tr>
  51 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f76e6a64bbfa19e49bb4311430e8432"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::diagonal_matrix" ref="a1f76e6a64bbfa19e49bb4311430e8432" args="(size_type size1, size_type size2)" -->
  52 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size1, size_type size2)</td></tr>
  53 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a82f54d7364bec12bf8b7c46de696c049"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::diagonal_matrix" ref="a82f54d7364bec12bf8b7c46de696c049" args="(const matrix_expression&lt; AE &gt; &amp;ae)" -->
  54 template&lt;class AE &gt; </td></tr>
  55 <tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>diagonal_matrix</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>
  56 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d4d77b6b4042aaebdc98492a6724656"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::operator=" ref="a3d4d77b6b4042aaebdc98492a6724656" args="(const diagonal_matrix &amp;m)" -->
  57 BOOST_UBLAS_INLINE <br class="typebreak"/>
  58 <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix.html">diagonal_matrix</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix.html">diagonal_matrix</a> &amp;m)</td></tr>
  59 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a72b7aa54ef995d3f465b91e75dbefa9f"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::operator=" ref="a72b7aa54ef995d3f465b91e75dbefa9f" args="(const matrix_expression&lt; AE &gt; &amp;ae)" -->
  60 template&lt;class AE &gt; </td></tr>
  61 <tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <br class="typebreak"/>
  62 <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix.html">diagonal_matrix</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>
  63 </table>
  64 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  65 <h3>template&lt;class T, class L, class A&gt;<br/>
  66  class boost::numeric::ublas::diagonal_matrix&lt; T, L, A &gt;</h3>
  67
  68 <p>For a <img class="formulaInl" alt="$(m\times m)$" src="form_8.png"/>-dimensional diagonal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>, <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"/>. The default storage for diagonal matrices is packed. Orientation and storage can also be specified. Default is <code>row</code> major <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1unbounded__array.html">unbounded_array</a></code>.</p>
  69 <p>As a specialization of a banded <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>, the constructor of 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> creates a banded <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> with 0 upper and lower diagonals around the main diagonal and the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> is obviously a square <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>. Operations are optimized based on these 2 assumptions. It is <b>not</b> required by the storage to initialize elements of the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>.</p>
  70 <dl><dt><b>Template Parameters:</b></dt><dd>
  71   <table border="0" cellspacing="2" cellpadding="0">
  72     <tr><td valign="top"></td><td valign="top"><em>T</em>&nbsp;</td><td>the type of object stored in the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> (like double, float, complex, etc...) </td></tr>
  73     <tr><td valign="top"></td><td valign="top"><em>L</em>&nbsp;</td><td>the storage organization. It can be either <code>row_major</code> or <code>column_major</code>. Default is <code>row_major</code> </td></tr>
  74     <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>the type of Storage array. Default is <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1unbounded__array.html">unbounded_array</a></code> </td></tr>
  75   </table>
  76   </dd>
  77 </dl>
  78 </div>
  79 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Jul 4 20:31:06 2010 for ublas by&nbsp;
  80 <a href="http://www.doxygen.org/index.html">
  81 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  82 </body>
  83 </html>