Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
85 lines
3.6 KiB
Groff
85 lines
3.6 KiB
Groff
.TH "serif::solver::StandardNewton" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::StandardNewton \- Ordinary \fBNewton\fP supplies every strategy phase; custom policies may replace individual phases explicitly\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <options\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBTrialAssessment\fP \fBinitialize\fP (auto &, auto &, auto &, const auto &)"
|
|
.br
|
|
.RI "Ordinary \fBNewton\fP needs no modification of the evaluated initial state\&. "
|
|
.ti -1c
|
|
.RI "\fBTrialAssessment\fP \fBadmissible\fP (auto &, const auto &)"
|
|
.br
|
|
.RI "Physical preparation supplies the default sampled admissibility checks\&. "
|
|
.ti -1c
|
|
.RI "\fBlinear::Report\fP \fBsolve\fP (auto &problem, const auto &, const auto &prepared, const auto &rhs, auto &correction, const auto &options)"
|
|
.br
|
|
.RI "Select ordinary \fBNewton\fP's checked linear equation on the bound problem\&. "
|
|
.ti -1c
|
|
.RI "\fBDirectionAssessment\fP \fBdirection\fP (auto &, const auto &, const auto &, const auto &, auto &, const auto &)"
|
|
.br
|
|
.RI "Retain the checked \fBNewton\fP direction and ordinary sufficient-decrease criterion\&. "
|
|
.ti -1c
|
|
.RI "\fBTrialAssessment\fP \fBtrial\fP (auto &, const auto &, const auto &, const auto &, double, auto &, auto &, const auto &, double)"
|
|
.br
|
|
.RI "Retain the original evaluated trial without an auxiliary correction\&. "
|
|
.ti -1c
|
|
.RI "void \fBcontribute_diagnostics\fP (\fBSolveDiagnostics\fP &) const"
|
|
.br
|
|
.RI "Ordinary \fBNewton\fP has no additional strategy work to report\&. "
|
|
.in -1c
|
|
.SS "Static Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static auto \fBcomputations\fP (const auto &, const auto &, auto, const auto &)"
|
|
.br
|
|
.RI "Ordinary \fBNewton\fP adds no optional stellar preparation computations or inputs\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Ordinary \fBNewton\fP supplies every strategy phase; custom policies may replace individual phases explicitly\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "\fBTrialAssessment\fP serif::solver::StandardNewton::admissible (auto & , const auto & )\fR [inline]\fP"
|
|
|
|
.PP
|
|
Physical preparation supplies the default sampled admissibility checks\&.
|
|
.SS "static auto serif::solver::StandardNewton::computations (const auto & , const auto & , auto , const auto & )\fR [inline]\fP, \fR [static]\fP"
|
|
|
|
.PP
|
|
Ordinary \fBNewton\fP adds no optional stellar preparation computations or inputs\&.
|
|
.SS "void serif::solver::StandardNewton::contribute_diagnostics (\fBSolveDiagnostics\fP & ) const\fR [inline]\fP"
|
|
|
|
.PP
|
|
Ordinary \fBNewton\fP has no additional strategy work to report\&.
|
|
.SS "\fBDirectionAssessment\fP serif::solver::StandardNewton::direction (auto & , const auto & , const auto & , const auto & , auto & , const auto & )\fR [inline]\fP"
|
|
|
|
.PP
|
|
Retain the checked \fBNewton\fP direction and ordinary sufficient-decrease criterion\&.
|
|
.SS "\fBTrialAssessment\fP serif::solver::StandardNewton::initialize (auto & , auto & , auto & , const auto & )\fR [inline]\fP"
|
|
|
|
.PP
|
|
Ordinary \fBNewton\fP needs no modification of the evaluated initial state\&.
|
|
.SS "\fBlinear::Report\fP serif::solver::StandardNewton::solve (auto & problem, const auto & , const auto & prepared, const auto & rhs, auto & correction, const auto & options)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Select ordinary \fBNewton\fP's checked linear equation on the bound problem\&.
|
|
.SS "\fBTrialAssessment\fP serif::solver::StandardNewton::trial (auto & , const auto & , const auto & , const auto & , double , auto & , auto & , const auto & , double )\fR [inline]\fP"
|
|
|
|
.PP
|
|
Retain the original evaluated trial without an auxiliary correction\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|