<!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: Inverse< Blackbox > 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_inverse.html">Inverse</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">Inverse< Blackbox > Class Template Reference<div class="ingroups"><a class="el" href="group__blackbox.html">blackbox</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::Inverse" --><!-- doxytag: inherits="LinBox::BlackboxInterface" --> <p>A Blackbox for the inverse. <a href="class_lin_box_1_1_inverse.html#details">More...</a></p> <p><code>#include <inverse.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 Inverse< Blackbox >:</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_inverse.png" usemap="#Inverse< Blackbox >_map" alt=""/> <map id="Inverse< Blackbox >_map" name="Inverse< Blackbox >_map"> <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,129,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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#aa89c2a6758d4cfb47840c02553649b3b">Inverse</a> (const Blackbox *BB)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from field and dense vector of field elements. <a href="#aa89c2a6758d4cfb47840c02553649b3b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a154a7701c1c9a6f90f37779c9b4adb58"></a><!-- doxytag: member="LinBox::Inverse::Inverse" ref="a154a7701c1c9a6f90f37779c9b4adb58" args="(const Inverse &BB)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#a154a7701c1c9a6f90f37779c9b4adb58">Inverse</a> (const <a class="el" href="class_lin_box_1_1_inverse.html">Inverse</a> &BB)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor, so that we don't have to recompute the minimal polynomial every time this black box is used inside another black box. <br/></td></tr> <tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#aa37d57c030b1db0c198478268aa3cc15">apply</a> (OutVector &y, const InVector &x) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox matrix. <a href="#aa37d57c030b1db0c198478268aa3cc15"></a><br/></td></tr> <tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#ac1a9817268900b78faa5a6eb17d9badf">applyTranspose</a> (OutVector &y, const InVector &x) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox matrix transpose. <a href="#ac1a9817268900b78faa5a6eb17d9badf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#a09202c1aaa6c5a4c8e69a2339a27bcfe">rowdim</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retreive row dimensions of BlackBox matrix. <a href="#a09202c1aaa6c5a4c8e69a2339a27bcfe"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_inverse.html#a63d5df22c5024e979e3462155d0fe814">coldim</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retreive column dimensions of BlackBox matrix. <a href="#a63d5df22c5024e979e3462155d0fe814"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<class Blackbox><br/> class LinBox::Inverse< Blackbox ></h3> <p>A Blackbox for the inverse. </p> <p>Not efficient if many applications are used.</p> <p>The matrix itself is not stored in memory. Rather, its apply methods use a vector of <a class="el" href="group___fields.html">field</a> elements, which are used to "multiply" the matrix to a vector.</p> <p>This class has three template parameters. The first is the field in which the arithmetic is to be done. The second is the type of <a class="el" href="namespace_lin_box.html">LinBox</a> vector to which to apply the matrix. The third is chosen be default to be the <a class="el" href="namespace_lin_box.html">LinBox</a> vector trait of the vector. This class is then specialized for dense and sparse vectors.</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">Field</td><td><a class="el" href="namespace_lin_box.html">LinBox</a> field </td></tr> <tr><td class="paramname">Vector</td><td><a class="el" href="namespace_lin_box.html">LinBox</a> dense or sparse vector of field elements </td></tr> <tr><td class="paramname">Trait</td><td>Marker whether to use dense or sparse <a class="el" href="namespace_lin_box.html" title="Namespace in which all linbox code resides.">LinBox</a> vector implementation. This is chosen by a default parameter and partial template specialization. </td></tr> </table> </dd> </dl> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa89c2a6758d4cfb47840c02553649b3b"></a><!-- doxytag: member="LinBox::Inverse::Inverse" ref="aa89c2a6758d4cfb47840c02553649b3b" args="(const Blackbox *BB)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_lin_box_1_1_inverse.html">Inverse</a> </td> <td>(</td> <td class="paramtype">const Blackbox * </td> <td class="paramname"><em>BB</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor from field and dense vector of field elements. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">BB</td><td>Black box of which to get the inverse </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa37d57c030b1db0c198478268aa3cc15"></a><!-- doxytag: member="LinBox::Inverse::apply" ref="aa37d57c030b1db0c198478268aa3cc15" args="(OutVector &y, const InVector &x) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OutVector& apply </td> <td>(</td> <td class="paramtype">OutVector & </td> <td class="paramname"><em>y</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const InVector & </td> <td class="paramname"><em>x</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Application of BlackBox matrix. </p> <p>y= A*x. Requires one vector conforming to the <a class="el" href="namespace_lin_box.html">LinBox</a> vector <a class="el" href="_archetypes.html">archetype</a>. Required by abstract base class. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>reference to vector y containing output. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">y</td><td>reference to vector into which to store the result </td></tr> <tr><td class="paramname">x</td><td>constant reference to vector to contain input </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ac1a9817268900b78faa5a6eb17d9badf"></a><!-- doxytag: member="LinBox::Inverse::applyTranspose" ref="ac1a9817268900b78faa5a6eb17d9badf" args="(OutVector &y, const InVector &x) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OutVector& applyTranspose </td> <td>(</td> <td class="paramtype">OutVector & </td> <td class="paramname"><em>y</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const InVector & </td> <td class="paramname"><em>x</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Application of BlackBox matrix transpose. </p> <p><img class="formulaInl" alt="$ y= A^t \cdot x.$" src="form_34.png"/> Requires one vector conforming to the <a class="el" href="namespace_lin_box.html">LinBox</a> vector <a class="el" href="_archetypes.html">archetype</a>. Required by abstract base class. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>reference to vector y containing output. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">x</td><td>constant reference to vector to contain input </td></tr> <tr><td class="paramname">y</td><td></td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a09202c1aaa6c5a4c8e69a2339a27bcfe"></a><!-- doxytag: member="LinBox::Inverse::rowdim" ref="a09202c1aaa6c5a4c8e69a2339a27bcfe" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t rowdim </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Retreive row dimensions of BlackBox matrix. </p> <p>This may be needed for applying preconditioners. Required by abstract base class. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>integer number of rows of black box matrix. </dd></dl> </div> </div> <a class="anchor" id="a63d5df22c5024e979e3462155d0fe814"></a><!-- doxytag: member="LinBox::Inverse::coldim" ref="a63d5df22c5024e979e3462155d0fe814" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t coldim </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Retreive column dimensions of BlackBox matrix. </p> <p>Required by abstract base class. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>integer number of columns of black box matrix. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>inverse.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>