<!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>linbox: CekstvSwitch< Field > 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.7.4 -->
<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 style="padding-left: 0.5em;">
<div id="projectname">linbox</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lin_box.html">LinBox</a> </li>
<li class="navelem"><a class="el" href="class_lin_box_1_1_cekstv_switch.html">CekstvSwitch</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CekstvSwitch< Field > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::CekstvSwitch" -->
<p><a class="el" href="class_lin_box_1_1_butterfly.html" title="Switching Network based BlackBox Matrix.">Butterfly</a> switch object from preconditioner paper.
<a href="class_lin_box_1_1_cekstv_switch.html#details">More...</a></p>
<p><code>#include <cekstv.h></code></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"><a class="anchor" id="a41bf9f872e3af67d367637e745169dc7"></a><!-- doxytag: member="LinBox::CekstvSwitch::Element" ref="a41bf9f872e3af67d367637e745169dc7" args="" -->
typedef Field::Element </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_cekstv_switch.html#a41bf9f872e3af67d367637e745169dc7">Element</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedef. <br/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_cekstv_switch.html#a79f8618029268f44eadb1d4e856afdde">CekstvSwitch</a> (const typename Field::Element &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a field and a field element. <a href="#a79f8618029268f44eadb1d4e856afdde"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72c54ede9d2a8b7736c006ea4a652ee9"></a><!-- doxytag: member="LinBox::CekstvSwitch::~CekstvSwitch" ref="a72c54ede9d2a8b7736c006ea4a652ee9" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_cekstv_switch.html#a72c54ede9d2a8b7736c006ea4a652ee9">~CekstvSwitch</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_cekstv_switch.html#ab8660dd44807e95e199784c23917a3c2">apply</a> (const Field &F, <a class="el" href="class_lin_box_1_1_cekstv_switch.html#a41bf9f872e3af67d367637e745169dc7">Element</a> &x, <a class="el" href="class_lin_box_1_1_cekstv_switch.html#a41bf9f872e3af67d367637e745169dc7">Element</a> &y) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply switch function. <a href="#ab8660dd44807e95e199784c23917a3c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_cekstv_switch.html#a1c6e6462a6d129863c4a4d3b6d720f75">applyTranspose</a> (const Field &F, <a class="el" href="class_lin_box_1_1_cekstv_switch.html#a41bf9f872e3af67d367637e745169dc7">Element</a> &x, <a class="el" href="class_lin_box_1_1_cekstv_switch.html#a41bf9f872e3af67d367637e745169dc7">Element</a> &y) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply switch transpose function. <a href="#a1c6e6462a6d129863c4a4d3b6d720f75"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Field><br/>
class LinBox::CekstvSwitch< Field ></h3>
<p><a class="el" href="class_lin_box_1_1_butterfly.html" title="Switching Network based BlackBox Matrix.">Butterfly</a> switch object from preconditioner paper. </p>
<p>This is a switch predicate object that is applied to two references to elements to switch them as needed by the <a class="el" href="class_lin_box_1_1_butterfly.html">Butterfly</a>\ Switching\ Network\ BlackBox\ Matrix\ Object following the exchange matrix introduced in "Efficient Matrix
Preconditioners for Black Box Linear Algebra" by Chen, Eberly, Kaltofen, Saunders, Turner, and Villard. This class is templatized by the field in which the arithmetic is done. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a79f8618029268f44eadb1d4e856afdde"></a><!-- doxytag: member="LinBox::CekstvSwitch::CekstvSwitch" ref="a79f8618029268f44eadb1d4e856afdde" args="(const typename Field::Element &a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_cekstv_switch.html">CekstvSwitch</a> </td>
<td>(</td>
<td class="paramtype">const typename Field::Element & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from a field and a field element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>vector of switches </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab8660dd44807e95e199784c23917a3c2"></a><!-- doxytag: member="LinBox::CekstvSwitch::apply" ref="ab8660dd44807e95e199784c23917a3c2" args="(const Field &F, Element &x, Element &y) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool apply </td>
<td>(</td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename Field::Element & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename Field::Element & </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply switch function. </p>
<p>Switches the elements in references according to the exchange matrix introduced in "Efficient Matrix
Preconditioners for Black Box Linear Algebra" by Chen, Eberly, Kaltofen, Saunders, Turner, and Villard and the current field element specified in the switch object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>bool true if swapped, false otherwise </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td></td></tr>
<tr><td class="paramname">x</td><td>reference to first element to be switched </td></tr>
<tr><td class="paramname">y</td><td>reference to second element to be switched </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1c6e6462a6d129863c4a4d3b6d720f75"></a><!-- doxytag: member="LinBox::CekstvSwitch::applyTranspose" ref="a1c6e6462a6d129863c4a4d3b6d720f75" args="(const Field &F, Element &x, Element &y) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool applyTranspose </td>
<td>(</td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename Field::Element & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename Field::Element & </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply switch transpose function. </p>
<p>Switches the elements in references according to the transpose of the exchange matrix introduced in "Efficient Matrix
Preconditioners for Black Box Linear Algebra" by Chen, Eberly, Kaltofen, Saunders, Turner, and Villard and the current field element specified in the switch object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>bool true if swapped, false otherwise </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td></td></tr>
<tr><td class="paramname">x</td><td>reference to first element to be switched </td></tr>
<tr><td class="paramname">y</td><td>reference to second element to be switched </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cekstv.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Aug 30 2011 for linbox by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
