101 lines
6.7 KiB
TeX
101 lines
6.7 KiB
TeX
|
|
\doxysection{serif\+::solver\+::Backtracking Struct Reference}
|
||
|
|
\hypertarget{structserif_1_1solver_1_1_backtracking}{}\label{structserif_1_1solver_1_1_backtracking}\index{serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
|
||
|
|
|
||
|
|
Shorten a \doxylink{structserif_1_1solver_1_1_newton}{Newton} step until the complete residual merit decreases sufficiently.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
{\ttfamily \#include $<$options.\+hpp$>$}
|
||
|
|
|
||
|
|
\doxysubsubsection*{Public Member Functions}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
void \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_abf0928f3cb06fbb4b5449d795b0d49f0}{validate}} () const
|
||
|
|
\begin{DoxyCompactList}\small\item\em Require a decreasing, finite sequence of positive trial lengths. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Public Attributes}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
double \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_aebcf24ae783fc9ff3ad60d99a2ec6c66}{initial\+\_\+step}} \{1.\+0\}
|
||
|
|
\item
|
||
|
|
double \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_a7911ba8308c60432c6de212dfd695e8f}{contraction}} \{0.\+5\}
|
||
|
|
\item
|
||
|
|
double \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_a367c1a51e0b8d12774708d13c9094a8a}{fraction\+\_\+to\+\_\+boundary}} \{0.\+9\}
|
||
|
|
\item
|
||
|
|
double \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_abf45ecd4ec4a59442d45bca50a8d10ef}{sufficient\+\_\+decrease}} \{1.\+0e-\/4\}
|
||
|
|
\item
|
||
|
|
double \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_a53406b3dd0cdd6e269f8e7269ec02d03}{minimum\+\_\+step}} \{1.\+0e-\/8\}
|
||
|
|
\item
|
||
|
|
int \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_aeaad4d74cf2435b028349a8fee1d2710}{maximum\+\_\+trials}} \{20\}
|
||
|
|
\item
|
||
|
|
bool \mbox{\hyperlink{structserif_1_1solver_1_1_backtracking_aa74244d42ad42a75376e4d647c983d93}{geometry\+\_\+preflight}} \{true\}
|
||
|
|
\end{DoxyCompactItemize}
|
||
|
|
|
||
|
|
|
||
|
|
\doxysubsection{Detailed Description}
|
||
|
|
Shorten a \doxylink{structserif_1_1solver_1_1_newton}{Newton} step until the complete residual merit decreases sufficiently.
|
||
|
|
|
||
|
|
\doxysubsection{Member Function Documentation}
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_abf0928f3cb06fbb4b5449d795b0d49f0}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!validate@{validate}}
|
||
|
|
\index{validate@{validate}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{validate()}{validate()}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_abf0928f3cb06fbb4b5449d795b0d49f0}
|
||
|
|
void serif\+::solver\+::\+Backtracking\+::validate (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Require a decreasing, finite sequence of positive trial lengths.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
\doxysubsection{Member Data Documentation}
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_a7911ba8308c60432c6de212dfd695e8f}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!contraction@{contraction}}
|
||
|
|
\index{contraction@{contraction}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{contraction}{contraction}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_a7911ba8308c60432c6de212dfd695e8f}
|
||
|
|
double serif\+::solver\+::\+Backtracking\+::contraction \{0.\+5\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_a367c1a51e0b8d12774708d13c9094a8a}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!fraction\_to\_boundary@{fraction\_to\_boundary}}
|
||
|
|
\index{fraction\_to\_boundary@{fraction\_to\_boundary}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{fraction\_to\_boundary}{fraction\_to\_boundary}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_a367c1a51e0b8d12774708d13c9094a8a}
|
||
|
|
double serif\+::solver\+::\+Backtracking\+::fraction\+\_\+to\+\_\+boundary \{0.\+9\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_aa74244d42ad42a75376e4d647c983d93}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!geometry\_preflight@{geometry\_preflight}}
|
||
|
|
\index{geometry\_preflight@{geometry\_preflight}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{geometry\_preflight}{geometry\_preflight}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_aa74244d42ad42a75376e4d647c983d93}
|
||
|
|
bool serif\+::solver\+::\+Backtracking\+::geometry\+\_\+preflight \{true\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_aebcf24ae783fc9ff3ad60d99a2ec6c66}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!initial\_step@{initial\_step}}
|
||
|
|
\index{initial\_step@{initial\_step}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{initial\_step}{initial\_step}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_aebcf24ae783fc9ff3ad60d99a2ec6c66}
|
||
|
|
double serif\+::solver\+::\+Backtracking\+::initial\+\_\+step \{1.\+0\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_aeaad4d74cf2435b028349a8fee1d2710}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!maximum\_trials@{maximum\_trials}}
|
||
|
|
\index{maximum\_trials@{maximum\_trials}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{maximum\_trials}{maximum\_trials}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_aeaad4d74cf2435b028349a8fee1d2710}
|
||
|
|
int serif\+::solver\+::\+Backtracking\+::maximum\+\_\+trials \{20\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_a53406b3dd0cdd6e269f8e7269ec02d03}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!minimum\_step@{minimum\_step}}
|
||
|
|
\index{minimum\_step@{minimum\_step}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{minimum\_step}{minimum\_step}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_a53406b3dd0cdd6e269f8e7269ec02d03}
|
||
|
|
double serif\+::solver\+::\+Backtracking\+::minimum\+\_\+step \{1.\+0e-\/8\}}
|
||
|
|
|
||
|
|
\Hypertarget{structserif_1_1solver_1_1_backtracking_abf45ecd4ec4a59442d45bca50a8d10ef}\index{serif::solver::Backtracking@{serif::solver::Backtracking}!sufficient\_decrease@{sufficient\_decrease}}
|
||
|
|
\index{sufficient\_decrease@{sufficient\_decrease}!serif::solver::Backtracking@{serif::solver::Backtracking}}
|
||
|
|
\doxysubsubsection{\texorpdfstring{sufficient\_decrease}{sufficient\_decrease}}
|
||
|
|
{\footnotesize\ttfamily \label{structserif_1_1solver_1_1_backtracking_abf45ecd4ec4a59442d45bca50a8d10ef}
|
||
|
|
double serif\+::solver\+::\+Backtracking\+::sufficient\+\_\+decrease \{1.\+0e-\/4\}}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
The documentation for this struct was generated from the following files\+:\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
src/include/serif/solver/nonlinear/\mbox{\hyperlink{solver_2nonlinear_2options_8hpp}{options.\+hpp}}\item
|
||
|
|
src/lib/serif/solver/nonlinear/\mbox{\hyperlink{options_8cpp}{options.\+cpp}}\end{DoxyCompactItemize}
|