.TH "sc::MCSearch" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::MCSearch \- This performs line searches with cubic steps\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <mcsearch\&.h>\fP
.PP
Inherits \fBsc::LineOpt\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBMCSearch\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.RI "The \fBMCSearch\fP \fBKeyVal\fP CTOR does not read any input\&. "
.ti -1c
.RI "int \fBupdate\fP ()"
.br
.RI "Take a step\&. "
.ti -1c
.RI "void \fBinit\fP (\fBRefSCVector\fP &direction)"
.br
.RI "Initializes the line search object\&. "
.ti -1c
.RI "void \fBinit\fP (\fBRefSCVector\fP &direction, \fBRef\fP< \fBFunction\fP > \fBfunction\fP)"
.br
.RI "Initializes the line search object\&. "
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBmcstep\fP (double *stx, double *fx, double *dx, double *sty, double *fy, double *dy, double *stp, double *fp, double *dp, bool *brackt, double *stpmin, double *stpmax, int *info)"
.br
.ti -1c
.RI "void \fBmcsrch\fP (int *n, double *x, double *f, double *g, double *s, double *stp, double *ftol, double *xtol, int *maxfev, int *info, int *nfev, double *wa)"
.br
.ti -1c
.RI "void \fBmcinit\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "double \fBgtol_\fP"
.br
.ti -1c
.RI "double \fBstpmin_\fP"
.br
.ti -1c
.RI "double \fBstpmax_\fP"
.br
.ti -1c
.RI "double \fBdg\fP"
.br
.ti -1c
.RI "double \fBfm\fP"
.br
.ti -1c
.RI "double \fBfx\fP"
.br
.ti -1c
.RI "double \fBfy\fP"
.br
.ti -1c
.RI "double \fBdgm\fP"
.br
.ti -1c
.RI "double \fBdgx\fP"
.br
.ti -1c
.RI "double \fBdgy\fP"
.br
.ti -1c
.RI "double \fBfxm\fP"
.br
.ti -1c
.RI "double \fBfym\fP"
.br
.ti -1c
.RI "double \fBstx\fP"
.br
.ti -1c
.RI "double \fBsty\fP"
.br
.ti -1c
.RI "double \fBdgxm\fP"
.br
.ti -1c
.RI "double \fBdgym\fP"
.br
.ti -1c
.RI "int \fBinfoc\fP"
.br
.ti -1c
.RI "double \fBfinit\fP"
.br
.ti -1c
.RI "double \fBwidth\fP"
.br
.ti -1c
.RI "double \fBstmin\fP"
.br
.ti -1c
.RI "double \fBstmax\fP"
.br
.ti -1c
.RI "bool \fBstage1\fP"
.br
.ti -1c
.RI "double \fBwidth1\fP"
.br
.ti -1c
.RI "double \fBftest1\fP"
.br
.ti -1c
.RI "bool \fBbrackt\fP"
.br
.ti -1c
.RI "double \fBdginit\fP"
.br
.ti -1c
.RI "double \fBdgtest\fP"
.br
.ti -1c
.RI "double \fBp\fP"
.br
.ti -1c
.RI "double \fBq\fP"
.br
.ti -1c
.RI "double \fBr__\fP"
.br
.ti -1c
.RI "double \fBs\fP"
.br
.ti -1c
.RI "double \fBsgnd\fP"
.br
.ti -1c
.RI "double \fBstpc\fP"
.br
.ti -1c
.RI "double \fBstpf\fP"
.br
.ti -1c
.RI "double \fBstpq\fP"
.br
.ti -1c
.RI "double \fBgamma\fP"
.br
.ti -1c
.RI "double \fBtheta\fP"
.br
.ti -1c
.RI "bool \fBbound\fP"
.br
.ti -1c
.RI "int \fBinfo_\fP"
.br
.ti -1c
.RI "\fBauto_vec\fP< double > \fBwa_\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
This performs line searches with cubic steps\&. 

It is based on the Fortran MCSRCH and MCSTEP routines produced by: Argonne National Laboratory\&. MINPACK Project\&. June 1983 Jorge J\&. More', David J\&. Thuente\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::MCSearch::MCSearch (const \fBRef\fP< \fBKeyVal\fP > &)"

.PP
The \fBMCSearch\fP \fBKeyVal\fP CTOR does not read any input\&. See the \fBLineOpt\fP \fBKeyVal\fP CTOR for parameters that it takes\&. 
.SH "Member Function Documentation"
.PP 
.SS "void sc::MCSearch::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 from \fBsc::LineOpt\fP\&.
.SS "void sc::MCSearch::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 from \fBsc::LineOpt\fP\&.
.SS "int sc::MCSearch::update ()\fC [virtual]\fP"

.PP
Take a step\&. Returns 1 if the optimization has converged, otherwise 0\&. 
.PP
Implements \fBsc::Optimize\fP\&.

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