<!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::QNewtonOpt 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:17:30 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::QNewtonOpt Class Reference</h1>The <a class="el" href="class_sc__QNewtonOpt.html">QNewtonOpt</a> implements a quasi-Newton optimization scheme.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="qnewton_h-source.html">qnewton.h</a>></code>
<p>
Inheritance diagram for sc::QNewtonOpt<p><center><img src="class_sc__QNewtonOpt_inherit_graph.gif" border="0" usemap="#sc::QNewtonOpt_inherit_map" alt="Inheritance graph"></center>
<map name="sc::QNewtonOpt_inherit_map">
<area href="class_sc__Optimize.html" shape="rect" coords="31,280,111,299">
<area href="class_sc__SavableState.html" shape="rect" coords="21,213,122,232">
<area href="class_sc__DescribedClass.html" shape="rect" coords="14,147,129,165">
<area href="class_sc__RefCount.html" shape="rect" coords="30,80,113,99">
<area href="class_sc__Identity.html" shape="rect" coords="35,13,107,32">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for sc::QNewtonOpt:<p><center><img src="class_sc__QNewtonOpt_coll_graph.gif" border="0" usemap="#sc::QNewtonOpt_coll_map" alt="Collaboration graph"></center>
<map name="sc::QNewtonOpt_coll_map">
<area href="class_sc__Optimize.html" shape="rect" coords="199,307,279,326">
<area href="class_sc__SavableState.html" shape="rect" coords="21,222,122,240">
<area href="class_sc__DescribedClass.html" shape="rect" coords="14,152,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,32">
<area href="class_sc__Ref.html" shape="rect" coords="146,222,266,240">
<area href="class_sc__RefBase.html" shape="rect" coords="430,152,507,171">
<area href="class_sc__Ref.html" shape="rect" coords="290,222,431,240">
<area href="class_sc__Ref.html" shape="rect" coords="369,264,521,283">
<area href="class_sc__Ref.html" shape="rect" coords="545,264,662,283">
<area href="class_sc__Ref.html" shape="rect" coords="603,222,763,240">
<area href="class_sc__RefSymmSCMatrix.html" shape="rect" coords="630,307,769,326">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_sc__QNewtonOpt-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> </td><td valign=bottom><a class="el" href="class_sc__QNewtonOpt.html#a0">QNewtonOpt</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.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="sc::QNewtonOpt::QNewtonOpt"></a>
</td><td valign=bottom><b>QNewtonOpt</b> (<a class="el" href="class_sc__StateIn.html">StateIn</a> &)</td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="sc::QNewtonOpt::~QNewtonOpt"></a>
</td><td valign=bottom><b>~QNewtonOpt</b> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_sc__QNewtonOpt.html#a3">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="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="sc::QNewtonOpt::apply_transform"></a>
void </td><td valign=bottom><b>apply_transform</b> (const <a class="el" href="class_sc__Ref.html">Ref</a>< <a class="el" href="class_sc__NonlinearTransform.html">NonlinearTransform</a> > &)</td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="sc::QNewtonOpt::init"></a>
void </td><td valign=bottom><a class="el" href="class_sc__QNewtonOpt.html#a5">init</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Initialize the optimizer.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_sc__QNewtonOpt.html#a6">update</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Take a step.</em> <a href="#a6">More...</a><em></em></font><br><br></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::QNewtonOpt::maxabs_gradient"></a>
double </td><td valign=bottom><b>maxabs_gradient</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="sc::QNewtonOpt::accuracy_"></a>
double </td><td valign=bottom><b>accuracy_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="sc::QNewtonOpt::ihessian_"></a>
<a class="el" href="class_sc__RefSymmSCMatrix.html">RefSymmSCMatrix</a> </td><td valign=bottom><b>ihessian_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="sc::QNewtonOpt::update_"></a>
<a class="el" href="class_sc__Ref.html">Ref</a><<a class="el" href="class_sc__HessianUpdate.html">HessianUpdate</a>> </td><td valign=bottom><b>update_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="sc::QNewtonOpt::lineopt_"></a>
<a class="el" href="class_sc__Ref.html">Ref</a><<a class="el" href="class_sc__LineOpt.html">LineOpt</a>> </td><td valign=bottom><b>lineopt_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n5" doxytag="sc::QNewtonOpt::take_newton_step_"></a>
int </td><td valign=bottom><b>take_newton_step_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n6" doxytag="sc::QNewtonOpt::print_hessian_"></a>
int </td><td valign=bottom><b>print_hessian_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n7" doxytag="sc::QNewtonOpt::print_x_"></a>
int </td><td valign=bottom><b>print_x_</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n8" doxytag="sc::QNewtonOpt::print_gradient_"></a>
int </td><td valign=bottom><b>print_gradient_</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="class_sc__QNewtonOpt.html">QNewtonOpt</a> implements a quasi-Newton optimization scheme.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="sc::QNewtonOpt::QNewtonOpt"></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::QNewtonOpt::QNewtonOpt (
</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.
<p>
The <a class="el" href="class_sc__KeyVal.html">KeyVal</a> constructor reads the following keywords:
<dl compact>
<p>
<dt><code>update</code><dd> This gives a <a class="el" href="class_sc__HessianUpdate.html">HessianUpdate</a> object. The default is to not update the hessian.
<p>
<dt><code>hessian</code><dd> By default, the guess hessian is obtained from the <a class="el" href="class_sc__Function.html">Function</a> object. This keyword specifies an lower triangle array (the second index must be less than or equal to than the first) that replaces the guess hessian. If some of the elements are not given, elements from the guess hessian will be used.
<p>
<dt><code>lineopt</code><dd> This gives a <a class="el" href="class_sc__LineOpt.html">LineOpt</a> object for doing line optimizations in the Newton direction. The default is to skip the line optimizations.
<p>
<dt><code>accuracy</code><dd> The accuracy with which the first gradient will be computed. If this is too large, it may be necessary to evaluate the first gradient point twice. If it is too small, it may take longer to evaluate the first point. The default is 0.0001.
<p>
<dt><code>print_x</code><dd> If true, print the coordinates each iteration. The default is false.
<p>
<dt><code>print_gradient</code><dd> If true, print the gradient each iteration. The default is false.
<p>
<dt><code>print_hessian</code><dd> If true, print the approximate hessian each iteration. The default is false.
<p>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="sc::QNewtonOpt::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::QNewtonOpt::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__Optimize.html#a4">sc::Optimize</a>. </td>
</tr>
</table>
<a name="a6" doxytag="sc::QNewtonOpt::update"></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>
int sc::QNewtonOpt::update (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Take a step.
<p>
Returns 1 if the optimization has converged, otherwise 0.
<p>
Reimplemented from <a class="el" href="class_sc__Optimize.html#a11">sc::Optimize</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="qnewton_h-source.html">qnewton.h</a></ul>
<hr>
<address>
<small>
Generated at Mon Oct 14 14:17:31 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
>
524
