<!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: SparseMatrixFactory< Field, BElement, Row, BRow > 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_sparse_matrix_factory.html">SparseMatrixFactory</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">SparseMatrixFactory< Field, BElement, Row, BRow > Class Template Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::SparseMatrixFactory" --><!-- doxytag: inherits="BlackboxFactory< Field, SparseMatrix< Field, Row > >" --> <p>Sparse matrix factory This class inherits <a class="el" href="class_lin_box_1_1_blackbox_factory.html">BlackboxFactory</a> and provides a method for using a <a class="el" href="class_lin_box_1_1_sparse_matrix_base.html">SparseMatrixBase</a> object with integer or rational data type as input to the high-level integer and rational solutions functions. <a href="class_lin_box_1_1_sparse_matrix_factory.html#details">More...</a></p> <p><code>#include <sparse.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 SparseMatrixFactory< Field, BElement, Row, BRow >:</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_sparse_matrix_factory.png" usemap="#SparseMatrixFactory< Field, BElement, Row, BRow >_map" alt=""/> <map id="SparseMatrixFactory< Field, BElement, Row, BRow >_map" name="SparseMatrixFactory< Field, BElement, Row, BRow >_map"> <area href="class_lin_box_1_1_blackbox_factory.html" alt="BlackboxFactory< Field, SparseMatrix< Field, Row > >" shape="rect" coords="0,0,328,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="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_sparse_matrix_factory.html#ab52f6f680745849ad98acd831593552b">maxNorm</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &res)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return the max-norm of the matrix. <a href="#ab52f6f680745849ad98acd831593552b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a290134f7b92a965f34c42a0c6c17e946"></a><!-- doxytag: member="LinBox::SparseMatrixFactory::rowdim" ref="a290134f7b92a965f34c42a0c6c17e946" args="()" --> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_sparse_matrix_factory.html#a290134f7b92a965f34c42a0c6c17e946">rowdim</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Give the row dimension of the matrix. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2f1215779e18401bd65b93c46f48149"></a><!-- doxytag: member="LinBox::SparseMatrixFactory::coldim" ref="ab2f1215779e18401bd65b93c46f48149" args="()" --> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_sparse_matrix_factory.html#ab2f1215779e18401bd65b93c46f48149">coldim</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Give the column dimension of the matrix. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58ab9bdb29e7fea1c18e7af2d7ba9a0b"></a><!-- doxytag: member="LinBox::SparseMatrixFactory::hadamardBound" ref="a58ab9bdb29e7fea1c18e7af2d7ba9a0b" args="(integer &res) const " --> <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_sparse_matrix_factory.html#a58ab9bdb29e7fea1c18e7af2d7ba9a0b">hadamardBound</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &res) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return the hadamard bound of the matrxi. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lin_box_1_1_sparse_matrix.html">SparseMatrix</a>< Field, <br class="typebreak"/> Row > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_blackbox_factory.html#aec963a3de8c6b312665f9ed973c60992">makeBlackbox</a> (const Field &F)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Given a field and vector type, construct a black box for the matrix over that field and using that vector type. <a href="#aec963a3de8c6b312665f9ed973c60992"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<class Field, class BElement = typename Field::Element, class Row = typename LinBox::Vector<Field>::Sparse, class BRow = typename LinBox::RawVector<BElement>::Sparse><br/> class LinBox::SparseMatrixFactory< Field, BElement, Row, BRow ></h3> <p>Sparse matrix factory This class inherits <a class="el" href="class_lin_box_1_1_blackbox_factory.html">BlackboxFactory</a> and provides a method for using a <a class="el" href="class_lin_box_1_1_sparse_matrix_base.html">SparseMatrixBase</a> object with integer or rational data type as input to the high-level integer and rational solutions functions. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab52f6f680745849ad98acd831593552b"></a><!-- doxytag: member="LinBox::SparseMatrixFactory::maxNorm" ref="ab52f6f680745849ad98acd831593552b" args="(integer &res)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>& maxNorm </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td> <td class="paramname"><em>res</em></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Compute and return the max-norm of the matrix. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">res</td><td>Place to store result </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_lin_box_1_1_blackbox_factory.html#a64490df2a5658e7d49ffa6868480335f">BlackboxFactory< Field, SparseMatrix< Field, Row > ></a>.</p> </div> </div> <a class="anchor" id="aec963a3de8c6b312665f9ed973c60992"></a><!-- doxytag: member="LinBox::SparseMatrixFactory::makeBlackbox" ref="aec963a3de8c6b312665f9ed973c60992" args="(const Field &F)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="class_lin_box_1_1_sparse_matrix.html">SparseMatrix</a>< Field, Row > * makeBlackbox </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> & </td> <td class="paramname"><em>F</em></td><td>)</td> <td><code> [pure virtual, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Given a field and vector type, construct a black box for the matrix over that field and using that vector type. </p> <p>This should be implemented by the user </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">F</td><td>Field over which to construct the black box </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>blackbox/sparse.h</li> <li>blackbox/sparse.inl</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>