<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>MPQC: sc::SCMatrixKit 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.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1SCMatrixKit.html">SCMatrixKit</a> </div> </div> <div class="contents"> <h1>sc::SCMatrixKit Class Reference</h1><!-- doxytag: class="sc::SCMatrixKit" --><!-- doxytag: inherits="sc::DescribedClass" -->The <a class="el" href="classsc_1_1SCMatrixKit.html" title="The SCMatrixKit abstract class acts as a factory for producing matrices.">SCMatrixKit</a> abstract class acts as a factory for producing matrices. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="abstract_8h_source.html">abstract.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for sc::SCMatrixKit:</div> <div class="dynsection"> <p><center><img src="classsc_1_1SCMatrixKit.png" usemap="#sc::SCMatrixKit_map" border="0" alt=""></center> <map name="sc::SCMatrixKit_map"> <area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="138,112,266,136"> <area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="138,56,266,80"> <area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="138,0,266,24"> <area href="classsc_1_1DistSCMatrixKit.html" alt="sc::DistSCMatrixKit" shape="rect" coords="0,224,128,248"> <area href="classsc_1_1LocalSCMatrixKit.html" alt="sc::LocalSCMatrixKit" shape="rect" coords="138,224,266,248"> <area href="classsc_1_1ReplSCMatrixKit.html" alt="sc::ReplSCMatrixKit" shape="rect" coords="276,224,404,248"> </map> </div> <p> <a href="classsc_1_1SCMatrixKit-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46c989709b5371b77f4ec0624dc9c54f"></a><!-- doxytag: member="sc::SCMatrixKit::SCMatrixKit" ref="46c989709b5371b77f4ec0624dc9c54f" args="(const Ref< KeyVal > &)" --> </td><td class="memItemRight" valign="bottom"><b>SCMatrixKit</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72ffe3cffbb853206336a15a7c082ae0"></a><!-- doxytag: member="sc::SCMatrixKit::messagegrp" ref="72ffe3cffbb853206336a15a7c082ae0" args="() const " --> <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MessageGrp.html">MessageGrp</a> > </td><td class="memItemRight" valign="bottom"><b>messagegrp</b> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab3d81517b5374d90e8f980fb094ddd4"></a><!-- doxytag: member="sc::SCMatrixKit::matrix" ref="ab3d81517b5374d90e8f980fb094ddd4" args="(const RefSCDimension &, const RefSCDimension &)=0" --> virtual <a class="el" href="classsc_1_1SCMatrix.html">SCMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCMatrixKit.html#ab3d81517b5374d90e8f980fb094ddd4">matrix</a> (const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Given the dimensions, create matrices or vectors. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e10af4ca3580cf28cb0c012d5975986d"></a><!-- doxytag: member="sc::SCMatrixKit::symmmatrix" ref="e10af4ca3580cf28cb0c012d5975986d" args="(const RefSCDimension &)=0" --> virtual <a class="el" href="classsc_1_1SymmSCMatrix.html">SymmSCMatrix</a> * </td><td class="memItemRight" valign="bottom"><b>symmmatrix</b> (const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)=0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15b100ba1f4512d91c923277e89f8e7d"></a><!-- doxytag: member="sc::SCMatrixKit::diagmatrix" ref="15b100ba1f4512d91c923277e89f8e7d" args="(const RefSCDimension &)=0" --> virtual <a class="el" href="classsc_1_1DiagSCMatrix.html">DiagSCMatrix</a> * </td><td class="memItemRight" valign="bottom"><b>diagmatrix</b> (const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)=0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36823d287c701e8f61c63300a21a11b9"></a><!-- doxytag: member="sc::SCMatrixKit::vector" ref="36823d287c701e8f61c63300a21a11b9" args="(const RefSCDimension &)=0" --> virtual <a class="el" href="classsc_1_1SCVector.html">SCVector</a> * </td><td class="memItemRight" valign="bottom"><b>vector</b> (const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)=0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsc_1_1SCMatrix.html">SCMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCMatrixKit.html#7735126a2758963b894d67b8dfc8dc30">restore_matrix</a> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Given the dimensions and a <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> object, restore matrices or vectors. <a href="#7735126a2758963b894d67b8dfc8dc30"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c93ed63828fb06cfa2beb961ffa65845"></a><!-- doxytag: member="sc::SCMatrixKit::restore_symmmatrix" ref="c93ed63828fb06cfa2beb961ffa65845" args="(StateIn &, const RefSCDimension &)" --> <a class="el" href="classsc_1_1SymmSCMatrix.html">SymmSCMatrix</a> * </td><td class="memItemRight" valign="bottom"><b>restore_symmmatrix</b> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="441bce143ebbd663b6625c15be273f3f"></a><!-- doxytag: member="sc::SCMatrixKit::restore_diagmatrix" ref="441bce143ebbd663b6625c15be273f3f" args="(StateIn &, const RefSCDimension &)" --> <a class="el" href="classsc_1_1DiagSCMatrix.html">DiagSCMatrix</a> * </td><td class="memItemRight" valign="bottom"><b>restore_diagmatrix</b> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e80895d4903d34552553d1f7798f8ac4"></a><!-- doxytag: member="sc::SCMatrixKit::restore_vector" ref="e80895d4903d34552553d1f7798f8ac4" args="(StateIn &, const RefSCDimension &)" --> <a class="el" href="classsc_1_1SCVector.html">SCVector</a> * </td><td class="memItemRight" valign="bottom"><b>restore_vector</b> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &, const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> &)</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1SCMatrixKit.html">SCMatrixKit</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCMatrixKit.html#500fdd74c0483d5ec0a99102f241f884">default_matrixkit</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This returns a <a class="el" href="classsc_1_1LocalSCMatrixKit.html" title="The LocalSCMatrixKit produces matrices that work in a single processor environment...">LocalSCMatrixKit</a>, unless the default has been changed with set_default_matrixkit. <a href="#500fdd74c0483d5ec0a99102f241f884"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bde05611516ffc932a1c222f37222a15"></a><!-- doxytag: member="sc::SCMatrixKit::set_default_matrixkit" ref="bde05611516ffc932a1c222f37222a15" args="(const Ref< SCMatrixKit > &)" --> static void </td><td class="memItemRight" valign="bottom"><b>set_default_matrixkit</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1SCMatrixKit.html">SCMatrixKit</a> > &)</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e66d3a2a05f66748728f9a2ab0128b4"></a><!-- doxytag: member="sc::SCMatrixKit::grp_" ref="4e66d3a2a05f66748728f9a2ab0128b4" args="" --> <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MessageGrp.html">MessageGrp</a> > </td><td class="memItemRight" valign="bottom"><b>grp_</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The <a class="el" href="classsc_1_1SCMatrixKit.html" title="The SCMatrixKit abstract class acts as a factory for producing matrices.">SCMatrixKit</a> abstract class acts as a factory for producing matrices. <p> By using one of these, the program makes sure that all of the matrices are consistent. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="500fdd74c0483d5ec0a99102f241f884"></a><!-- doxytag: member="sc::SCMatrixKit::default_matrixkit" ref="500fdd74c0483d5ec0a99102f241f884" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classsc_1_1SCMatrixKit.html">SCMatrixKit</a>* sc::SCMatrixKit::default_matrixkit </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This returns a <a class="el" href="classsc_1_1LocalSCMatrixKit.html" title="The LocalSCMatrixKit produces matrices that work in a single processor environment...">LocalSCMatrixKit</a>, unless the default has been changed with set_default_matrixkit. <p> </div> </div><p> <a class="anchor" name="7735126a2758963b894d67b8dfc8dc30"></a><!-- doxytag: member="sc::SCMatrixKit::restore_matrix" ref="7735126a2758963b894d67b8dfc8dc30" args="(StateIn &, const RefSCDimension &, const RefSCDimension &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classsc_1_1SCMatrix.html">SCMatrix</a>* sc::SCMatrixKit::restore_matrix </td> <td>(</td> <td class="paramtype"><a class="el" href="classsc_1_1StateIn.html">StateIn</a> & </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> & </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classsc_1_1RefSCDimension.html">RefSCDimension</a> & </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Given the dimensions and a <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> object, restore matrices or vectors. <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="abstract_8h_source.html">abstract.h</a></ul> </div> <hr> <address> <small> Generated at Wed Oct 14 14:12:15 2009 for <a href="http://www.mpqc.org">MPQC</a> 2.3.1 using the documentation package <a href="http://www.doxygen.org">Doxygen</a> 1.5.9. </small> </address> </body> </html>