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

374 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::traverse_policy::by_column_policy&lt; Wrap &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('a00448.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>boost::numeric::ublas::traverse_policy::by_column_policy&lt; Wrap &gt; Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="boost::numeric::ublas::traverse_policy::by_column_policy" --><!-- doxytag: inherits="traverse_policy_wrapper&lt; by_column_policy&lt; Wrap &gt; &gt;" -->
<p>The column_by_column traverse policy.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="a00594_source.html">assignment.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for boost::numeric::ublas::traverse_policy::by_column_policy&lt; Wrap &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="a01992.png" border="0" usemap="#boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_inherit__map" id="boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_inherit__map">
<area shape="rect" id="node2" href="a00452.html" title="{boost::numeric::ublas::traverse_policy_wrapper\&lt; by_column_policy\&lt; Wrap \&gt; \&gt;\n||}" alt="" coords="5,157,483,243"/><area shape="rect" id="node4" href="a00452.html" title="A wrapper for traverse policy classes." alt="" coords="80,5,408,91"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for boost::numeric::ublas::traverse_policy::by_column_policy&lt; Wrap &gt;:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="a01993.png" border="0" usemap="#boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_coll__map" id="boost_1_1numeric_1_1ublas_1_1traverse__policy_1_1by__column__policy_3_01_wrap_01_4_coll__map">
<area shape="rect" id="node2" href="a00452.html" title="{boost::numeric::ublas::traverse_policy_wrapper\&lt; by_column_policy\&lt; Wrap \&gt; \&gt;\n||}" alt="" coords="5,157,483,243"/><area shape="rect" id="node4" href="a00452.html" title="A wrapper for traverse policy classes." alt="" coords="80,5,408,91"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a01994.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 <a class="el" href="a00448.html">by_column_policy</a>&lt; Wrap &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00452.html#a1c220f497f1b3ebac1b9770bd90fb598">type</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename S1 , typename S2 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static BOOST_UBLAS_INLINE void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00448.html#afee543021326c9af7cb7d2689e05d5aa">advance</a> (S1 &amp;i, S2 &amp;)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class E , typename S1 , typename S2 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static BOOST_UBLAS_INLINE void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00448.html#ade49cfb1d386f05c4b6e9be24181f6ee">apply_wrap</a> (const E &amp;e, S1 &amp;i, S2 &amp;j)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class E1 , class E2 , typename S1 , typename S2 , typename S3 , typename S4 , typename S5 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static BOOST_UBLAS_INLINE bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00448.html#ab2b20b5656eef6ac4a4954575f96f7f3">next</a> (const E1 &amp;e, const E2 &amp;me, S1 &amp;i, S2 &amp;j, const S3 &amp;i0, const S3 &amp;, S4 &amp;k, S5 &amp;l)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Wrap = wrap&gt;<br/>
class boost::numeric::ublas::traverse_policy::by_column_policy&lt; Wrap &gt;</h3>
<p>The column_by_column traverse policy. </p>
<p>This policy is used when the assignment is desired to happen column_major wise, for performance or other reasons.</p>
<p>This is the NOT the default behaviour. To set this as the default define BOOST_UBLAS_DEFAULT_ASSIGN_BY_COLUMN in the compilation options or in an adequate header file.</p>
<p>Please see EXAMPLES_LINK for usage information.</p>
<p>Definition at line <a class="el" href="a00594_source.html#l00841">841</a> of file <a class="el" href="a00594_source.html">assignment.hpp</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a1c220f497f1b3ebac1b9770bd90fb598"></a><!-- doxytag: member="boost::numeric::ublas::traverse_policy::by_column_policy::type" ref="a1c220f497f1b3ebac1b9770bd90fb598" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00448.html">by_column_policy</a>&lt; Wrap &gt; <a class="el" href="a00452.html">boost::numeric::ublas::traverse_policy_wrapper</a>&lt; <a class="el" href="a00448.html">by_column_policy</a>&lt; Wrap &gt; &gt;::<a class="el" href="a00452.html#a1c220f497f1b3ebac1b9770bd90fb598">type</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00594_source.html#l00722">722</a> of file <a class="el" href="a00594_source.html">assignment.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afee543021326c9af7cb7d2689e05d5aa"></a><!-- doxytag: member="boost::numeric::ublas::traverse_policy::by_column_policy::advance" ref="afee543021326c9af7cb7d2689e05d5aa" args="(S1 &amp;i, S2 &amp;)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Wrap = wrap&gt; </div>
<div class="memtemplate">
template&lt;typename S1 , typename S2 &gt; </div>
<table class="memname">
<tr>
<td class="memname">static BOOST_UBLAS_INLINE void <a class="el" href="a00448.html">boost::numeric::ublas::traverse_policy::by_column_policy</a>&lt; Wrap &gt;::advance </td>
<td>(</td>
<td class="paramtype">S1 &amp;&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S2 &amp;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00594_source.html#l00845">845</a> of file <a class="el" href="a00594_source.html">assignment.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab2b20b5656eef6ac4a4954575f96f7f3"></a><!-- doxytag: member="boost::numeric::ublas::traverse_policy::by_column_policy::next" ref="ab2b20b5656eef6ac4a4954575f96f7f3" args="(const E1 &amp;e, const E2 &amp;me, S1 &amp;i, S2 &amp;j, const S3 &amp;i0, const S3 &amp;, S4 &amp;k, S5 &amp;l)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Wrap = wrap&gt; </div>
<div class="memtemplate">
template&lt;class E1 , class E2 , typename S1 , typename S2 , typename S3 , typename S4 , typename S5 &gt; </div>
<table class="memname">
<tr>
<td class="memname">static BOOST_UBLAS_INLINE bool <a class="el" href="a00448.html">boost::numeric::ublas::traverse_policy::by_column_policy</a>&lt; Wrap &gt;::next </td>
<td>(</td>
<td class="paramtype">const E1 &amp;&#160;</td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const E2 &amp;&#160;</td>
<td class="paramname"><em>me</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S1 &amp;&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S2 &amp;&#160;</td>
<td class="paramname"><em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const S3 &amp;&#160;</td>
<td class="paramname"><em>i0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const S3 &amp;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S4 &amp;&#160;</td>
<td class="paramname"><em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S5 &amp;&#160;</td>
<td class="paramname"><em>l</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00594_source.html#l00849">849</a> of file <a class="el" href="a00594_source.html">assignment.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ade49cfb1d386f05c4b6e9be24181f6ee"></a><!-- doxytag: member="boost::numeric::ublas::traverse_policy::by_column_policy::apply_wrap" ref="ade49cfb1d386f05c4b6e9be24181f6ee" args="(const E &amp;e, S1 &amp;i, S2 &amp;j)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Wrap = wrap&gt; </div>
<div class="memtemplate">
template&lt;class E , typename S1 , typename S2 &gt; </div>
<table class="memname">
<tr>
<td class="memname">static BOOST_UBLAS_INLINE void <a class="el" href="a00448.html">boost::numeric::ublas::traverse_policy::by_column_policy</a>&lt; Wrap &gt;::apply_wrap </td>
<td>(</td>
<td class="paramtype">const E &amp;&#160;</td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S1 &amp;&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">S2 &amp;&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00594_source.html#l00868">868</a> of file <a class="el" href="a00594_source.html">assignment.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00594_source.html">assignment.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="a00660.html">traverse_policy</a> </li>
<li class="navelem"><a class="el" href="a00448.html">by_column_policy</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>