60 lines
1.3 KiB
Groff
60 lines
1.3 KiB
Groff
|
|
.TH "serif::solver::SolveEvent" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::solver::SolveEvent \- Small event record suitable for logging without retaining every iterate\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <result\&.hpp>\fP
|
||
|
|
.SS "Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBEventKind\fP \fBkind\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBiteration\fP {0}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBtrial\fP {0}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBstep\fP {0\&.0}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::optional< \fBMetricEvaluation\fP > \fBmetric\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::string \fBmessage\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBSolveDiagnostics\fP & \fBdiagnostics\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Small event record suitable for logging without retaining every iterate\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "const \fBSolveDiagnostics\fP& serif::solver::SolveEvent::diagnostics"
|
||
|
|
|
||
|
|
.SS "int serif::solver::SolveEvent::iteration {0}"
|
||
|
|
|
||
|
|
.SS "\fBEventKind\fP serif::solver::SolveEvent::kind"
|
||
|
|
|
||
|
|
.SS "std::string serif::solver::SolveEvent::message"
|
||
|
|
|
||
|
|
.SS "std::optional<\fBMetricEvaluation\fP> serif::solver::SolveEvent::metric"
|
||
|
|
|
||
|
|
.SS "double serif::solver::SolveEvent::step {0\&.0}"
|
||
|
|
|
||
|
|
.SS "int serif::solver::SolveEvent::trial {0}"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|