<!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: ElementArchetype 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_element_archetype.html">ElementArchetype</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">ElementArchetype Class Reference<div class="ingroups"><a class="el" href="group__element.html">element</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::ElementArchetype" -->
<p>Field and Ring element interface specification and archetypical instance class.
<a href="class_lin_box_1_1_element_archetype.html#details">More...</a></p>
<p><code>#include <archetype.h></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Common Object Interface for LinBox Field elements.</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These methods are required of all <a class="el" href="namespace_lin_box.html">LinBox</a> <a class="el" href="group___fields.html">field</a> elements. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_archetype.html#aa08fecd3c30386cd891457179f0f9915">ElementArchetype</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aa08fecd3c30386cd891457179f0f9915"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_archetype.html#a60b9b1cb9c589fcbedf23fca7c9e2523">ElementArchetype</a> (const <a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a60b9b1cb9c589fcbedf23fca7c9e2523"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_archetype.html#a09b961ecff00b5a620a6dee63e7bfb24">~ElementArchetype</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a09b961ecff00b5a620a6dee63e7bfb24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_archetype.html#ace394921e2e66f3a3792006257e6bf91">operator=</a> (const <a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ace394921e2e66f3a3792006257e6bf91"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Implementation-Specific Methods.</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These methods are not required of all <a class="el" href="namespace_lin_box.html" title="Namespace in which all linbox code resides.">LinBox</a> field elements and are included only for this implementation of the archetype. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_archetype.html#abca0f24d96e26e9afcd1089fa1dc0d3a">ElementArchetype</a> (<a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> *elem_ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#abca0f24d96e26e9afcd1089fa1dc0d3a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Field and Ring element interface specification and archetypical instance class. </p>
<p>Element classes must contain public default constructor, copy constructor, assignment operator, and destructor. Note that primitive types such as int and double meet this specification.</p>
<p>In particular, the copy constructor is used to allow elements to be passed by value to a function.</p>
<p>Note that the documentation below of the specific methods, describes them as implemented in the archetypic element class. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa08fecd3c30386cd891457179f0f9915"></a><!-- doxytag: member="LinBox::ElementArchetype::ElementArchetype" ref="aa08fecd3c30386cd891457179f0f9915" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>This constructor is required to allow <a class="el" href="group___fields.html">field</a> elements to be primitive <code>C++</code> types. Because constructor does not know what <a class="el" href="group___fields.html">field</a> the element belongs to, it cannot actually construct the element. In this implementation, the constructor it sets <code>_elem_ptr</code> to the null pointer. Initialization of the element is done through the field function init where the field is known. </p>
</div>
</div>
<a class="anchor" id="a60b9b1cb9c589fcbedf23fca7c9e2523"></a><!-- doxytag: member="LinBox::ElementArchetype::ElementArchetype" ref="a60b9b1cb9c589fcbedf23fca7c9e2523" args="(const ElementArchetype &a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>This constructor is required to allow <a class="el" href="group___fields.html">field</a> elements to be primitive C++ types, and to allow field elements to be passed by value into functions. Constructs <a class="el" href="group___fields.html">field</a> element by copying the <a class="el" href="group___fields.html">field</a> element. In this implementation, this means copying the element to which <code>a._elem_ptr</code> points. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>field element. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09b961ecff00b5a620a6dee63e7bfb24"></a><!-- doxytag: member="LinBox::ElementArchetype::~ElementArchetype" ref="a09b961ecff00b5a620a6dee63e7bfb24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>In this implementation, this destroys element by deleting field element to which <code>_elem_ptr</code> points. </p>
</div>
</div>
<a class="anchor" id="abca0f24d96e26e9afcd1089fa1dc0d3a"></a><!-- doxytag: member="LinBox::ElementArchetype::ElementArchetype" ref="abca0f24d96e26e9afcd1089fa1dc0d3a" args="(ElementAbstract *elem_ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> * </td>
<td class="paramname"><em>elem_ptr</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Constructs field element from pointer to <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> Not part of the interface. Creates new copy of element object in dynamic memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">elem_ptr</td><td>pointer to <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ace394921e2e66f3a3792006257e6bf91"></a><!-- doxytag: member="LinBox::ElementArchetype::operator=" ref="ace394921e2e66f3a3792006257e6bf91" args="(const ElementArchetype &a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_element_archetype.html">ElementArchetype</a> & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Assigns element a to element. In this implementation, this is done by copying field element to which <code>_elem_ptr</code> points. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>field 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="element_2archetype_8h.html">element/archetype.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>
