2
0
mirror of https://github.com/boostorg/ublas.git synced 2026-02-21 15:32:12 +00:00
Files
ublas/doc/doxyfiles/html/a00069.html
David Bellot 11b1711474 new doxyfiles
[SVN r75573]
2011-11-20 14:50:03 +00:00

361 lines
19 KiB
HTML

<!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>Boost.uBlas: boost::numeric::ublas::container_const_reference&lt; C &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo boost ublas.png"></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Boost.uBlas&#160;<span id="projectnumber">1.49</span></div>
<div id="projectbrief">Linear Algebra in C++: matrices, vectors and numeric algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00069.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>boost::numeric::ublas::container_const_reference&lt; C &gt; Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="boost::numeric::ublas::container_const_reference" --><!-- doxytag: inherits="boost::numeric::ublas::nonassignable_::nonassignable" -->
<p>Base class of all proxy classes that contain a (redirectable) reference to an immutable object.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="a00616_source.html">iterator.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="a00359.html">boost::numeric::ublas::nonassignable_::nonassignable</a>.</p>
<p>Inherited by <a class="el" href="a00165.html">boost::numeric::ublas::indexed_const_iterator&lt; C, IC &gt;</a>, <a class="el" href="a00166.html">boost::numeric::ublas::indexed_const_iterator1&lt; C, IC &gt;</a>, and <a class="el" href="a00167.html">boost::numeric::ublas::indexed_const_iterator2&lt; C, IC &gt;</a>.</p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for boost::numeric::ublas::container_const_reference&lt; C &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="a00869.png" border="0" usemap="#boost_1_1numeric_1_1ublas_1_1container__const__reference_3_01_c_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="boost_1_1numeric_1_1ublas_1_1container__const__reference_3_01_c_01_4_coll__map" id="boost_1_1numeric_1_1ublas_1_1container__const__reference_3_01_c_01_4_coll__map">
<area shape="rect" id="node2" href="a00359.html" title="{nonassignable\n||# nonassignable()\l# ~nonassignable()\l&#45; operator=()\l}" alt="" coords="111,5,241,125"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00870.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef C&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a254a9a2d2c9ed6e21a413597b64780fd">container_const_reference</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#aced16c6f7805a6923aa5f4a003c97561">container_const_reference</a> (const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> &amp;c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <br class="typebreak"/>
<a class="el" href="a00069.html">container_const_reference</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#ab14250fc4fe5b9bcab4eb9fba8a5b5f8">assign</a> (const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> *c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE const <br class="typebreak"/>
<a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a1ba02c5e916027c57e6679ff81e2f592">operator()</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#a939d3a4b01822247f4a6963d9deb0ca2">same_closure</a> (const <a class="el" href="a00069.html">container_const_reference</a> &amp;cr) const </td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00069.html#aee16c7c69d962ce9a8bbac442715f906">c_</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class C&gt;<br/>
class boost::numeric::ublas::container_const_reference&lt; C &gt;</h3>
<p>Base class of all proxy classes that contain a (redirectable) reference to an immutable object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">C</td><td>the type of the container referred to </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00616_source.html#l00028">28</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a399148ca75e693559e4392e246f8285a"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::container_type" ref="a399148ca75e693559e4392e246f8285a" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef C <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::<a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="a00165.html#abecb4b9f2b8145b04084c27fcc1d0b06">boost::numeric::ublas::indexed_const_iterator&lt; C, IC &gt;</a>, <a class="el" href="a00166.html#a29567d93a61e855f307111184d734208">boost::numeric::ublas::indexed_const_iterator1&lt; C, IC &gt;</a>, and <a class="el" href="a00167.html#aeecc82cdb621fce08c25ea42b5f37444">boost::numeric::ublas::indexed_const_iterator2&lt; C, IC &gt;</a>.</p>
<p>Definition at line <a class="el" href="a00616_source.html#l00031">31</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a254a9a2d2c9ed6e21a413597b64780fd"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::container_const_reference" ref="a254a9a2d2c9ed6e21a413597b64780fd" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::<a class="el" href="a00069.html">container_const_reference</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00034">34</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aced16c6f7805a6923aa5f4a003c97561"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::container_const_reference" ref="aced16c6f7805a6923aa5f4a003c97561" args="(const container_type &amp;c)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::<a class="el" href="a00069.html">container_const_reference</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> &amp;&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00037">37</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1ba02c5e916027c57e6679ff81e2f592"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::operator()" ref="a1ba02c5e916027c57e6679ff81e2f592" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a>&amp; <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::operator() </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00041">41</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab14250fc4fe5b9bcab4eb9fba8a5b5f8"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::assign" ref="ab14250fc4fe5b9bcab4eb9fba8a5b5f8" args="(const container_type *c)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE <a class="el" href="a00069.html">container_const_reference</a>&amp; <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::assign </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a> *&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00046">46</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a939d3a4b01822247f4a6963d9deb0ca2"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::same_closure" ref="a939d3a4b01822247f4a6963d9deb0ca2" args="(const container_const_reference &amp;cr) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE bool <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::same_closure </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00069.html">container_const_reference</a>&lt; C &gt; &amp;&#160;</td>
<td class="paramname"><em>cr</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00053">53</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aee16c7c69d962ce9a8bbac442715f906"></a><!-- doxytag: member="boost::numeric::ublas::container_const_reference::c_" ref="aee16c7c69d962ce9a8bbac442715f906" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class C&gt; </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00069.html#a399148ca75e693559e4392e246f8285a">container_type</a>* <a class="el" href="a00069.html">boost::numeric::ublas::container_const_reference</a>&lt; C &gt;::<a class="el" href="a00069.html#aee16c7c69d962ce9a8bbac442715f906">c_</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00616_source.html#l00058">58</a> of file <a class="el" href="a00616_source.html">iterator.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00616_source.html">iterator.hpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00648.html">boost</a> </li>
<li class="navelem"><a class="el" href="a00649.html">numeric</a> </li>
<li class="navelem"><a class="el" href="a00595.html">ublas</a> </li>
<li class="navelem"><a class="el" href="a00069.html">container_const_reference</a> </li>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<small>
<small>
<small>
<table width="100%">
<tr>
<td align="right">
Copyright &#169; 2010-2011 David Bellot - Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">Boost Software License, Version 1.0.</a>
</td>
</tr>
</table>
</small>
</small>
</small>