| <!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_matrix< T, L, A > 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__matrix.html">diagonal_matrix</a> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>boost::numeric::ublas::diagonal_matrix< T, L, A > Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::diagonal_matrix" --><!-- doxytag: inherits="boost::numeric::ublas::banded_matrix" --> |
| <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>. |
| <a href="#_details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__matrix.html">boost::numeric::ublas::banded_matrix< T, L, A ></a>.</p> |
| |
| <p><a href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix-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="aea44e5be2be0319e8115fa90e4eafba6"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::size_type" ref="aea44e5be2be0319e8115fa90e4eafba6" args="" --> |
| typedef A::size_type </td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr> |
| <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="" --> |
| typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1banded__matrix.html">banded_matrix</a>< T, L, A > </td><td class="memItemRight" valign="bottom"><b>matrix_type</b></td></tr> |
| <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="" --> |
| typedef A </td><td class="memItemRight" valign="bottom"><b>array_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="a80fe5323f7625ebb8821abb7f72d0c26"></a><!-- doxytag: member="boost::numeric::ublas::diagonal_matrix::diagonal_matrix" ref="a80fe5323f7625ebb8821abb7f72d0c26" args="(size_type size)" --> |
| BOOST_UBLAS_INLINE </td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size)</td></tr> |
| <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 &data)" --> |
| BOOST_UBLAS_INLINE </td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size, const array_type &data)</td></tr> |
| <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)" --> |
| BOOST_UBLAS_INLINE </td><td class="memItemRight" valign="bottom"><b>diagonal_matrix</b> (size_type size1, size_type size2)</td></tr> |
| <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< AE > &ae)" --> |
| template<class AE > </td></tr> |
| <tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE </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>< AE > &ae)</td></tr> |
| <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 &m)" --> |
| BOOST_UBLAS_INLINE <br class="typebreak"/> |
| <a class="el" href="classboost_1_1numeric_1_1ublas_1_1diagonal__matrix.html">diagonal_matrix</a> & </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> &m)</td></tr> |
| <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< 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__matrix.html">diagonal_matrix</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 T, class L, class A><br/> |
| class boost::numeric::ublas::diagonal_matrix< T, L, A ></h3> |
| |
| <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> |
| <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> |
| <dl><dt><b>Template Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>T</em> </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> |
| <tr><td valign="top"></td><td valign="top"><em>L</em> </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> |
| <tr><td valign="top"></td><td valign="top"><em>A</em> </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> |
| </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> |
