Sophie

Sophie

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

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: FieldAXPY&lt; UnparametricField&lt; integer &gt; &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_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html">FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;</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">FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__integers.html">Integers</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;" -->
<p>NO DOc.  
 <a href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#details">More...</a></p>

<p><code>#include &lt;unparametric.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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#a4e7f85a29218e48bf83b1527a339f700">FieldAXPY</a> (const Field &amp;F)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a4e7f85a29218e48bf83b1527a339f700"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#a363d992668451daf17997ad272befa5d">FieldAXPY</a> (const <a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&lt; Field &gt; &amp;faxpy)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#a363d992668451daf17997ad272befa5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&lt; Field &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#acf9d1e1a014d289f6b177565b613c7df">operator=</a> (const <a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a> &amp;faxpy)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#acf9d1e1a014d289f6b177565b613c7df"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class Element1 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">Element &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#a719946bfb97c4c44d1b123ef4be463b2">mulacc</a> (const Element &amp;a, const Element1 &amp;x)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a*x to y y += a*x.  <a href="#a719946bfb97c4c44d1b123ef4be463b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Element &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#afbfef52c4fbdc26d05aebbcffe26269a">get</a> (Element &amp;y)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve y.  <a href="#afbfef52c4fbdc26d05aebbcffe26269a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_field_a_x_p_y_3_01_unparametric_field_3_01integer_01_4_01_4.html#a3d6e9eaed45864b2bfc95c0cfc9b2c3d">assign</a> (const Element &amp;y)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign method.  <a href="#a3d6e9eaed45864b2bfc95c0cfc9b2c3d"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br/>
class LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;</h3>

<p>NO DOc. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4e7f85a29218e48bf83b1527a339f700"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::FieldAXPY" ref="a4e7f85a29218e48bf83b1527a339f700" args="(const Field &amp;F)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a> </td>
          <td>(</td>
          <td class="paramtype">const Field &amp;&#160;</td>
          <td class="paramname"><em>F</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<p>A faxpy object if constructed from a Field and a field element. Copies of this objects are stored in the faxpy object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">F</td><td>field F in which arithmetic is done </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a363d992668451daf17997ad272befa5d"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::FieldAXPY" ref="a363d992668451daf17997ad272befa5d" args="(const FieldAXPY&lt; Field &gt; &amp;faxpy)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&lt; Field &gt; &amp;&#160;</td>
          <td class="paramname"><em>faxpy</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Copy constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">faxpy</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acf9d1e1a014d289f6b177565b613c7df"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::operator=" ref="acf9d1e1a014d289f6b177565b613c7df" args="(const FieldAXPY &amp;faxpy)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&lt;Field&gt;&amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&lt; UnparametricField&lt; <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &gt; &gt; &amp;&#160;</td>
          <td class="paramname"><em>faxpy</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Assignment operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">faxpy</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a719946bfb97c4c44d1b123ef4be463b2"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::mulacc" ref="a719946bfb97c4c44d1b123ef4be463b2" args="(const Element &amp;a, const Element1 &amp;x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Element&amp; mulacc </td>
          <td>(</td>
          <td class="paramtype">const Element &amp;&#160;</td>
          <td class="paramname"><em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Element1 &amp;&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add a*x to y y += a*x. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">a</td><td>constant reference to element a </td></tr>
    <tr><td class="paramname">x</td><td>constant reference to element x allow optimal multiplication, such as integer * int </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afbfef52c4fbdc26d05aebbcffe26269a"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::get" ref="afbfef52c4fbdc26d05aebbcffe26269a" args="(Element &amp;y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Element&amp; get </td>
          <td>(</td>
          <td class="paramtype">Element &amp;&#160;</td>
          <td class="paramname"><em>y</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Retrieve y. </p>
<p>Performs the delayed modding out if necessary </p>

</div>
</div>
<a class="anchor" id="a3d6e9eaed45864b2bfc95c0cfc9b2c3d"></a><!-- doxytag: member="LinBox::FieldAXPY&lt; UnparametricField&lt; integer &gt; &gt;::assign" ref="a3d6e9eaed45864b2bfc95c0cfc9b2c3d" args="(const Element &amp;y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_field_a_x_p_y.html">FieldAXPY</a>&amp; assign </td>
          <td>(</td>
          <td class="paramtype">const Element &amp;&#160;</td>
          <td class="paramname"><em>y</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Assign method. </p>
<p>Stores new field element for arithmetic. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to self </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">y</td><td>constant reference to element a </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>field/unparametric.h</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>