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

126 lines
5.0 KiB
Groff
Raw Normal View History

.TH "serif::solver::continuation::Result< Report, Count >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::continuation::Result< Report, Count > \- Retain the last converged physical state separately from the requested endpoint and failed candidates\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <driver\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "bool \fBconverged\fP () const noexcept"
.br
.RI "A converged intermediate star does not certify the requested target\&. "
.ti -1c
.RI "const Report * \fBlast_converged\fP () const noexcept"
.br
.RI "Inspect the owning last successful solve even when the target was not reached\&. "
.ti -1c
.RI "std::uint64_t \fBtotal_attempts\fP () const noexcept"
.br
.RI "Count starting qualification and every continuation correction, including failed attempts\&. "
.ti -1c
.RI "std::uint64_t \fBtotal_work\fP () const noexcept"
.br
.RI "Include all recorded nonlinear work rather than only successful stages\&. "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBStatus\fP \fBstatus\fP {\fBStatus::starting_star_failed\fP}"
.br
.ti -1c
.RI "std::string \fBmessage\fP"
.br
.ti -1c
.RI "std::array< double, Count > \fBtarget\fP {}"
.br
.ti -1c
.RI "std::optional< std::array< double, Count > > \fBaccepted_coordinates\fP"
.br
.ti -1c
.RI "std::unique_ptr< Report > \fBaccepted\fP"
.br
.ti -1c
.RI "std::unique_ptr< Report > \fBfailed\fP"
.br
.ti -1c
.RI "std::vector< \fBStageRecord\fP< Count > > \fBstages\fP"
.br
.ti -1c
.RI "\fBCoordinateCounters\fP \fBcounters\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBstarting_attempts\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBstarting_work\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBomitted_records\fP {}"
.br
.ti -1c
.RI "double \fBabsolute_tolerance\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Report, std::size_t Count>
.br
struct serif::solver::continuation::Result< Report, Count >"Retain the last converged physical state separately from the requested endpoint and failed candidates\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename Report, std::size_t Count> bool \fBserif::solver::continuation::Result\fP< Report, Count >::converged () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
A converged intermediate star does not certify the requested target\&.
.SS "template<typename Report, std::size_t Count> const Report * \fBserif::solver::continuation::Result\fP< Report, Count >::last_converged () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the owning last successful solve even when the target was not reached\&.
.SS "template<typename Report, std::size_t Count> std::uint64_t \fBserif::solver::continuation::Result\fP< Report, Count >::total_attempts () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Count starting qualification and every continuation correction, including failed attempts\&.
.SS "template<typename Report, std::size_t Count> std::uint64_t \fBserif::solver::continuation::Result\fP< Report, Count >::total_work () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Include all recorded nonlinear work rather than only successful stages\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename Report, std::size_t Count> double \fBserif::solver::continuation::Result\fP< Report, Count >::absolute_tolerance {}"
.SS "template<typename Report, std::size_t Count> std::unique_ptr<Report> \fBserif::solver::continuation::Result\fP< Report, Count >::accepted"
.SS "template<typename Report, std::size_t Count> std::optional<std::array<double, Count> > \fBserif::solver::continuation::Result\fP< Report, Count >::accepted_coordinates"
.SS "template<typename Report, std::size_t Count> \fBCoordinateCounters\fP \fBserif::solver::continuation::Result\fP< Report, Count >::counters {}"
.SS "template<typename Report, std::size_t Count> std::unique_ptr<Report> \fBserif::solver::continuation::Result\fP< Report, Count >::failed"
.SS "template<typename Report, std::size_t Count> std::string \fBserif::solver::continuation::Result\fP< Report, Count >::message"
.SS "template<typename Report, std::size_t Count> std::uint64_t \fBserif::solver::continuation::Result\fP< Report, Count >::omitted_records {}"
.SS "template<typename Report, std::size_t Count> std::vector<\fBStageRecord\fP<Count> > \fBserif::solver::continuation::Result\fP< Report, Count >::stages"
.SS "template<typename Report, std::size_t Count> std::uint64_t \fBserif::solver::continuation::Result\fP< Report, Count >::starting_attempts {}"
.SS "template<typename Report, std::size_t Count> std::uint64_t \fBserif::solver::continuation::Result\fP< Report, Count >::starting_work {}"
.SS "template<typename Report, std::size_t Count> \fBStatus\fP \fBserif::solver::continuation::Result\fP< Report, Count >::status {\fBStatus::starting_star_failed\fP}"
.SS "template<typename Report, std::size_t Count> std::array<double, Count> \fBserif::solver::continuation::Result\fP< Report, Count >::target {}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.