<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>sc::Convergence class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Mon Oct 14 14:16:48 2002 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>sc::Convergence Class Reference</h1>The <a class="el" href="class_sc__Convergence.html">Convergence</a> class is used by the optimizer to determine when an optimization is converged.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="conv_h-source.html">conv.h</a>></code>
<p>
Inheritance diagram for sc::Convergence<p><center><img src="class_sc__Convergence_inherit_graph.gif" border="0" usemap="#sc::Convergence_inherit_map" alt="Inheritance graph"></center>
<map name="sc::Convergence_inherit_map">
<area href="class_sc__SavableState.html" shape="rect" coords="45,213,146,232">
<area href="class_sc__DescribedClass.html" shape="rect" coords="38,147,153,165">
<area href="class_sc__RefCount.html" shape="rect" coords="54,80,137,99">
<area href="class_sc__Identity.html" shape="rect" coords="59,13,131,32">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for sc::Convergence:<p><center><img src="class_sc__Convergence_coll_graph.gif" border="0" usemap="#sc::Convergence_coll_map" alt="Collaboration graph"></center>
<map name="sc::Convergence_coll_map">
<area href="class_sc__SavableState.html" shape="rect" coords="31,222,133,241">
<area href="class_sc__DescribedClass.html" shape="rect" coords="14,153,129,171">
<area href="class_sc__RefCount.html" shape="rect" coords="30,83,113,102">
<area href="class_sc__Identity.html" shape="rect" coords="35,14,107,33">
<area href="class_sc__RefSCVector.html" shape="rect" coords="158,222,262,241">
<area href="class_sc__Ref.html" shape="rect" coords="153,153,278,171">
<area href="class_sc__RefBase.html" shape="rect" coords="177,83,254,102">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_sc__Convergence-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="sc::Convergence::Convergence"></a>
</td><td valign=bottom><b>Convergence</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="sc::Convergence::Convergence"></a>
</td><td valign=bottom><b>Convergence</b> (double tolerance)</td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="sc::Convergence::Convergence"></a>
</td><td valign=bottom><b>Convergence</b> (<a class="el" href="class_sc__StateIn.html">StateIn</a> &)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_sc__Convergence.html#a3">Convergence</a> (const <a class="el" href="class_sc__Ref.html">Ref</a>< <a class="el" href="class_sc__KeyVal.html">KeyVal</a> > &)</td></tr>
<tr><td> </td><td><font size=-1><em>The <a class="el" href="class_sc__KeyVal.html">KeyVal</a> constructor reads the following keywords:.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="sc::Convergence::~Convergence"></a>
virtual </td><td valign=bottom><b>~Convergence</b> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_sc__Convergence.html#a5">save_data_state</a> (<a class="el" href="class_sc__StateOut.html">StateOut</a> &)</td></tr>
<tr><td> </td><td><font size=-1><em>Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="class_sc__StateIn.html">StateIn</a> CTOR initializes them.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="sc::Convergence::get_grad"></a>
virtual void </td><td valign=bottom><a class="el" href="class_sc__Convergence.html#a6">get_grad</a> (const <a class="el" href="class_sc__Ref.html">Ref</a>< <a class="el" href="class_sc__Function.html">Function</a> > &)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the current gradient and displacement.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="sc::Convergence::get_x"></a>
virtual void </td><td valign=bottom><b>get_x</b> (const <a class="el" href="class_sc__Ref.html">Ref</a>< <a class="el" href="class_sc__Function.html">Function</a> > &)</td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="sc::Convergence::set_nextx"></a>
virtual void </td><td valign=bottom><b>set_nextx</b> (const <a class="el" href="class_sc__RefSCVector.html">RefSCVector</a> &)</td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="sc::Convergence::reset"></a>
virtual void </td><td valign=bottom><a class="el" href="class_sc__Convergence.html#a9">reset</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Set the current gradient and displacement to null.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="sc::Convergence::converged"></a>
virtual int </td><td valign=bottom><a class="el" href="class_sc__Convergence.html#a10">converged</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Return nonzero if the optimization has converged.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="b0" doxytag="sc::Convergence::check_conv"></a>
void </td><td valign=bottom><b>check_conv</b> (const char *heading, double val, double bound, int &pass, int &fail)</td></tr>
<tr><td nowrap align=right valign=top><a name="b1" doxytag="sc::Convergence::set_defaults"></a>
void </td><td valign=bottom><b>set_defaults</b> ()</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="sc::Convergence::grad_"></a>
<a class="el" href="class_sc__RefSCVector.html">RefSCVector</a> </td><td valign=bottom><b>grad_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="sc::Convergence::x_"></a>
<a class="el" href="class_sc__RefSCVector.html">RefSCVector</a> </td><td valign=bottom><b>x_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="sc::Convergence::nextx_"></a>
<a class="el" href="class_sc__RefSCVector.html">RefSCVector</a> </td><td valign=bottom><b>nextx_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="sc::Convergence::use_max_disp_"></a>
int </td><td valign=bottom><b>use_max_disp_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="sc::Convergence::max_disp_"></a>
double </td><td valign=bottom><b>max_disp_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n5" doxytag="sc::Convergence::use_max_grad_"></a>
int </td><td valign=bottom><b>use_max_grad_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n6" doxytag="sc::Convergence::max_grad_"></a>
double </td><td valign=bottom><b>max_grad_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n7" doxytag="sc::Convergence::use_rms_disp_"></a>
int </td><td valign=bottom><b>use_rms_disp_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n8" doxytag="sc::Convergence::rms_disp_"></a>
double </td><td valign=bottom><b>rms_disp_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n9" doxytag="sc::Convergence::use_rms_grad_"></a>
int </td><td valign=bottom><b>use_rms_grad_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n10" doxytag="sc::Convergence::rms_grad_"></a>
double </td><td valign=bottom><b>rms_grad_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n11" doxytag="sc::Convergence::use_graddisp_"></a>
int </td><td valign=bottom><b>use_graddisp_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n12" doxytag="sc::Convergence::graddisp_"></a>
double </td><td valign=bottom><b>graddisp_</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="class_sc__Convergence.html">Convergence</a> class is used by the optimizer to determine when an optimization is converged.
<p>
The <a class="el" href="class_sc__KeyVal.html">KeyVal</a> input for <a class="el" href="class_sc__Convergence.html">Convergence</a> is given below. Giving none of these keywords is the same as giving the following input: <pre>
conv<<a class="el" href="class_sc__Convergence.html">Convergence</a>>: (
max_disp = 1.0e-6
max_grad = 1.0e-6
graddisp = 1.0e-6
)
</pre>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a3" doxytag="sc::Convergence::Convergence"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
sc::Convergence::Convergence (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="class_sc__Ref.html">Ref</a>< <a class="el" href="class_sc__KeyVal.html">KeyVal</a> > & )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The <a class="el" href="class_sc__KeyVal.html">KeyVal</a> constructor reads the following keywords:.
<p>
<dl compact>
<p>
<dt><code>max_disp</code><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>
<dt><code>max_grad</code><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>
<dt><code>rms_disp</code><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>
<dt><code>rms_grad</code><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>
<dt><code>graddisp</code><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>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="sc::Convergence::save_data_state"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void sc::Convergence::save_data_state (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_sc__StateOut.html">StateOut</a> & <em>s</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="class_sc__StateIn.html">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="class_sc__SavableState.html#a5">sc::SavableState</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="conv_h-source.html">conv.h</a></ul>
<hr>
<address>
<small>
Generated at Mon Oct 14 14:16:48 2002 for <a
href="http://aros.ca.sandia.gov/~cljanss/mpqc">MPQC</a>
2.1.2 using the documentation package <a
href="http://www.stack.nl/~dimitri/doxygen/index.html">Doxygen</a>
1.2.5.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
contrib
>
by-pkgid
>
263386785cefb9ae5d63b926d214d809
>
files
>
132
