<!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: Permutation< _Field, _Storage > 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_permutation.html">Permutation</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Permutation< _Field, _Storage > Class Template Reference<div class="ingroups"><a class="el" href="group__blackbox.html">blackbox</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::Permutation" --><!-- doxytag: inherits="LinBox::BlackboxInterface" -->
<p>size is n.
<a href="class_lin_box_1_1_permutation.html#details">More...</a></p>
<p><code>#include <permutation.h></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 Permutation< _Field, _Storage >:</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="class_lin_box_1_1_permutation.png" usemap="#Permutation< _Field, _Storage >_map" alt=""/>
<map id="Permutation< _Field, _Storage >_map" name="Permutation< _Field, _Storage >_map">
<area href="class_lin_box_1_1_blackbox_interface.html" title="This blackbox base class exists solely to aid documentation organization." alt="BlackboxInterface" shape="rect" coords="0,0,197,24"/>
</map>
</div></div>
<table class="memberdecls">
<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_permutation.html#a35e922db487003f9d3062e005f953be9">Permutation</a> (Storage &indices, const Field &F=Field())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a vector of indices. <a href="#a35e922db487003f9d3062e005f953be9"></a><br/></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_permutation.html#a810bd0b8e75936c20801f1b0eeaf38bc">Permutation</a> (int n, const Field &F=Field())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a dimension. <a href="#a810bd0b8e75936c20801f1b0eeaf38bc"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_permutation.html#aa37d57c030b1db0c198478268aa3cc15">apply</a> (OutVector &y, const InVector &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox permutation matrix. <a href="#aa37d57c030b1db0c198478268aa3cc15"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_permutation.html#ac1a9817268900b78faa5a6eb17d9badf">applyTranspose</a> (OutVector &y, const InVector &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox permutation matrix transpose. <a href="#ac1a9817268900b78faa5a6eb17d9badf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09202c1aaa6c5a4c8e69a2339a27bcfe"></a><!-- doxytag: member="LinBox::Permutation::rowdim" ref="a09202c1aaa6c5a4c8e69a2339a27bcfe" args="(void) const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_permutation.html#a09202c1aaa6c5a4c8e69a2339a27bcfe">rowdim</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">rowdim <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63d5df22c5024e979e3462155d0fe814"></a><!-- doxytag: member="LinBox::Permutation::coldim" ref="a63d5df22c5024e979e3462155d0fe814" args="(void) const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_permutation.html#a63d5df22c5024e979e3462155d0fe814">coldim</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">coldim <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a021ef23116cf9f992ce8f50b8ecbef3d"></a><!-- doxytag: member="LinBox::Permutation::permute" ref="a021ef23116cf9f992ce8f50b8ecbef3d" args="(size_t row1, size_t row2)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_permutation.html#a021ef23116cf9f992ce8f50b8ecbef3d">permute</a> (size_t row1, size_t row2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a transposition to the matrix. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class _Field, class _Storage = __LINBOX_PERMUTATION_STORAGE><br/>
class LinBox::Permutation< _Field, _Storage ></h3>
<p>size is n. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">Storage</td><td><a class="el" href="namespace_lin_box.html">LinBox</a> dense or sparse vector of field elements </td></tr>
</table>
</dd>
</dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a35e922db487003f9d3062e005f953be9"></a><!-- doxytag: member="LinBox::Permutation::Permutation" ref="a35e922db487003f9d3062e005f953be9" args="(Storage &indices, const Field &F=Field())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_permutation.html">Permutation</a> </td>
<td>(</td>
<td class="paramtype">Storage & </td>
<td class="paramname"><em>indices</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em> = <code>Field()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from a vector of indices. </p>
<p>This constructor creates a permutation matrix based on a vector of indices </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td></td></tr>
<tr><td class="paramname">indices</td><td>Vector of indices representing the permutation </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a810bd0b8e75936c20801f1b0eeaf38bc"></a><!-- doxytag: member="LinBox::Permutation::Permutation" ref="a810bd0b8e75936c20801f1b0eeaf38bc" args="(int n, const Field &F=Field())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_permutation.html">Permutation</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em> = <code>Field()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from a dimension. </p>
<p>This constructor creates an n x n permutation matrix, initialized to be the identity </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The dimension of hte matrix to create </td></tr>
<tr><td class="paramname">F</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa37d57c030b1db0c198478268aa3cc15"></a><!-- doxytag: member="LinBox::Permutation::apply" ref="aa37d57c030b1db0c198478268aa3cc15" args="(OutVector &y, const InVector &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OutVector& apply </td>
<td>(</td>
<td class="paramtype">OutVector & </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const InVector & </td>
<td class="paramname"><em>x</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Application of BlackBox permutation matrix. </p>
<p><img class="formulaInl" alt="$y \leftarrow Px$" src="form_40.png"/>. Requires one vector conforming to the <a class="el" href="namespace_lin_box.html">LinBox</a> vector <a class="el" href="_archetypes.html">archetype</a>. Required by abstract base class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to vector y containing output. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>constant reference to vector to contain input </td></tr>
<tr><td class="paramname">y</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac1a9817268900b78faa5a6eb17d9badf"></a><!-- doxytag: member="LinBox::Permutation::applyTranspose" ref="ac1a9817268900b78faa5a6eb17d9badf" args="(OutVector &y, const InVector &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OutVector& applyTranspose </td>
<td>(</td>
<td class="paramtype">OutVector & </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const InVector & </td>
<td class="paramname"><em>x</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Application of BlackBox permutation matrix transpose. </p>
<p><code>y= transpose(P)*x</code>, equivalently <code>y= P^-1*x</code> Requires one vector conforming to the <a class="el" href="namespace_lin_box.html">LinBox</a> vector <a class="el" href="_archetypes.html">archetype</a>. Required by abstract base class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to vector y containing output. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>constant reference to vector to contain input </td></tr>
<tr><td class="paramname">y</td><td><img class="formulaInl" alt="$y^T \leftarrow x^T P$" src="form_41.png"/>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>permutation.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>
