.TH "sc::LineOpt" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::LineOpt \- The \fBLineOpt\fP abstract class is used to perform one dimensional optimizations\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <opt\&.h>\fP
.PP
Inherits \fBsc::Optimize\fP\&.
.PP
Inherited by \fBsc::Backtrack\fP, and \fBsc::MCSearch\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBLineOpt\fP (\fBStateIn\fP &)"
.br
.ti -1c
.RI "\fBLineOpt\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.ti -1c
.RI "void \fBsave_data_state\fP (\fBStateOut\fP &)"
.br
.RI "Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. "
.ti -1c
.RI "virtual void \fBinit\fP (\fBRefSCVector\fP &direction)"
.br
.RI "Initializes the line search object\&. "
.ti -1c
.RI "virtual void \fBinit\fP (\fBRefSCVector\fP &direction, \fBRef\fP< \fBFunction\fP > \fBfunction\fP)"
.br
.RI "Initializes the line search object\&. "
.ti -1c
.RI "void \fBapply_transform\fP (const \fBRef\fP< \fBNonlinearTransform\fP > &)"
.br
.RI "Applies a nonlinear transform\&. "
.ti -1c
.RI "double \fBdecrease_factor\fP ()"
.br
.RI "Returns factor for sufficient decrease test\&. "
.ti -1c
.RI "double \fBset_decrease_factor\fP (double factor)"
.br
.RI "Sets factor for sufficient decrease test\&. "
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "int \fBsufficient_decrease\fP (\fBRefSCVector\fP &step)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "double \fBdecrease_factor_\fP"
.br
.ti -1c
.RI "\fBRefSCVector\fP \fBinitial_x_\fP"
.br
.ti -1c
.RI "double \fBinitial_value_\fP"
.br
.ti -1c
.RI "\fBRefSCVector\fP \fBinitial_grad_\fP"
.br
.ti -1c
.RI "\fBRefSCVector\fP \fBsearch_direction_\fP"
.br
.ti -1c
.RI "\fBRef\fP< \fBFunction\fP > \fBfunction_\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBLineOpt\fP abstract class is used to perform one dimensional optimizations\&. 
.SH "Member Function Documentation"
.PP 
.SS "virtual void sc::LineOpt::init (\fBRefSCVector\fP & direction)\fC [virtual]\fP"

.PP
Initializes the line search object\&. Argument is a search direction\&. Use of this method assumes the \fBOptimize\fP base class already has a function object (got it from a keyval or elsewhere)\&. 
.PP
Reimplemented in \fBsc::MCSearch\fP\&.
.SS "virtual void sc::LineOpt::init (\fBRefSCVector\fP & direction, \fBRef\fP< \fBFunction\fP > function)\fC [virtual]\fP"

.PP
Initializes the line search object\&. First argument is a search direction, second argument is a function object to optimize\&. Use this method when a function must be passed to the \fBOptimize\fP base class\&. 
.PP
Reimplemented in \fBsc::MCSearch\fP\&.
.SS "void sc::LineOpt::save_data_state (\fBStateOut\fP &)\fC [virtual]\fP"

.PP
Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. This must be implemented by the derived class if the class has data\&. 
.PP
Reimplemented from \fBsc::Optimize\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.