<!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: Companion< _Field > Struct 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="struct_lin_box_1_1_companion.html">Companion</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">Companion< _Field > Struct Template Reference<div class="ingroups"><a class="el" href="group__blackbox.html">blackbox</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::Companion" --><!-- doxytag: inherits="LinBox::TriplesBB" --> <p>Companion matrix of a monic polynomial. <a href="struct_lin_box_1_1_companion.html#details">More...</a></p> <p><code>#include <companion.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 Companion< _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="struct_lin_box_1_1_companion.png" usemap="#Companion< _Field >_map" alt=""/> <map id="Companion< _Field >_map" name="Companion< _Field >_map"> <area href="class_lin_box_1_1_triples_b_b.html" title="wrapper for NAG Sparse Matrix format." alt="TriplesBB< _Field >" shape="rect" coords="0,56,134,80"/> <area href="class_lin_box_1_1_blackbox_interface.html" title="This blackbox base class exists solely to aid documentation organization." alt="BlackboxInterface" shape="rect" coords="0,0,134,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="memTemplParams" colspan="2"><a class="anchor" id="a2c06be324373026c1a1c34c99ebd161f"></a><!-- doxytag: member="LinBox::Companion::Companion" ref="a2c06be324373026c1a1c34c99ebd161f" args="(const Field &F=Field(), const Polynomial &P=Polynomial(1))" --> template<class Polynomial > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_companion.html#a2c06be324373026c1a1c34c99ebd161f">Companion</a> (const Field &F=Field(), const Polynomial &P=Polynomial(1))</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This is the n by n companion matrix of a given polynomial of degree n. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_companion.html#ab7f4d5d99b00d3cea2618b6363ddd086">Companion</a> (const Field &F, size_t n, typename Field::RandIter r)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This constructs a random companion matrix. <a href="#ab7f4d5d99b00d3cea2618b6363ddd086"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0b641b0cd01ce37423a322dcb6d45e4"></a><!-- doxytag: member="LinBox::Companion::_values" ref="aa0b641b0cd01ce37423a322dcb6d45e4" args="" --> std::vector< Element > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_triples_b_b.html#aa0b641b0cd01ce37423a322dcb6d45e4">_values</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">_values contains the nonzero elements of the BlackBox <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9493694993eb27edc07f4e13b83381f1"></a><!-- doxytag: member="LinBox::Companion::_RowV" ref="a9493694993eb27edc07f4e13b83381f1" args="" --> std::vector< size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_triples_b_b.html#a9493694993eb27edc07f4e13b83381f1">_RowV</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">_RowV & _ColV are vectors containing the row & column indices <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea55d6dbc2592bf4a4fd448f3460baa0"></a><!-- doxytag: member="LinBox::Companion::_rows" ref="aea55d6dbc2592bf4a4fd448f3460baa0" args="" --> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_triples_b_b.html#aea55d6dbc2592bf4a4fd448f3460baa0">_rows</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of rows, columns. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<class _Field><br/> struct LinBox::Companion< _Field ></h3> <p>Companion matrix of a monic polynomial. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ab7f4d5d99b00d3cea2618b6363ddd086"></a><!-- doxytag: member="LinBox::Companion::Companion" ref="ab7f4d5d99b00d3cea2618b6363ddd086" args="(const Field &F, size_t n, typename Field::RandIter r)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="struct_lin_box_1_1_companion.html">Companion</a> </td> <td>(</td> <td class="paramtype">const Field & </td> <td class="paramname"><em>F</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">typename Field::RandIter </td> <td class="paramname"><em>r</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>This constructs a random companion matrix. </p> <p>Builds n by n matrix from degree n monic poly with other coefficients random. </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>companion.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>