Files
MeanField_SERiF/docs/man/man3/serif_solver_detail_SolveObservation.3

88 lines
4.1 KiB
Groff
Raw Normal View History

.TH "serif::solver::detail::SolveObservation< Observer, Strategies >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::detail::SolveObservation< Observer, Strategies > \- Adapt callbacks and latch requests; only the \fBNewton\fP driver decides when stopping is safe\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <observers\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSolveObservation\fP (Observer &observer, Strategies &strategies, \fBSolveDiagnostics\fP &diagnostics)"
.br
.RI "Borrow the single diagnostics record and the selected numerical execution\&. "
.ti -1c
.RI "void \fBnotify\fP (\fBEventKind\fP kind, const auto &state, const auto &system, int iteration=0, int trial=0, double step=0\&.0, std::optional< \fBMetricEvaluation\fP > metric={}, std::string message={})"
.br
.RI "Publish an immutable snapshot and remember a stop request until an accepted boundary\&. "
.ti -1c
.RI "bool \fBstop_requested\fP () const noexcept"
.br
.RI "Check the latched request without letting callbacks accept or reject a trial\&. "
.ti -1c
.RI "auto \fBfinish\fP (auto &result, \fBSolveStatus\fP status, std::string message, \fBMetricEvaluation\fP metric={})"
.br
.RI "Finalize reporting even when the initial state was rejected and no snapshot exists\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "Observer & \fBm_observer\fP"
.br
.ti -1c
.RI "Strategies & \fBm_strategies\fP"
.br
.ti -1c
.RI "\fBSolveDiagnostics\fP & \fBm_diagnostics\fP"
.br
.ti -1c
.RI "bool \fBm_stop_requested\fP {false}"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Observer, typename Strategies>
.br
class serif::solver::detail::SolveObservation< Observer, Strategies >"Adapt callbacks and latch requests; only the \fBNewton\fP driver decides when stopping is safe\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<typename Observer, typename Strategies> \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::SolveObservation (Observer & observer, Strategies & strategies, \fBSolveDiagnostics\fP & diagnostics)\fR [inline]\fP"
.PP
Borrow the single diagnostics record and the selected numerical execution\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename Observer, typename Strategies> auto \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::finish (auto & result, \fBSolveStatus\fP status, std::string message, \fBMetricEvaluation\fP metric = \fR{}\fP)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Finalize reporting even when the initial state was rejected and no snapshot exists\&.
.SS "template<typename Observer, typename Strategies> void \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::notify (\fBEventKind\fP kind, const auto & state, const auto & system, int iteration = \fR0\fP, int trial = \fR0\fP, double step = \fR0\&.0\fP, std::optional< \fBMetricEvaluation\fP > metric = \fR{}\fP, std::string message = \fR{}\fP)\fR [inline]\fP"
.PP
Publish an immutable snapshot and remember a stop request until an accepted boundary\&.
.SS "template<typename Observer, typename Strategies> bool \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::stop_requested () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Check the latched request without letting callbacks accept or reject a trial\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename Observer, typename Strategies> \fBSolveDiagnostics\fP& \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::m_diagnostics\fR [private]\fP"
.SS "template<typename Observer, typename Strategies> Observer& \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::m_observer\fR [private]\fP"
.SS "template<typename Observer, typename Strategies> bool \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::m_stop_requested {false}\fR [private]\fP"
.SS "template<typename Observer, typename Strategies> Strategies& \fBserif::solver::detail::SolveObservation\fP< Observer, Strategies >::m_strategies\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.