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

299 lines
18 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::scalar_expression&lt; E &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('a00379.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> </div>
<div class="headertitle">
<h1>boost::numeric::ublas::scalar_expression&lt; E &gt; Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="boost::numeric::ublas::scalar_expression" --><!-- doxytag: inherits="boost::numeric::ublas::ublas_expression" -->
<p>Base class for Scalar Expression models.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="a00611_source.html">expression_types.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::scalar_expression&lt; E &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="a01448.png" border="0" usemap="#boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_inherit__map" id="boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_inherit__map">
<area shape="rect" id="node5" href="a00379.html" title="{boost::numeric::ublas::scalar_expression\&lt; scalar_value\&lt; T \&gt; \&gt;\n||+ operator()()\l+ operator()()\l}" alt="" coords="5,347,395,450"/><area shape="rect" id="node9" href="a00379.html" title="{boost::numeric::ublas::scalar_expression\&lt; vector_scalar_unary\&lt; E, F \&gt; \&gt;\n||+ operator()()\l+ operator()()\l}" alt="" coords="419,347,869,450"/><area shape="rect" id="node13" href="a00379.html" title="{boost::numeric::ublas::scalar_expression\&lt; scalar_reference\&lt; T \&gt; \&gt;\n||+ operator()()\l+ operator()()\l}" alt="" coords="893,347,1304,450"/><area shape="rect" id="node17" href="a00379.html" title="{boost::numeric::ublas::scalar_expression\&lt; matrix_scalar_unary\&lt; E, F \&gt; \&gt;\n||+ operator()()\l+ operator()()\l}" alt="" coords="1328,347,1779,450"/><area shape="rect" id="node21" href="a00379.html" title="{boost::numeric::ublas::scalar_expression\&lt; vector_scalar_binary\&lt; E1, E2, F \&gt; \&gt;\n||+ operator()()\l+ operator()()\l}" alt="" coords="1803,347,2285,450"/><area shape="rect" id="node2" href="a00472.html" title="Base class for uBLAS statically derived expressions using the the Barton Nackman trick." alt="" coords="955,5,1243,125"/><area shape="rect" id="node7" href="a00403.html" title="{boost::numeric::ublas::scalar_value\&lt; T \&gt;\n|&#45; t_\l|+ scalar_value()\l+ scalar_value()\l+ operator value_type()\l+ operator=()\l+ operator=()\l+ same_closure()\l}" alt="" coords="71,527,329,699"/><area shape="rect" id="node11" href="a00537.html" title="{boost::numeric::ublas::vector_scalar_unary\&lt; E, F \&gt;\n|&#45; e_\l|+ vector_scalar_unary()\l+ operator value_type()\l&#45; evaluate()\l&#45; evaluate()\l&#45; evaluate()\l&#45; expression()\l}" alt="" coords="484,527,804,699"/><area shape="rect" id="node15" href="a00397.html" title="{boost::numeric::ublas::scalar_reference\&lt; T \&gt;\n|&#45; t_\l|+ scalar_reference()\l+ operator value_type()\l+ operator=()\l+ operator=()\l+ same_closure()\l}" alt="" coords="957,536,1240,691"/><area shape="rect" id="node19" href="a00280.html" title="{boost::numeric::ublas::matrix_scalar_unary\&lt; E, F \&gt;\n|&#45; e_\l|+ matrix_scalar_unary()\l+ operator value_type()\l&#45; expression()\l}" alt="" coords="1393,553,1713,673"/><area shape="rect" id="node23" href="a00532.html" title="{boost::numeric::ublas::vector_scalar_binary\&lt; E1, E2, F \&gt;\n|+ complexity\l&#45; e1_\l&#45; e2_\l|+ vector_scalar_binary()\l+ operator value_type()\l&#45; evaluate()\l&#45; evaluate()\l&#45; evaluate()\l&#45; expression1()\l&#45; expression2()\l}" alt="" coords="1867,501,2221,725"/></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::scalar_expression&lt; E &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="a01449.png" border="0" usemap="#boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_coll__map" id="boost_1_1numeric_1_1ublas_1_1scalar__expression_3_01_e_01_4_coll__map">
<area shape="rect" id="node2" href="a00472.html" title="Base class for uBLAS statically derived expressions using the the Barton Nackman trick." alt="" coords="8,5,296,125"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a01450.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 E&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00379.html#a692a239d5f8f6c903fe266923b131171">expression_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a00400.html">scalar_tag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00379.html#a8f93334c539799c73fcafdbbb0fead26">type_category</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 const <br class="typebreak"/>
<a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">expression_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00379.html#afa45f1c99691a3955784fcdf52615b69">operator()</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">BOOST_UBLAS_INLINE <br class="typebreak"/>
<a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">expression_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00379.html#a69b97ed07492e765a6f7a559797f05b1">operator()</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class E&gt;<br/>
class boost::numeric::ublas::scalar_expression&lt; E &gt;</h3>
<p>Base class for Scalar Expression models. </p>
<p>It does not model the Scalar Expression concept but all derived types should. The class defines a common base type and some common interface for all statically derived Scalar Expression classes.</p>
<p>We implement the casts to the statically derived type.</p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">E</td><td>an expression type </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00611_source.html#l00060">60</a> of file <a class="el" href="a00611_source.html">expression_types.hpp</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a692a239d5f8f6c903fe266923b131171"></a><!-- doxytag: member="boost::numeric::ublas::scalar_expression::expression_type" ref="a692a239d5f8f6c903fe266923b131171" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef E <a class="el" href="a00379.html">boost::numeric::ublas::scalar_expression</a>&lt; E &gt;::<a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">expression_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">boost::numeric::ublas::ublas_expression&lt; E &gt;</a>.</p>
<p>Reimplemented in <a class="el" href="a00280.html#a6776f0d93ed1ea044fe235259bc121a9">boost::numeric::ublas::matrix_scalar_unary&lt; E, F &gt;</a>, and <a class="el" href="a00537.html#ac167b460e3523611ea94f7d15f526878">boost::numeric::ublas::vector_scalar_unary&lt; E, F &gt;</a>.</p>
<p>Definition at line <a class="el" href="a00611_source.html#l00063">63</a> of file <a class="el" href="a00611_source.html">expression_types.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8f93334c539799c73fcafdbbb0fead26"></a><!-- doxytag: member="boost::numeric::ublas::scalar_expression::type_category" ref="a8f93334c539799c73fcafdbbb0fead26" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00400.html">scalar_tag</a> <a class="el" href="a00379.html">boost::numeric::ublas::scalar_expression</a>&lt; E &gt;::<a class="el" href="a00400.html">type_category</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00611_source.html#l00064">64</a> of file <a class="el" href="a00611_source.html">expression_types.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afa45f1c99691a3955784fcdf52615b69"></a><!-- doxytag: member="boost::numeric::ublas::scalar_expression::operator()" ref="afa45f1c99691a3955784fcdf52615b69" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE const <a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">expression_type</a>&amp; <a class="el" href="a00379.html">boost::numeric::ublas::scalar_expression</a>&lt; E &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="a00611_source.html#l00067">67</a> of file <a class="el" href="a00611_source.html">expression_types.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a69b97ed07492e765a6f7a559797f05b1"></a><!-- doxytag: member="boost::numeric::ublas::scalar_expression::operator()" ref="a69b97ed07492e765a6f7a559797f05b1" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E&gt; </div>
<table class="memname">
<tr>
<td class="memname">BOOST_UBLAS_INLINE <a class="el" href="a00472.html#abbbdc2aeed323a2df31707384ca0e26d">expression_type</a>&amp; <a class="el" href="a00379.html">boost::numeric::ublas::scalar_expression</a>&lt; E &gt;::operator() </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="a00611_source.html#l00071">71</a> of file <a class="el" href="a00611_source.html">expression_types.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00611_source.html">expression_types.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="a00379.html">scalar_expression</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>