Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 247b28499c443e092731ffba814075f2 > files > 188

mpqc-html-2.3.1-9mdv2010.0.i586.rpm

<!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::Convergence 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1Convergence.html">Convergence</a>
  </div>
</div>
<div class="contents">
<h1>sc::Convergence Class Reference</h1><!-- doxytag: class="sc::Convergence" --><!-- doxytag: inherits="sc::SavableState" -->The <a class="el" href="classsc_1_1Convergence.html" title="The Convergence class is used by the optimizer to determine when an optimization...">Convergence</a> class is used by the optimizer to determine when an optimization is converged.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="conv_8h_source.html">conv.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for sc::Convergence:</div>
<div class="dynsection">

<p><center><img src="classsc_1_1Convergence.png" usemap="#sc::Convergence_map" border="0" alt=""></center>
<map name="sc::Convergence_map">
<area href="classsc_1_1SavableState.html" alt="sc::SavableState" shape="rect" coords="0,168,120,192">
<area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="0,112,120,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,120,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,120,24">
</map>
</div>

<p>
<a href="classsc_1_1Convergence-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="2fd77b1d2234a0ba262b42d9f0848744"></a><!-- doxytag: member="sc::Convergence::Convergence" ref="2fd77b1d2234a0ba262b42d9f0848744" args="(double tolerance)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Convergence</b> (double tolerance)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bf6c40c09bf22735f9bfa83b2af99ce"></a><!-- doxytag: member="sc::Convergence::Convergence" ref="3bf6c40c09bf22735f9bfa83b2af99ce" args="(StateIn &amp;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Convergence</b> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Convergence.html#b73bd9dbc27e8432461feda149cecd55">Convergence</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> constructor reads the following keywords:.  <a href="#b73bd9dbc27e8432461feda149cecd55"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Convergence.html#e8bec2082bcf901efdf3fc7ec818c52d">save_data_state</a> (<a class="el" href="classsc_1_1StateOut.html">StateOut</a> &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> CTOR initializes them.  <a href="#e8bec2082bcf901efdf3fc7ec818c52d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d23fe1d934f3456533aa8e61c10d8bd"></a><!-- doxytag: member="sc::Convergence::get_grad" ref="3d23fe1d934f3456533aa8e61c10d8bd" args="(const Ref&lt; Function &gt; &amp;)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Convergence.html#3d23fe1d934f3456533aa8e61c10d8bd">get_grad</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1Function.html">Function</a> &gt; &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the current gradient and displacement. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0149bb29144d24175c3b7352de7a4cf"></a><!-- doxytag: member="sc::Convergence::get_x" ref="b0149bb29144d24175c3b7352de7a4cf" args="(const Ref&lt; Function &gt; &amp;)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_x</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1Function.html">Function</a> &gt; &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7b6f24c6fb3155f07f2ab11e4c13dee"></a><!-- doxytag: member="sc::Convergence::set_nextx" ref="b7b6f24c6fb3155f07f2ab11e4c13dee" args="(const RefSCVector &amp;)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_nextx</b> (const <a class="el" href="classsc_1_1RefSCVector.html">RefSCVector</a> &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="162eb9b666d370034fe5f70777f50296"></a><!-- doxytag: member="sc::Convergence::reset" ref="162eb9b666d370034fe5f70777f50296" args="()" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Convergence.html#162eb9b666d370034fe5f70777f50296">reset</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the current gradient and displacement to null. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f2cf4c9611aa287d843947aa5088025"></a><!-- doxytag: member="sc::Convergence::converged" ref="2f2cf4c9611aa287d843947aa5088025" args="()" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Convergence.html#2f2cf4c9611aa287d843947aa5088025">converged</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return nonzero if the optimization has converged. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8f056d9235d9f63b9c8352d7e66134b"></a><!-- doxytag: member="sc::Convergence::check_conv" ref="e8f056d9235d9f63b9c8352d7e66134b" args="(const char *heading, double val, double bound, int &amp;pass, int &amp;fail)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>check_conv</b> (const char *heading, double val, double bound, int &amp;pass, int &amp;fail)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43f9a8deb5f8dd33371c1921f32a69e2"></a><!-- doxytag: member="sc::Convergence::set_defaults" ref="43f9a8deb5f8dd33371c1921f32a69e2" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_defaults</b> ()</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="f4daef42d8569d763976e657bbef23a8"></a><!-- doxytag: member="sc::Convergence::grad_" ref="f4daef42d8569d763976e657bbef23a8" args="" -->
<a class="el" href="classsc_1_1RefSCVector.html">RefSCVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>grad_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c695eee193ac2eec26e75ec6584d2957"></a><!-- doxytag: member="sc::Convergence::x_" ref="c695eee193ac2eec26e75ec6584d2957" args="" -->
<a class="el" href="classsc_1_1RefSCVector.html">RefSCVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a6e7dcb248dbd80e4231691545fb9fc"></a><!-- doxytag: member="sc::Convergence::nextx_" ref="0a6e7dcb248dbd80e4231691545fb9fc" args="" -->
<a class="el" href="classsc_1_1RefSCVector.html">RefSCVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>nextx_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4106c612506a0b31569b40eaa0fe0c58"></a><!-- doxytag: member="sc::Convergence::use_max_disp_" ref="4106c612506a0b31569b40eaa0fe0c58" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_max_disp_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12b70afc2e4c364d5738814b4bb905d6"></a><!-- doxytag: member="sc::Convergence::max_disp_" ref="12b70afc2e4c364d5738814b4bb905d6" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_disp_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0543eedcabdfa3ee93083bedbe3417f"></a><!-- doxytag: member="sc::Convergence::use_max_grad_" ref="e0543eedcabdfa3ee93083bedbe3417f" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_max_grad_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5cb564fb4e195155abfb323dbfa4738"></a><!-- doxytag: member="sc::Convergence::max_grad_" ref="c5cb564fb4e195155abfb323dbfa4738" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_grad_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c0afa2a9f3fc0778bdb7040280ed42c"></a><!-- doxytag: member="sc::Convergence::use_rms_disp_" ref="8c0afa2a9f3fc0778bdb7040280ed42c" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_rms_disp_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b49f2dee6d97d5604699e7a589bc63b4"></a><!-- doxytag: member="sc::Convergence::rms_disp_" ref="b49f2dee6d97d5604699e7a589bc63b4" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>rms_disp_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18cca33f0a05e5a8489a41c12d0178a1"></a><!-- doxytag: member="sc::Convergence::use_rms_grad_" ref="18cca33f0a05e5a8489a41c12d0178a1" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_rms_grad_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69b3b00d9a86285baeaff20e96bdf62a"></a><!-- doxytag: member="sc::Convergence::rms_grad_" ref="69b3b00d9a86285baeaff20e96bdf62a" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>rms_grad_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa0ac37d82ecb53c2aec304489a4a0d4"></a><!-- doxytag: member="sc::Convergence::use_graddisp_" ref="aa0ac37d82ecb53c2aec304489a4a0d4" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_graddisp_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2066dcb2a756436a5a80521adb8e5adc"></a><!-- doxytag: member="sc::Convergence::graddisp_" ref="2066dcb2a756436a5a80521adb8e5adc" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>graddisp_</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classsc_1_1Convergence.html" title="The Convergence class is used by the optimizer to determine when an optimization...">Convergence</a> class is used by the optimizer to determine when an optimization is converged. 
<p>
The <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> input for <a class="el" href="classsc_1_1Convergence.html" title="The Convergence class is used by the optimizer to determine when an optimization...">Convergence</a> is given below. Giving none of these keywords is the same as giving the following input: <pre>
  conv&lt;Convergence&gt;: (
    max_disp = 1.0e-6
    max_grad = 1.0e-6
    graddisp = 1.0e-6
  )
</pre> <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b73bd9dbc27e8432461feda149cecd55"></a><!-- doxytag: member="sc::Convergence::Convergence" ref="b73bd9dbc27e8432461feda149cecd55" args="(const Ref&lt; KeyVal &gt; &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sc::Convergence::Convergence           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> constructor reads the following keywords:. 
<p>
<dl>
<dt><code>max_disp</code></dt>
<dd>The value of the maximum displacement must be less then the value of this keyword for the calculation to be converged. The default is to not check this parameter. However, if no other keyword are given, default convergence parameters are chosen as described above.<p>
</dd>
<dt><code>max_grad</code></dt>
<dd>The value of the maximum gradient must be less then the value of this keyword for the calculation to be converged. The default is to not check this parameter. However, if no other keyword are given, default convergence parameters are chosen as described above.<p>
</dd>
<dt><code>rms_disp</code></dt>
<dd>The value of the RMS of the displacements must be less then the value of this keyword for the calculation to be converged. The default is to not check this parameter. However, if no other keyword are given, default convergence parameters are chosen as described above.<p>
</dd>
<dt><code>rms_grad</code></dt>
<dd>The value of the RMS of the gradients must be less then the value of this keyword for the calculation to be converged. The default is to not check this parameter. However, if no other keyword are given, default convergence parameters are chosen as described above.<p>
</dd>
<dt><code>graddisp</code></dt>
<dd>The value of the scalar product of the gradient vector with the displacement vector must be less then the value of this keyword for the calculation to be converged. The default is to not check this parameter. However, if no other keyword are given, default convergence parameters are chosen as described above.<p>
</dd>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e8bec2082bcf901efdf3fc7ec818c52d"></a><!-- doxytag: member="sc::Convergence::save_data_state" ref="e8bec2082bcf901efdf3fc7ec818c52d" args="(StateOut &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sc::Convergence::save_data_state           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classsc_1_1StateOut.html">StateOut</a> &amp;&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> CTOR initializes them. 
<p>
This must be implemented by the derived class if the class has data. 
<p>Reimplemented from <a class="el" href="classsc_1_1SavableState.html#f9e0c212322d3c0f43e2dcb33e111acf">sc::SavableState</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="conv_8h_source.html">conv.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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional