<!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: ElementEnvelope< Field > 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 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_envelope.html">ElementEnvelope</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">ElementEnvelope< Field > Class Template Reference<div class="ingroups"><a class="el" href="group__element.html">element</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::ElementEnvelope" --><!-- doxytag: inherits="LinBox::ElementAbstract" -->
<p>Adaptor from archetypical interface to abstract interface, a technicality.
<a href="class_lin_box_1_1_element_envelope.html#details">More...</a></p>
<p><code>#include <envelope.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 ElementEnvelope< Field >:</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_element_envelope.png" usemap="#ElementEnvelope< Field >_map" alt=""/>
<map id="ElementEnvelope< Field >_map" name="ElementEnvelope< Field >_map">
<area href="class_lin_box_1_1_element_abstract.html" title="Abstract element base class, a technicality." alt="ElementAbstract" shape="rect" coords="0,0,161,24"/>
</map>
</div></div>
<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"><a class="anchor" id="a7ea944aa3a943ed47b7b7aed2dd48645"></a><!-- doxytag: member="LinBox::ElementEnvelope::ElementEnvelope" ref="a7ea944aa3a943ed47b7b7aed2dd48645" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_envelope.html#a7ea944aa3a943ed47b7b7aed2dd48645">ElementEnvelope</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <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_envelope.html#a80876046f1d7962a837c0931abf71bca">ElementEnvelope</a> (const typename Field::Element &elem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from the Field element to be wrapped. <a href="#a80876046f1d7962a837c0931abf71bca"></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_envelope.html#ad704d0004e04f78606e4f8c71ec5c155">ElementEnvelope</a> (const <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> &E)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ad704d0004e04f78606e4f8c71ec5c155"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_envelope.html#a8d300bce06c61a9c6951bf97ba9f6a82">clone</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual copy constructor. <a href="#a8d300bce06c61a9c6951bf97ba9f6a82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_envelope.html#a7f374e8c7ab589d504c45b04411b4b8e">operator=</a> (const <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> &E)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a7f374e8c7ab589d504c45b04411b4b8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a663276af871f340f08df9403a47a2c47"></a><!-- doxytag: member="LinBox::ElementEnvelope::~ElementEnvelope" ref="a663276af871f340f08df9403a47a2c47" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_element_envelope.html#a663276af871f340f08df9403a47a2c47">~ElementEnvelope</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Field><br/>
class LinBox::ElementEnvelope< Field ></h3>
<p>Adaptor from archetypical interface to abstract interface, a technicality. </p>
<p>A class meeting the interface specified in <a class="el" href="class_lin_box_1_1_element_archetype.html" title="Field and Ring element interface specification and archetypical instance class.">ElementArchetype</a> is adapted to be a child class of <a class="el" href="class_lin_box_1_1_element_abstract.html" title="Abstract element base class, a technicality.">ElementAbstract</a>. A concrete instance of <a class="el" href="class_lin_box_1_1_element_archetype.html" title="Field and Ring element interface specification and archetypical instance class.">ElementArchetype</a> representing the adapted class can then be constructed.</p>
<p>All this is in support of the <a class="el" href="class_lin_box_1_1_field_archetype.html" title="field specification and archetypical instance.">FieldArchetype</a> system. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a80876046f1d7962a837c0931abf71bca"></a><!-- doxytag: member="LinBox::ElementEnvelope::ElementEnvelope" ref="a80876046f1d7962a837c0931abf71bca" args="(const typename Field::Element &elem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_envelope.html">ElementEnvelope</a> </td>
<td>(</td>
<td class="paramtype">const typename Field::Element & </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from the Field element to be wrapped. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>Field element object to be wrapped. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad704d0004e04f78606e4f8c71ec5c155"></a><!-- doxytag: member="LinBox::ElementEnvelope::ElementEnvelope" ref="ad704d0004e04f78606e4f8c71ec5c155" args="(const ElementAbstract &E)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_envelope.html">ElementEnvelope</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> & </td>
<td class="paramname"><em>E</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>Constructs <a class="el" href="class_lin_box_1_1_element_envelope.html" title="Adaptor from archetypical interface to abstract interface, a technicality.">ElementEnvelope</a> object by copying the element it wraps. This is required to allow element objects to be passed by value into functions. In this implementation, this means copying the element <code>E._elem</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">E</td><td><a class="el" href="class_lin_box_1_1_field_envelope.html" title="Derived class used to implement the field archetypeHelps to minimize code bloat.">FieldEnvelope</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8d300bce06c61a9c6951bf97ba9f6a82"></a><!-- doxytag: member="LinBox::ElementEnvelope::clone" ref="a8d300bce06c61a9c6951bf97ba9f6a82" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a>* clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual copy constructor. </p>
<p>Required because constructors cannot be virtual. Passes construction on to derived classes. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to new element object in dynamic memory. </dd></dl>
<p>Implements <a class="el" href="class_lin_box_1_1_element_abstract.html#a9cfe9cc5e7da214909b7341c03a82d1e">ElementAbstract</a>.</p>
</div>
</div>
<a class="anchor" id="a7f374e8c7ab589d504c45b04411b4b8e"></a><!-- doxytag: member="LinBox::ElementEnvelope::operator=" ref="a7f374e8c7ab589d504c45b04411b4b8e" args="(const ElementAbstract &E)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> & </td>
<td class="paramname"><em>E</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </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">E</td><td>parameterized field base element </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lin_box_1_1_element_abstract.html#a90f263e3fd7580a574629ac995d12e69">ElementAbstract</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>element/envelope.h</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>
