Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > c5653a35bb94fee65ffe21230992c863 > files > 56

linbox-doc-1.2.1-1.fc15.noarch.rpm

<!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: BlasPermutation&lt; _UnsignedInt &gt; 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;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&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;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_blas_permutation.html">BlasPermutation</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">BlasPermutation&lt; _UnsignedInt &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::BlasPermutation" -->
<p>Lapack-style permutation.  
 <a href="class_lin_box_1_1_blas_permutation.html#details">More...</a></p>

<p><code>#include &lt;matrix-permutation.h&gt;</code></p>
<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">_UnsignedInt&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#aa30987b55cee0f7e5b4904ae55188825">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_matrix_permutation.html">MatrixPermutation</a>&lt; _UnsignedInt &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#a2255bc8a7db43842d45cb908746dde34">Convert</a> (<a class="el" href="class_lin_box_1_1_matrix_permutation.html">MatrixPermutation</a>&lt; _UnsignedInt &gt; &amp;P)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a <code><a class="el" href="class_lin_box_1_1_blas_permutation.html" title="Lapack-style permutation.">BlasPermutation</a></code> to a <code><a class="el" href="class_lin_box_1_1_matrix_permutation.html" title="Permutation classique.">MatrixPermutation</a></code>.  <a href="#a2255bc8a7db43842d45cb908746dde34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_UnsignedInt&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#a0fff1b49e74b83315ec873841b3a46ed">operator[]</a> (const _UnsignedInt i) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><img class="formulaInl" alt="$ M \gets P M$" src="form_64.png"/>  <a href="#a0fff1b49e74b83315ec873841b3a46ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const _UnsignedInt *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#a593a7496727ce80d336e9931a9003ef9">getPointer</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">col <code>i</code> and col <code>j</code> are swapped  <a href="#a593a7496727ce80d336e9931a9003ef9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ba9edee3fd93ac653cee4e428b6e93e"></a><!-- doxytag: member="LinBox::BlasPermutation::Compress" ref="a0ba9edee3fd93ac653cee4e428b6e93e" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#a0ba9edee3fd93ac653cee4e428b6e93e">Compress</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">compresses <a class="el" href="class_lin_box_1_1_blas_permutation.html" title="Lapack-style permutation.">BlasPermutation</a> to a smaller <code>r_</code>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa878964fff4946cc135175758bb7adfc"></a><!-- doxytag: member="LinBox::BlasPermutation::write" ref="aa878964fff4946cc135175758bb7adfc" args="(std::ostream &amp;o, bool Lapack=true) const " -->
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#aa878964fff4946cc135175758bb7adfc">write</a> (std::ostream &amp;o, bool Lapack=true) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">writes on output stream <code>o</code> <br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a634e195b7ad8eebdb4daa838275f7d3b"></a><!-- doxytag: member="LinBox::BlasPermutation::operator&lt;&lt;" ref="a634e195b7ad8eebdb4daa838275f7d3b" args="(std::ostream &amp;o, BlasPerm &amp;P)" -->
template&lt;class _Uint &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blas_permutation.html#a634e195b7ad8eebdb4daa838275f7d3b">operator&lt;&lt;</a> (std::ostream &amp;o, <a class="el" href="class_lin_box_1_1_blas_permutation.html">BlasPerm</a> &amp;P)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">writes <code>P</code> on output stream <code>o</code> <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class _UnsignedInt&gt;<br/>
class LinBox::BlasPermutation&lt; _UnsignedInt &gt;</h3>

<p>Lapack-style permutation. </p>
<p>A Lapack permutation is represented with a vector <img class="formulaInl" alt="$[p_1,p_2,\cdots, p_r]$" src="form_61.png"/> such that <img class="formulaInl" alt="$p_i > i$" src="form_62.png"/>. Converting it to a classic representation of a permutation corresponds to taking an identity permutation and then successively permuting <img class="formulaInl" alt="$(i,p_i)$" src="form_63.png"/>. Example : if <code>P=[1,4,4]</code> and <code>V=[1,2,3,4,5]</code>, then <code>P.V=[1,4,2,3,5]</code>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa30987b55cee0f7e5b4904ae55188825"></a><!-- doxytag: member="LinBox::BlasPermutation::getSize" ref="aa30987b55cee0f7e5b4904ae55188825" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_Uint getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><dl class="warning"><dt><b>Warning:</b></dt><dd>potentially catastrophic </dd></dl>
</p>

</div>
</div>
<a class="anchor" id="a2255bc8a7db43842d45cb908746dde34"></a><!-- doxytag: member="LinBox::BlasPermutation::Convert" ref="a2255bc8a7db43842d45cb908746dde34" args="(MatrixPermutation&lt; _UnsignedInt &gt; &amp;P)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_matrix_permutation.html">MatrixPermutation</a>&lt; _Uint &gt; &amp; Convert </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_lin_box_1_1_matrix_permutation.html">MatrixPermutation</a>&lt; _Uint &gt; &amp;&#160;</td>
          <td class="paramname"><em>P</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Converts a <code><a class="el" href="class_lin_box_1_1_blas_permutation.html" title="Lapack-style permutation.">BlasPermutation</a></code> to a <code><a class="el" href="class_lin_box_1_1_matrix_permutation.html" title="Permutation classique.">MatrixPermutation</a></code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">P</td><td><a class="el" href="class_lin_box_1_1_matrix_permutation.html" title="Permutation classique.">MatrixPermutation</a> to be created. Need not be initialized. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a0fff1b49e74b83315ec873841b3a46ed"></a><!-- doxytag: member="LinBox::BlasPermutation::operator[]" ref="a0fff1b49e74b83315ec873841b3a46ed" args="(const _UnsignedInt i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_Uint operator[] </td>
          <td>(</td>
          <td class="paramtype">const _Uint&#160;</td>
          <td class="paramname"><em>i</em></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><img class="formulaInl" alt="$ M \gets P M$" src="form_64.png"/> </p>
<p><img class="formulaInl" alt="$ M \gets M P$" src="form_65.png"/></p>
<p><img class="formulaInl" alt="$ M \gets M P^t$" src="form_66.png"/></p>
<p><img class="formulaInl" alt="$ M \gets P^t M$" src="form_67.png"/> </p>

</div>
</div>
<a class="anchor" id="a593a7496727ce80d336e9931a9003ef9"></a><!-- doxytag: member="LinBox::BlasPermutation::getPointer" ref="a593a7496727ce80d336e9931a9003ef9" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const _UnsignedInt* getPointer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>col <code>i</code> and col <code>j</code> are swapped </p>
<p>row <code>i</code> and row <code>j</code> are swapped </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="matrix-permutation_8h.html">matrix-permutation.h</a></li>
<li><a class="el" href="matrix-permutation_8inl.html">matrix-permutation.inl</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Aug 30 2011 for linbox by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>