blob: 0168720876de07e57ce08958ab6db06778610809 [file] [log] [blame]
<!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::bounded_matrix&lt; T, M, N, L &gt; 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&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;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_1bounded__matrix.html">bounded_matrix</a>
</div>
</div>
<div class="contents">
<h1>boost::numeric::ublas::bounded_matrix&lt; T, M, N, L &gt; Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::bounded_matrix" --><!-- doxytag: inherits="matrix&lt; T, L, bounded_array&lt; T, M *N &gt; &gt;" -->
<p>A dense <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> with a variable size bounded to a maximum of <img class="formulaInl" alt="$M$" src="form_55.png"/> by <img class="formulaInl" alt="$N$" src="form_56.png"/>.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html">matrix&lt; T, L, bounded_array&lt; T, M *N &gt; &gt;</a>.</p>
<p><a href="classboost_1_1numeric_1_1ublas_1_1bounded__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="a173f0049baf2d085c6d1c9c4a6e191f4"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::size_type" ref="a173f0049baf2d085c6d1c9c4a6e191f4" args="" -->
typedef matrix_type::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_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="a7ff35d98ec9c5de8e9b7d518ce4d5a72"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::bounded_matrix" ref="a7ff35d98ec9c5de8e9b7d518ce4d5a72" args="(size_type size1, size_type size2)" -->
BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>bounded_matrix</b> (size_type size1, size_type size2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa10cdfe6e6568ec908095fc5e0a5aff"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::bounded_matrix" ref="aaa10cdfe6e6568ec908095fc5e0a5aff" args="(const bounded_matrix &amp;m)" -->
BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>bounded_matrix</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_matrix</a> &amp;m)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a2260072e5d35d794e01bf881e2a32b0a"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::bounded_matrix" ref="a2260072e5d35d794e01bf881e2a32b0a" args="(const matrix&lt; T, L, A2 &gt; &amp;m)" -->
template&lt;class A2 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>bounded_matrix</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html">matrix</a>&lt; T, L, A2 &gt; &amp;m)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a214e45bf88dc1a52e7f06b5648e08112"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::bounded_matrix" ref="a214e45bf88dc1a52e7f06b5648e08112" args="(const matrix_expression&lt; AE &gt; &amp;ae)" -->
template&lt;class AE &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>bounded_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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3ae6f89fa0d0e8588a2261f3e142c78"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::operator=" ref="aa3ae6f89fa0d0e8588a2261f3e142c78" args="(const bounded_matrix &amp;m)" -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_matrix</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_matrix</a> &amp;m)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ae3f0c9126a6539346eb62ca29ad92cf6"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::operator=" ref="ae3f0c9126a6539346eb62ca29ad92cf6" args="(const matrix&lt; T, L2, A2 &gt; &amp;m)" -->
template&lt;class L2 , class A2 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_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.html">matrix</a>&lt; T, L2, A2 &gt; &amp;m)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a95640bb8ac8df52880b2cdcedc3b1837"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::operator=" ref="a95640bb8ac8df52880b2cdcedc3b1837" args="(const matrix_container&lt; C &gt; &amp;m)" -->
template&lt;class C &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_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__container.html">matrix_container</a>&lt; C &gt; &amp;m)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a6c062d146e5a5ba9814cfca9f74fc342"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::operator=" ref="a6c062d146e5a5ba9814cfca9f74fc342" args="(const matrix_expression&lt; AE &gt; &amp;ae)" -->
template&lt;class AE &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__matrix.html">bounded_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>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52bb84c91071a5b9ec8998fab457bbc4"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::max_size1" ref="a52bb84c91071a5b9ec8998fab457bbc4" args="" -->
static const size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_size1</b> = M</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82a68a7ad7ad04772fb5bcae648a70c2"></a><!-- doxytag: member="boost::numeric::ublas::bounded_matrix::max_size2" ref="a82a68a7ad7ad04772fb5bcae648a70c2" args="" -->
static const size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_size2</b> = N</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T, std::size_t M, std::size_t N, class L&gt;<br/>
class boost::numeric::ublas::bounded_matrix&lt; T, M, N, L &gt;</h3>
<p>For a <img class="formulaInl" alt="$(m \times n)$" src="form_51.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> and <img class="formulaInl" alt="$ 0 \leq i < m, 0 \leq j < n$" src="form_52.png"/>, every element <img class="formulaInl" alt="$m_{i,j}$" src="form_44.png"/> is mapped to the <img class="formulaInl" alt="$(i.n + j)$" src="form_45.png"/>-th element of the container for row major orientation or the <img class="formulaInl" alt="$(i + j.m)$" src="form_46.png"/>-th element of the container for column major orientation. Finally in a dense <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> all elements are represented in memory in a contiguous chunk of memory.</p>
<p>Orientation can be specified. Default is <code>row_major</code> The default constructor creates the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> with size <img class="formulaInl" alt="$M$" src="form_55.png"/> by <img class="formulaInl" alt="$N$" src="form_56.png"/>. Elements are constructed by the storage type <code><a class="el" href="classboost_1_1numeric_1_1ublas_1_1bounded__array.html">bounded_array</a></code>, which need not initialise their value.</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>&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>
<tr><td valign="top"></td><td valign="top"><em>M</em>&nbsp;</td><td>maximum and default number of rows (if not specified at construction) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>maximum and default number of columns (if not specified at construction) </td></tr>
<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>
</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>