blob: cae2cf6c962d4a07b95cd554b2a3321af2e75713 [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::scalar_matrix&lt; T, ALLOC &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_1scalar__matrix.html">scalar_matrix</a>
</div>
</div>
<div class="contents">
<h1>boost::numeric::ublas::scalar_matrix&lt; T, ALLOC &gt; Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::scalar_matrix" --><!-- doxytag: inherits="matrix_container&lt; scalar_matrix&lt; T, ALLOC &gt; &gt;" -->
<p>A <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> with all values of type <code>T</code> equal to the same value.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix__container.html">matrix_container&lt; scalar_matrix&lt; T, ALLOC &gt; &gt;</a>.</p>
<p><a href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a></td></tr>
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e7b281b9417ab31d84dfd935c919ed7"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::size_type" ref="a4e7b281b9417ab31d84dfd935c919ed7" args="" -->
typedef std::size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a820fbd2d398ea65ceff75fe89ce1c94b"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::difference_type" ref="a820fbd2d398ea65ceff75fe89ce1c94b" args="" -->
typedef std::ptrdiff_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a538819d6060f441f1bfc8b6ffc79da91"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::value_type" ref="a538819d6060f441f1bfc8b6ffc79da91" args="" -->
typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d335decb6ee9ab558b2e912b0cee029"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::const_reference" ref="a2d335decb6ee9ab558b2e912b0cee029" args="" -->
typedef const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a312711a7430e7606e94fb015ee2fe7c6"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::reference" ref="a312711a7430e7606e94fb015ee2fe7c6" args="" -->
typedef T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad073012b254c96a64054f03619cb4903"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::const_closure_type" ref="ad073012b254c96a64054f03619cb4903" args="" -->
typedef const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix__reference.html">matrix_reference</a><br class="typebreak"/>
&lt; const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">self_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_closure_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31170856152dbf364a8d3dbc3182f37f"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::closure_type" ref="a31170856152dbf364a8d3dbc3182f37f" args="" -->
typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix__reference.html">matrix_reference</a><br class="typebreak"/>
&lt; <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">self_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>closure_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affc0edd689e5e2ed87bd5020c0b365d8"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::storage_category" ref="affc0edd689e5e2ed87bd5020c0b365d8" args="" -->
typedef <a class="el" href="structboost_1_1numeric_1_1ublas_1_1dense__tag.html">dense_tag</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>storage_category</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7566e7f5e0f81c5ab7d39ab435010a83"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::orientation_category" ref="a7566e7f5e0f81c5ab7d39ab435010a83" args="" -->
typedef <a class="el" href="structboost_1_1numeric_1_1ublas_1_1unknown__orientation__tag.html">unknown_orientation_tag</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>orientation_category</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac86981c8352ecf3f5df9585a8b5e8156"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::const_reverse_iterator1" ref="ac86981c8352ecf3f5df9585a8b5e8156" args="" -->
typedef reverse_iterator_base1<br class="typebreak"/>
&lt; <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reverse_iterator1</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a770dd3554379e9a7c89b403e16eb3b4c"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::const_reverse_iterator2" ref="a770dd3554379e9a7c89b403e16eb3b4c" args="" -->
typedef reverse_iterator_base2<br class="typebreak"/>
&lt; <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reverse_iterator2</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe5a62ade4f6921f1709250ebd509939"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::iterator1" ref="afe5a62ade4f6921f1709250ebd509939" args="" -->
typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>iterator1</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab95671228c87ccede2a07c807e03ada1"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::iterator2" ref="ab95671228c87ccede2a07c807e03ada1" args="" -->
typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>iterator2</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="a9fe498982e19d52e2f7d3280bf507f2c"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::scalar_matrix" ref="a9fe498982e19d52e2f7d3280bf507f2c" args="(size_type size1, size_type size2, const value_type &amp;value=value_type(1))" -->
BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>scalar_matrix</b> (size_type size1, size_type size2, const value_type &amp;value=value_type(1))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d3b5759a143de1dd0bde4310ace6550"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::scalar_matrix" ref="a9d3b5759a143de1dd0bde4310ace6550" args="(const scalar_matrix &amp;m)" -->
BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>scalar_matrix</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18e943c4d100ac1f23889f30e07105ec"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::size1" ref="a18e943c4d100ac1f23889f30e07105ec" args="() const " -->
BOOST_UBLAS_INLINE size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size1</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54b6a280f1360936cbf6410a475899d9"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::size2" ref="a54b6a280f1360936cbf6410a475899d9" args="() const " -->
BOOST_UBLAS_INLINE size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size2</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a103bda575bd9e56a729a2232a71f061e"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::resize" ref="a103bda575bd9e56a729a2232a71f061e" args="(size_type size1, size_type size2, bool=true)" -->
BOOST_UBLAS_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resize</b> (size_type size1, size_type size2, bool=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a513e7fd8909d4be03a5ee8867f686929"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::operator()" ref="a513e7fd8909d4be03a5ee8867f686929" args="(size_type, size_type) const " -->
BOOST_UBLAS_INLINE const_reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (size_type, size_type) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604c27157fdc0de289222bc3613e6bc2"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::operator=" ref="a604c27157fdc0de289222bc3613e6bc2" args="(const scalar_matrix &amp;m)" -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56a4cb2f3c4915824395993b06f991ff"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::assign_temporary" ref="a56a4cb2f3c4915824395993b06f991ff" args="(scalar_matrix &amp;m)" -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>assign_temporary</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a597e01f79e11214d2486866e3c94bdeb"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::swap" ref="a597e01f79e11214d2486866e3c94bdeb" args="(scalar_matrix &amp;m)" -->
BOOST_UBLAS_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6478d860f304b8825931e51f3d4204b9"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::find1" ref="a6478d860f304b8825931e51f3d4204b9" args="(int, size_type i, size_type j) const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>find1</b> (int, size_type i, size_type j) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a420612645a81dd77f3db88129645f3a3"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::find2" ref="a420612645a81dd77f3db88129645f3a3" args="(int, size_type i, size_type j) const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>find2</b> (int, size_type i, size_type j) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b80383ac7f13fc9585c66a63721592a"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::begin1" ref="a1b80383ac7f13fc9585c66a63721592a" args="() const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>begin1</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57ddd11a4ff28db16a40665b07dfce05"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::end1" ref="a57ddd11a4ff28db16a40665b07dfce05" args="() const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator1.html">const_iterator1</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>end1</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c35ed97254a6ad565ebb06f38d72496"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::begin2" ref="a8c35ed97254a6ad565ebb06f38d72496" args="() const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>begin2</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf66ecfab809ac9039e9a99cd20062e9"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::end2" ref="adf66ecfab809ac9039e9a99cd20062e9" args="() const " -->
BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix_1_1const__iterator2.html">const_iterator2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>end2</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af608fa55792b4592c83ebb0ace099436"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::rbegin1" ref="af608fa55792b4592c83ebb0ace099436" args="() const " -->
BOOST_UBLAS_INLINE <br class="typebreak"/>
const_reverse_iterator1&nbsp;</td><td class="memItemRight" valign="bottom"><b>rbegin1</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d3b4d95865e00fb6138d98419c82eb3"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::rend1" ref="a8d3b4d95865e00fb6138d98419c82eb3" args="() const " -->
BOOST_UBLAS_INLINE <br class="typebreak"/>
const_reverse_iterator1&nbsp;</td><td class="memItemRight" valign="bottom"><b>rend1</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fb515a7d1f61510764503deae2bf28b"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::rbegin2" ref="a5fb515a7d1f61510764503deae2bf28b" args="() const " -->
BOOST_UBLAS_INLINE <br class="typebreak"/>
const_reverse_iterator2&nbsp;</td><td class="memItemRight" valign="bottom"><b>rbegin2</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a227dfacb80e5c332fc0a1687fbdd5368"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::rend2" ref="a227dfacb80e5c332fc0a1687fbdd5368" args="() const " -->
BOOST_UBLAS_INLINE <br class="typebreak"/>
const_reverse_iterator2&nbsp;</td><td class="memItemRight" valign="bottom"><b>rend2</b> () const </td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a20f7ee5e6de93654f9cf6c40f579c804"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::serialize" ref="a20f7ee5e6de93654f9cf6c40f579c804" args="(Archive &amp;ar, const unsigned int)" -->
template&lt;class Archive &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>serialize</b> (Archive &amp;ar, const unsigned int)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1318a9d849bcee0d9168869f87394080"></a><!-- doxytag: member="boost::numeric::ublas::scalar_matrix::swap" ref="a1318a9d849bcee0d9168869f87394080" args="(scalar_matrix &amp;m1, scalar_matrix &amp;m2)" -->
BOOST_UBLAS_INLINE friend void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m1, <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__matrix.html">scalar_matrix</a> &amp;m2)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T, class ALLOC&gt;<br/>
class boost::numeric::ublas::scalar_matrix&lt; T, ALLOC &gt;</h3>
<p>Changing one value has the effect of changing all the values. Assigning it to a normal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a> will copy the same value everywhere in this <a class="el" href="classboost_1_1numeric_1_1ublas_1_1matrix.html" title="A dense matrix of values of type T.">matrix</a>. All accesses are constant time, due to the trivial 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>ALLOC</em>&nbsp;</td><td>an allocator for storing the unique value. By default, a standar allocator is used. </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>