<!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: GivaroGfq 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 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_givaro_gfq.html">GivaroGfq</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">GivaroGfq Class Reference<div class="ingroups"><a class="el" href="group__field.html">field</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::GivaroGfq" --><!-- doxytag: inherits="LinBox::FieldInterface" --> <p>Wrapper of Givaro's GFqDom<int32_t> class. <a href="class_lin_box_1_1_givaro_gfq.html#details">More...</a></p> <p><code>#include <givaro-gfq.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 GivaroGfq:</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_gfq.png" usemap="#GivaroGfq_map" alt=""/> <map id="GivaroGfq_map" name="GivaroGfq_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::GFqDom<br class="typebreak"/> < int32_t >::Rep </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Element type. <a href="#af386be7b5a14856c41338de4e180f30b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9b389f9b14b750ba305465f461faa11"></a><!-- doxytag: member="LinBox::GivaroGfq::RandIter" ref="aa9b389f9b14b750ba305465f461faa11" args="" --> typedef ::Givaro::GIV_randIter<br class="typebreak"/> < ::Givaro::GFqDom< int32_t ><br class="typebreak"/> , <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">LinBox::integer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#aa9b389f9b14b750ba305465f461faa11">RandIter</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">RandIter type This type is inherited from the Givaro class GFqDom<TAG> <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="a8f54470d8f093e640b7ea09992fbf75a"></a><!-- doxytag: member="LinBox::GivaroGfq::GivaroGfq" ref="a8f54470d8f093e640b7ea09992fbf75a" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#a8f54470d8f093e640b7ea09992fbf75a">GivaroGfq</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Empty Constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a469417550d95773687ca1e7aaa7206f0"></a><!-- doxytag: member="LinBox::GivaroGfq::GivaroGfq" ref="a469417550d95773687ca1e7aaa7206f0" args="(const integer &p, const integer &k=1)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#a469417550d95773687ca1e7aaa7206f0">GivaroGfq</a> (const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &p, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &k=1)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from an integer this constructor use the ZpzDom<TAG> constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#aea4d4c3f059080408c3a6344cf9fff10">characteristic</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &c) const </td></tr> <tr><td class="mdescLeft"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#ade46ce0a344fcc718625a2296a8104ab">cardinality</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &c) const </td></tr> <tr><td class="mdescLeft"> </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_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#a59892db11d283587e8b9e3656f0c6f7f">init</a> (<a class="el" href="class_lin_box_1_1_givaro_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a> &x, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &y=0) const </td></tr> <tr><td class="mdescLeft"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#ac4bb2576b5123c8fde1fab6165264ec3">convert</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &x, const <a class="el" href="class_lin_box_1_1_givaro_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a> &y) const </td></tr> <tr><td class="mdescLeft"> </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 GFqDom<int32_t> class. </p> <p>This class allows to construct only extension fields with a prime characteristic. </p> </div><hr/><h2>Member Typedef Documentation</h2> <a class="anchor" id="af386be7b5a14856c41338de4e180f30b"></a><!-- doxytag: member="LinBox::GivaroGfq::Element" ref="af386be7b5a14856c41338de4e180f30b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef ::Givaro::GFqDom<int32_t>::Rep <a class="el" href="class_lin_box_1_1_givaro_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a></td> </tr> </table> </div> <div class="memdoc"> <p>Element type. </p> <p>This type is inherited from the Givaro class GFqDom<int32_t> </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aea4d4c3f059080408c3a6344cf9fff10"></a><!-- doxytag: member="LinBox::GivaroGfq::characteristic" ref="aea4d4c3f059080408c3a6344cf9fff10" args="(integer &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>& characteristic </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </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::GivaroGfq::cardinality" ref="ade46ce0a344fcc718625a2296a8104ab" args="(integer &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>& cardinality </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </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::GivaroGfq::init" ref="a59892db11d283587e8b9e3656f0c6f7f" args="(Element &x, const integer &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_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a>& init </td> <td>(</td> <td class="paramtype"><a class="el" href="class_lin_box_1_1_givaro_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a> & </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> & </td> <td class="paramname"><em>y</em> = <code>0</code> </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::GivaroGfq::convert" ref="ac4bb2576b5123c8fde1fab6165264ec3" args="(integer &x, const Element &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>& convert </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </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_gfq.html#af386be7b5a14856c41338de4e180f30b">Element</a> & </td> <td class="paramname"><em>y</em> </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><a class="el" href="givaro-gfq_8h.html">givaro-gfq.h</a></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>