Sophie

Sophie

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

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: GivaroMontg Class 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_givaro_montg.html">GivaroMontg</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">GivaroMontg Class Reference<div class="ingroups"><a class="el" href="group__field.html">field</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::GivaroMontg" --><!-- doxytag: inherits="LinBox::FieldInterface" -->
<p>wrapper of Givaro's ::Givaro::Montgomery&lt; ::Givaro::Std32&gt;.  
 <a href="class_lin_box_1_1_givaro_montg.html#details">More...</a></p>

<p><code>#include &lt;givaro-montg.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 GivaroMontg:</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_givaro_montg.png" usemap="#GivaroMontg_map" alt=""/>
  <map id="GivaroMontg_map" name="GivaroMontg_map">
<area href="class_lin_box_1_1_field_interface.html" title="This field base class exists solely to aid documentation organization." alt="FieldInterface" shape="rect" coords="0,0,90,24"/>
</map>
 </div></div>
<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">typedef ::Givaro::Montgomery<br class="typebreak"/>
&lt; ::Givaro::Std32 &gt;::Rep&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Element type.  <a href="#af4fa119f8eeb367b75d89052a34f0c94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a778490827d7be5fd356d7d27a67ab5f1"></a><!-- doxytag: member="LinBox::GivaroMontg::RandIter" ref="a778490827d7be5fd356d7d27a67ab5f1" args="" -->
typedef ::Givaro::GIV_randIter<br class="typebreak"/>
&lt; ::Givaro::Montgomery<br class="typebreak"/>
&lt; ::Givaro::Std32 &gt;<br class="typebreak"/>
, <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">LinBox::integer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#a778490827d7be5fd356d7d27a67ab5f1">RandIter</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">RandIter type This type is inherited from the Givaro class ::Givaro::Montgomery&lt; ::Givaro::Std32&gt; <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"><a class="anchor" id="a1cb565684b3cfe2bfa67a695d091146b"></a><!-- doxytag: member="LinBox::GivaroMontg::GivaroMontg" ref="a1cb565684b3cfe2bfa67a695d091146b" args="(const integer &amp;p)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#a1cb565684b3cfe2bfa67a695d091146b">GivaroMontg</a> (const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;p)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from an integer this constructor use the ZpzDom&lt;TAG&gt; constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad848efc720627a47ebfd8ceca8f109ad"></a><!-- doxytag: member="LinBox::GivaroMontg::GivaroMontg" ref="ad848efc720627a47ebfd8ceca8f109ad" args="(const integer &amp;p, const integer &amp;k)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#ad848efc720627a47ebfd8ceca8f109ad">GivaroMontg</a> (const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;p, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;k)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from an integer (takes degree of extension as 2nd parameter, must be 1) this constructor use the ZpzDom&lt;TAG&gt; constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#aea4d4c3f059080408c3a6344cf9fff10">characteristic</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;c) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Characteristic.  <a href="#aea4d4c3f059080408c3a6344cf9fff10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#ade46ce0a344fcc718625a2296a8104ab">cardinality</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;c) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Cardinality.  <a href="#ade46ce0a344fcc718625a2296a8104ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#a59892db11d283587e8b9e3656f0c6f7f">init</a> (<a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a> &amp;x, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;y=0) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization of field base Element from an integer.  <a href="#a59892db11d283587e8b9e3656f0c6f7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_montg.html#ac4bb2576b5123c8fde1fab6165264ec3">convert</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;x, const <a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a> &amp;y) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion of field base element to an integer.  <a href="#ac4bb2576b5123c8fde1fab6165264ec3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>wrapper of Givaro's ::Givaro::Montgomery&lt; ::Givaro::Std32&gt;. </p>
<p>This class is a modular representation with a ::Givaro::Montgomery reduction </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="af4fa119f8eeb367b75d89052a34f0c94"></a><!-- doxytag: member="LinBox::GivaroMontg::Element" ref="af4fa119f8eeb367b75d89052a34f0c94" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef ::Givaro::Montgomery&lt; ::Givaro::Std32&gt;::Rep <a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Element type. </p>
<p>This type is inherited from the Givaro class ::Givaro::Montgomery&lt; ::Givaro::Std32&gt; </p>

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

<p>Characteristic. </p>
<p>Return integer representing characteristic of the domain. Returns a positive integer to all domains with finite characteristic, and returns 0 to signify a domain of infinite characteristic. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer representing characteristic of the domain. </dd></dl>

</div>
</div>
<a class="anchor" id="ade46ce0a344fcc718625a2296a8104ab"></a><!-- doxytag: member="LinBox::GivaroMontg::cardinality" ref="ade46ce0a344fcc718625a2296a8104ab" args="(integer &amp;c) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>&amp; cardinality </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Cardinality. </p>
<p>Return integer representing cardinality of the domain. Returns a non-negative integer for all domains with finite cardinality, and returns -1 to signify a domain of infinite cardinality. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer representing cardinality of the domain </dd></dl>

</div>
</div>
<a class="anchor" id="a59892db11d283587e8b9e3656f0c6f7f"></a><!-- doxytag: member="LinBox::GivaroMontg::init" ref="a59892db11d283587e8b9e3656f0c6f7f" args="(Element &amp;x, const integer &amp;y=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a>&amp; init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a> &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td>
          <td class="paramname"><em>y</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialization of field base Element from an integer. </p>
<p>Behaves like C++ allocator construct. This function assumes the output field base Element x has already been constructed, but that it is not already initialized. We assume that the type of Element is short int. this methos is just a simple cast. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to field base Element. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>field base Element to contain output (reference returned). </td></tr>
    <tr><td class="paramname">y</td><td>integer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac4bb2576b5123c8fde1fab6165264ec3"></a><!-- doxytag: member="LinBox::GivaroMontg::convert" ref="ac4bb2576b5123c8fde1fab6165264ec3" args="(integer &amp;x, const Element &amp;y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>&amp; convert </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_lin_box_1_1_givaro_montg.html#af4fa119f8eeb367b75d89052a34f0c94">Element</a> &amp;&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Conversion of field base element to an integer. </p>
<p>This function assumes the output field base element x has already been constructed, but that it is not already initialized. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to an integer. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>integer to contain output (reference returned). </td></tr>
    <tr><td class="paramname">y</td><td>constant field base element. </td></tr>
  </table>
  </dd>
</dl>

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