Sophie

Sophie

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

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: BlackboxBlockContainerBase&lt; _Field, _Blackbox &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_blackbox_block_container_base.html">BlackboxBlockContainerBase</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">BlackboxBlockContainerBase&lt; _Field, _Blackbox &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::BlackboxBlockContainerBase" -->
<p>A base class for <a class="el" href="class_lin_box_1_1_blackbox_block_container.html" title="no doc.">BlackboxBlockContainer</a>.  
 <a href="class_lin_box_1_1_blackbox_block_container_base.html#details">More...</a></p>

<p><code>#include &lt;blackbox-block-container-base.h&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 BlackboxBlockContainerBase&lt; _Field, _Blackbox &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="class_lin_box_1_1_blackbox_block_container_base.png" usemap="#BlackboxBlockContainerBase&lt; _Field, _Blackbox &gt;_map" alt=""/>
  <map id="BlackboxBlockContainerBase&lt; _Field, _Blackbox &gt;_map" name="BlackboxBlockContainerBase&lt; _Field, _Blackbox &gt;_map">
<area href="class_lin_box_1_1_blackbox_block_container.html" title="no doc." alt="BlackboxBlockContainer&lt; _Field, _Blackbox &gt;" shape="rect" coords="0,56,316,80"/>
<area href="class_lin_box_1_1_blackbox_block_container_record.html" title="no doc." alt="BlackboxBlockContainerRecord&lt; _Field, _Blackbox &gt;" shape="rect" coords="326,56,642,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a675ee022f55c7cb1d22cdcbd731fae43">_launch</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Launches a process to do the computation of the next sequence value: <img class="formulaInl" alt="$U A^{i+1} V$" src="form_3.png"/>.  <a href="#a675ee022f55c7cb1d22cdcbd731fae43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10120b44afa59e786a51fcfc376a0bf0"></a><!-- doxytag: member="LinBox::BlackboxBlockContainerBase::_wait" ref="a10120b44afa59e786a51fcfc376a0bf0" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a10120b44afa59e786a51fcfc376a0bf0">_wait</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If a separate process is computing the next value of <img class="formulaInl" alt="$U A^{i+1} V$" src="form_3.png"/>, <code><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a10120b44afa59e786a51fcfc376a0bf0" title="If a separate process is computing the next value of , _wait() blocks until the value is ready...">_wait()</a></code> blocks until the value is ready. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc64436e489cd10cc4bbb8d80d9077b8"></a><!-- doxytag: member="LinBox::BlackboxBlockContainerBase::Mul" ref="abc64436e489cd10cc4bbb8d80d9077b8" args="(Block &amp;M1, const Blackbox &amp;M2, const Block &amp;M3)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#abc64436e489cd10cc4bbb8d80d9077b8">Mul</a> (<a class="el" href="class_lin_box_1_1_blas_matrix.html">Block</a> &amp;M1, const Blackbox &amp;M2, const <a class="el" href="class_lin_box_1_1_blas_matrix.html">Block</a> &amp;M3)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af641f3b7db38c538cc3bde73f6be3265"></a><!-- doxytag: member="LinBox::BlackboxBlockContainerBase::init" ref="af641f3b7db38c538cc3bde73f6be3265" args="(const Block &amp;U, const Block &amp;V)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#af641f3b7db38c538cc3bde73f6be3265">init</a> (const <a class="el" href="class_lin_box_1_1_blas_matrix.html">Block</a> &amp;U, const <a class="el" href="class_lin_box_1_1_blas_matrix.html">Block</a> &amp;V)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">User Left and Right blocks. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ec69a565e26d3a7e937f23bd4e93983"></a><!-- doxytag: member="LinBox::BlackboxBlockContainerBase::_F" ref="a3ec69a565e26d3a7e937f23bd4e93983" args="" -->
Field&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a3ec69a565e26d3a7e937f23bd4e93983">_F</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Members. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class _Field, class _Blackbox&gt;<br/>
class LinBox::BlackboxBlockContainerBase&lt; _Field, _Blackbox &gt;</h3>

<p>A base class for <a class="el" href="class_lin_box_1_1_blackbox_block_container.html" title="no doc.">BlackboxBlockContainer</a>. </p>
<p>The primary member function is <code>begin()</code>.</p>
<p>It returns an iterator which after i increments (++) dereferences to <img class="formulaInl" alt="$U A^i V$" src="form_0.png"/>, for <img class="formulaInl" alt="$U$" src="form_1.png"/> and <img class="formulaInl" alt="$V$" src="form_2.png"/> determined by the init function. It is designed to be used with implementations of Block Berlekamp-Massey such as <a class="el" href="class_lin_box_1_1_block_massey_domain.html" title="Compute the linear generator of a sequence of matrices.">BlockMasseyDomain</a>.</p>
<p>Subclasses complete the implementation by defining <code><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a675ee022f55c7cb1d22cdcbd731fae43" title="Launches a process to do the computation of the next sequence value: .">_launch()</a></code> and <code><a class="el" href="class_lin_box_1_1_blackbox_block_container_base.html#a10120b44afa59e786a51fcfc376a0bf0" title="If a separate process is computing the next value of , _wait() blocks until the value is ready...">_wait()</a></code>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a675ee022f55c7cb1d22cdcbd731fae43"></a><!-- doxytag: member="LinBox::BlackboxBlockContainerBase::_launch" ref="a675ee022f55c7cb1d22cdcbd731fae43" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void _launch </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Launches a process to do the computation of the next sequence value: <img class="formulaInl" alt="$U A^{i+1} V$" src="form_3.png"/>. </p>
<p>...or just does it. </p>

<p>Implemented in <a class="el" href="class_lin_box_1_1_blackbox_block_container.html#a906684c285d987f9764fa872d3601b14">BlackboxBlockContainer&lt; _Field, _Blackbox &gt;</a>, and <a class="el" href="class_lin_box_1_1_blackbox_block_container_record.html#a906684c285d987f9764fa872d3601b14">BlackboxBlockContainerRecord&lt; _Field, _Blackbox &gt;</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="blackbox-block-container-base_8h.html">blackbox-block-container-base.h</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>