| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>ublas: boost::numeric::ublas::diagonal_adaptor< M > Class Template Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.6.1 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <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> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>boost::numeric::ublas::diagonal_adaptor< M > Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::diagonal_adaptor" --><!-- doxytag: inherits="boost::numeric::ublas::banded_adaptor" --> |
| <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. |
| <a href="#_details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__adaptor.html">boost::numeric::ublas::banded_adaptor< M ></a>.</p> |
| |
| <p><a href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor-members.html">List of all members.</a></p> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><td colspan="2"><h2>Public Types</h2></td></tr> |
| <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="" --> |
| typedef M </td><td class="memItemRight" valign="bottom"><b>matrix_type</b></td></tr> |
| <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="" --> |
| typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__adaptor.html">banded_adaptor</a>< M > </td><td class="memItemRight" valign="bottom"><b>adaptor_type</b></td></tr> |
| <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
| <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 &data)" --> |
| BOOST_UBLAS_INLINE </td><td class="memItemRight" valign="bottom"><b>diagonal_adaptor</b> (matrix_type &data)</td></tr> |
| <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 &m)" --> |
| BOOST_UBLAS_INLINE <br class="typebreak"/> |
| <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a> & </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> &m)</td></tr> |
| <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< AE > &ae)" --> |
| template<class AE > </td></tr> |
| <tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <br class="typebreak"/> |
| <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__adaptor.html">diagonal_adaptor</a> & </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>< AE > &ae)</td></tr> |
| </table> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| <h3>template<class M><br/> |
| class boost::numeric::ublas::diagonal_adaptor< M ></h3> |
| |
| <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> |
| <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> |
| <dl><dt><b>Template Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>M</em> </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> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Jul 4 20:31:06 2010 for ublas by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| </body> |
| </html> |
