.TH "serif::solver::Backtracking" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::Backtracking \- Shorten a \fBNewton\fP step until the complete residual merit decreases sufficiently\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <options\&.hpp>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBvalidate\fP () const"
.br
.RI "Require a decreasing, finite sequence of positive trial lengths\&. "
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "double \fBinitial_step\fP {1\&.0}"
.br
.ti -1c
.RI "double \fBcontraction\fP {0\&.5}"
.br
.ti -1c
.RI "double \fBfraction_to_boundary\fP {0\&.9}"
.br
.ti -1c
.RI "double \fBsufficient_decrease\fP {1\&.0e\-4}"
.br
.ti -1c
.RI "double \fBminimum_step\fP {1\&.0e\-8}"
.br
.ti -1c
.RI "int \fBmaximum_trials\fP {20}"
.br
.ti -1c
.RI "bool \fBgeometry_preflight\fP {true}"
.br
.in -1c
.SH "Detailed Description"
.PP 
Shorten a \fBNewton\fP step until the complete residual merit decreases sufficiently\&. 
.SH "Member Function Documentation"
.PP 
.SS "void serif::solver::Backtracking::validate () const"

.PP
Require a decreasing, finite sequence of positive trial lengths\&. 
.SH "Member Data Documentation"
.PP 
.SS "double serif::solver::Backtracking::contraction {0\&.5}"

.SS "double serif::solver::Backtracking::fraction_to_boundary {0\&.9}"

.SS "bool serif::solver::Backtracking::geometry_preflight {true}"

.SS "double serif::solver::Backtracking::initial_step {1\&.0}"

.SS "int serif::solver::Backtracking::maximum_trials {20}"

.SS "double serif::solver::Backtracking::minimum_step {1\&.0e\-8}"

.SS "double serif::solver::Backtracking::sufficient_decrease {1\&.0e\-4}"


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