MeanField_SERiF/docs/xml/solver_2nonlinear_2result_8hpp.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
  <compounddef id="solver_2nonlinear_2result_8hpp" kind="file" language="C++">
    <compoundname>result.hpp</compoundname>
    <includes local="no">algorithm</includes>
    <includes local="no">cmath</includes>
    <includes local="no">memory</includes>
    <includes local="no">optional</includes>
    <includes local="no">string</includes>
    <includes local="no">utility</includes>
    <includes local="no">vector</includes>
    <includes refid="geometry_2deformation_2geometry__step_8hpp" local="yes">serif/geometry/deformation/geometry_step.hpp</includes>
    <includes refid="solver_2nonlinear_2options_8hpp" local="yes">serif/solver/nonlinear/options.hpp</includes>
    <includes refid="linear_8hpp" local="yes">serif/solver/linear/linear.hpp</includes>
    <includes refid="errors_8hpp" local="yes">serif/utils/error/errors.hpp</includes>
    <includedby refid="public__contracts_8cpp" local="yes">src/compile_time_checks/serif/solver/public_contracts.cpp</includedby>
    <includedby refid="solver_2nonlinear_2observers_8hpp" local="yes">src/include/serif/solver/nonlinear/observers.hpp</includedby>
    <includedby refid="qualification_8hpp" local="yes">src/include/serif/solver/nonlinear/qualification.hpp</includedby>
    <includedby refid="utils_2serialize_2solver_8hpp" local="yes">src/include/serif/utils/serialize/solver.hpp</includedby>
    <incdepgraph>
      <node id="9">
        <label>serif/geometry/deformation/geometry_step.hpp</label>
        <link refid="geometry_2deformation_2geometry__step_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/solver/linear/linear.hpp</label>
        <link refid="linear_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/solver/nonlinear/options.hpp</label>
        <link refid="solver_2nonlinear_2options_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/nonlinear/result.hpp</label>
        <link refid="solver_2nonlinear_2result_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/utils/error/errors.hpp</label>
        <link refid="errors_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>serif/utils/misc/concepts/exceptions.hpp</label>
        <link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
      </node>
      <node id="28">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/utils/misc/terminal/colors.hpp</label>
        <link refid="colors_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="34">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>algorithm</label>
      </node>
      <node id="3">
        <label>cmath</label>
      </node>
      <node id="29">
        <label>concepts</label>
      </node>
      <node id="10">
        <label>cstddef</label>
      </node>
      <node id="16">
        <label>cstdint</label>
      </node>
      <node id="20">
        <label>cstdio</label>
      </node>
      <node id="23">
        <label>cstdlib</label>
      </node>
      <node id="26">
        <label>exception</label>
      </node>
      <node id="19">
        <label>format</label>
      </node>
      <node id="35">
        <label>iostream</label>
      </node>
      <node id="11">
        <label>limits</label>
      </node>
      <node id="33">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="4">
        <label>memory</label>
      </node>
      <node id="5">
        <label>optional</label>
      </node>
      <node id="13">
        <label>span</label>
      </node>
      <node id="6">
        <label>string</label>
      </node>
      <node id="18">
        <label>string_view</label>
      </node>
      <node id="14">
        <label>tuple</label>
      </node>
      <node id="27">
        <label>type_traits</label>
      </node>
      <node id="24">
        <label>unistd.h</label>
      </node>
      <node id="32">
        <label>unordered_map</label>
      </node>
      <node id="7">
        <label>utility</label>
      </node>
      <node id="8">
        <label>vector</label>
      </node>
      <node id="21">
        <label>version</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="5">
        <label>src/compile_time_checks/serif/backend_independent.cpp</label>
        <link refid="backend__independent_8cpp"/>
      </node>
      <node id="2">
        <label>src/compile_time_checks/serif/solver/public_contracts.cpp</label>
        <link refid="public__contracts_8cpp"/>
      </node>
      <node id="7">
        <label>src/include/serif/solver/continuation/equilibrium.hpp</label>
        <link refid="solver_2continuation_2equilibrium_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/solver/equilibrium.hpp</label>
        <link refid="solver_2equilibrium_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/solver/nonlinear/newton.hpp</label>
        <link refid="newton_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>src/include/serif/solver/nonlinear/observers.hpp</label>
        <link refid="solver_2nonlinear_2observers_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/solver/nonlinear/qualification.hpp</label>
        <link refid="qualification_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/nonlinear/result.hpp</label>
        <link refid="solver_2nonlinear_2result_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>src/include/serif/solver/nonlinear/steps.hpp</label>
        <link refid="steps_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_2solver_8hpp"/>
      </node>
      <node id="12">
        <label>src/include/serif/utils/serialize/serialize.hpp</label>
        <link refid="serialize_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/utils/serialize/solver.hpp</label>
        <link refid="utils_2serialize_2solver_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1solver_1_1_solve_diagnostics" prot="public">serif::solver::SolveDiagnostics</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_newton_progress" prot="public">serif::solver::NewtonProgress</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_newton_checkpoint" prot="public">serif::solver::NewtonCheckpoint</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_solve_event" prot="public">serif::solver::SolveEvent</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_no_observer" prot="public">serif::solver::NoObserver</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_no_model" prot="public">serif::solver::NoModel</innerclass>
    <innerclass refid="classserif_1_1solver_1_1_solve_result" prot="public">serif::solver::SolveResult</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1detail">serif::solver::detail</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;algorithm&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;memory&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;optional&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;vector&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry_2deformation_2geometry__step_8hpp" kindref="compound">serif/geometry/deformation/geometry_step.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="solver_2nonlinear_2options_8hpp" kindref="compound">serif/solver/nonlinear/options.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="13"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="linear_8hpp" kindref="compound">serif/solver/linear/linear.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="errors_8hpp" kindref="compound">serif/utils/error/errors.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver" kindref="compound">serif::solver</ref><sp/>{</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64" kindref="member">SolveStatus</ref><sp/>{<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a7de33615d7fbc1cb7bc608d12f1993d2" kindref="member">converged</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a00284e15e20ba8bd246e70c06567efbd" kindref="member">initial_state_rejected</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64ae5352def1775383427334d4671099caf" kindref="member">invalid_metric</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64ae9f49c7af9b0c06e5e2481ec84cdf9aa" kindref="member">preparation_failure</ref>,</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a4913a35a7eab87ca909c1d360ab82adb" kindref="member">linear_solve_failure</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a8286355a7892894a1c3cc40354da9999" kindref="member">globalization_failure</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64af9cc715fb6ecde5fea080ac57ad0dfaf" kindref="member">maximum_iterations</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64af0a0bfe6bc7d2c58d2989034f83183e0" kindref="member">stopped</ref><sp/>};</highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
<codeline lineno="22" refid="structserif_1_1solver_1_1_solve_diagnostics" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref><sp/>{</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a97fea022621b1636c6d98d44e4acf17c" kindref="member">attempted_iterations</ref>{0};</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a54ba495e8544da884ae1cd183b00b02e" kindref="member">accepted_iterations</ref>{0};</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa03e8e71623874a7e7dd29b3def718bc" kindref="member">line_search_trials</ref>{0};</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa9987f7be887e8b8427e42e7eee02f3c" kindref="member">rejected_trials</ref>{0};</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a60376f39e17f7ac5a59a23e3ae49491a" kindref="member">geometry_limited_iterations</ref>{0};</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a8bdb43e05a71be4ceffa01b07ba6196c" kindref="member">total_linear_iterations</ref>{0};</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;double&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1adcc287179655cd76509dff10a46a13c6" kindref="member">initial_residual_norm</ref>;</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;double&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1abd33d959132ccbd0c0119e0bbfc3c6a2" kindref="member">final_residual_norm</ref>;</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;double&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1afdc11a73dadf6aed3581326eeca980b6" kindref="member">convergence_threshold</ref>;</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;linear::Report&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a29a40a19af6373b5dec882a7a39185e4" kindref="member">last_linear_solve</ref>;</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;geometry::deformation::GeometryStepLimit&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1af2b81a8376e93e57f2389615531dbad0" kindref="member">last_geometry_preflight</ref>;</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a962bf9dff1931e4adb65a4ed992cd6b7" kindref="member">last_accepted_step</ref>{0.0};</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="36"><highlight class="normal"></highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1detail" kindref="compound">detail</ref><sp/>{</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Options&gt;</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1detail_1aca34a8e5074029c302fd5d3fc9d35244" kindref="member">checkpointable_options</ref><sp/>=</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::same_as&lt;std::remove_cvref_t&lt;decltype(std::declval&lt;Options&gt;().strategies)&gt;,<sp/><ref refid="structserif_1_1solver_1_1_standard_newton" kindref="compound">StandardNewton</ref>&gt;<sp/>&amp;&amp;</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::same_as&lt;std::remove_cvref_t&lt;</highlight><highlight class="keyword">decltype</highlight><highlight class="normal">(std::declval&lt;Options&gt;().metric)&gt;,<sp/><ref refid="structserif_1_1solver_1_1_normalized_residual_metric" kindref="compound">NormalizedResidualMetric</ref>&gt;<sp/>&amp;&amp;</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::same_as&lt;std::remove_cvref_t&lt;</highlight><highlight class="keyword">decltype</highlight><highlight class="normal">(std::declval&lt;Options&gt;().linear_solver)&gt;,<sp/><ref refid="structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s" kindref="compound">linear::FGMRES</ref>&gt;;</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="52" refid="structserif_1_1solver_1_1_newton_progress" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_newton_progress" kindref="compound">NewtonProgress</ref><sp/>{</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation" kindref="compound">MetricEvaluation</ref><sp/><ref refid="structserif_1_1solver_1_1_newton_progress_1abee0674e613b9d45c0be340421c579be" kindref="member">accepted_metric</ref>;</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;double&gt;<sp/><ref refid="structserif_1_1solver_1_1_newton_progress_1a13b4b6ccbac9fcadc09aac0cd9d6d6dd" kindref="member">correction</ref>;</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_progress_1a52906514f084708692eb085d9104400b" kindref="member">next_step</ref>{1.0};</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref><sp/><ref refid="structserif_1_1solver_1_1_newton_progress_1aeae077ca13c5a147c8a153a664615daf" kindref="member">diagnostics</ref>;</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="58"><highlight class="normal"></highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/>std::optional&lt;std::string&gt;<sp/><ref refid="namespaceserif_1_1solver_1aba8609bba7520feb62263d06def641e5" kindref="member">validate_newton_progress</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_progress" kindref="compound">NewtonProgress</ref>&amp;<sp/>progress,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::size_t<sp/>state_size)<sp/>{</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref>&amp;<sp/>diagnostics<sp/>=<sp/>progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1aeae077ca13c5a147c8a153a664615daf" kindref="member">diagnostics</ref>;</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>nonnegative<sp/>=<sp/>[](</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::optional&lt;double&gt;&amp;<sp/>value)<sp/>{</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>value<sp/>&amp;&amp;<sp/>std::isfinite(*value)<sp/>&amp;&amp;<sp/>*value<sp/>&gt;=<sp/>0.0;</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1abee0674e613b9d45c0be340421c579be" kindref="member">accepted_metric</ref>.<ref refid="structserif_1_1solver_1_1_metric_evaluation_1a7932e18162f4079df5294b322346e71a" kindref="member">valid</ref>()<sp/>||<sp/>!std::isfinite(progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1a52906514f084708692eb085d9104400b" kindref="member">next_step</ref>)<sp/>||<sp/>progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1a52906514f084708692eb085d9104400b" kindref="member">next_step</ref><sp/>&lt;=<sp/>0.0<sp/>||</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1a13b4b6ccbac9fcadc09aac0cd9d6d6dd" kindref="member">correction</ref>.size()<sp/>!=<sp/>state_size<sp/>||<sp/>!std::ranges::all_of(progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1a13b4b6ccbac9fcadc09aac0cd9d6d6dd" kindref="member">correction</ref>,<sp/>[](</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>value)<sp/>{<sp/>return<sp/>std::isfinite(value);<sp/>}))<sp/>{</highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>accepted<sp/>metric,<sp/>correction<sp/>size/values<sp/>or<sp/>next<sp/>trial<sp/>step<sp/>is<sp/>invalid.&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="68"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!nonnegative(diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1adcc287179655cd76509dff10a46a13c6" kindref="member">initial_residual_norm</ref>)<sp/>||<sp/>!nonnegative(diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1abd33d959132ccbd0c0119e0bbfc3c6a2" kindref="member">final_residual_norm</ref>)<sp/>||</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>!nonnegative(diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1afdc11a73dadf6aed3581326eeca980b6" kindref="member">convergence_threshold</ref>)<sp/>||<sp/>*diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1abd33d959132ccbd0c0119e0bbfc3c6a2" kindref="member">final_residual_norm</ref><sp/>!=<sp/>progress.<ref refid="structserif_1_1solver_1_1_newton_progress_1abee0674e613b9d45c0be340421c579be" kindref="member">accepted_metric</ref>.<ref refid="structserif_1_1solver_1_1_metric_evaluation_1a9ee79bf7923368d43f98567ba369aa36" kindref="member">residual_norm</ref>)<sp/>{</highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>original<sp/>convergence<sp/>reference<sp/>or<sp/>accepted<sp/>residual<sp/>is<sp/>missing<sp/>or<sp/>inconsistent.&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="72"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="73"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a54ba495e8544da884ae1cd183b00b02e" kindref="member">accepted_iterations</ref><sp/>&lt;<sp/>0<sp/>||<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a97fea022621b1636c6d98d44e4acf17c" kindref="member">attempted_iterations</ref><sp/>!=<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a54ba495e8544da884ae1cd183b00b02e" kindref="member">accepted_iterations</ref><sp/>||</highlight></codeline>
<codeline lineno="74"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa03e8e71623874a7e7dd29b3def718bc" kindref="member">line_search_trials</ref><sp/>&lt;<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a54ba495e8544da884ae1cd183b00b02e" kindref="member">accepted_iterations</ref><sp/>||<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa9987f7be887e8b8427e42e7eee02f3c" kindref="member">rejected_trials</ref><sp/>&lt;<sp/>0<sp/>||</highlight></codeline>
<codeline lineno="75"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa03e8e71623874a7e7dd29b3def718bc" kindref="member">line_search_trials</ref><sp/>-<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a54ba495e8544da884ae1cd183b00b02e" kindref="member">accepted_iterations</ref><sp/>!=<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1aa9987f7be887e8b8427e42e7eee02f3c" kindref="member">rejected_trials</ref><sp/>||</highlight></codeline>
<codeline lineno="76"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a60376f39e17f7ac5a59a23e3ae49491a" kindref="member">geometry_limited_iterations</ref><sp/>&lt;<sp/>0<sp/>||<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a60376f39e17f7ac5a59a23e3ae49491a" kindref="member">geometry_limited_iterations</ref><sp/>&gt;<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a97fea022621b1636c6d98d44e4acf17c" kindref="member">attempted_iterations</ref><sp/>||</highlight></codeline>
<codeline lineno="77"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a8bdb43e05a71be4ceffa01b07ba6196c" kindref="member">total_linear_iterations</ref><sp/>&lt;<sp/>0<sp/>||</highlight></codeline>
<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>!std::isfinite(diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a962bf9dff1931e4adb65a4ed992cd6b7" kindref="member">last_accepted_step</ref>)<sp/>||<sp/>diagnostics.<ref refid="structserif_1_1solver_1_1_solve_diagnostics_1a962bf9dff1931e4adb65a4ed992cd6b7" kindref="member">last_accepted_step</ref><sp/>&lt;<sp/>0.0)<sp/>{</highlight></codeline>
<codeline lineno="79"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>work<sp/>counters<sp/>do<sp/>not<sp/>describe<sp/>an<sp/>accepted<sp/>Newton<sp/>boundary.&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="81"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::nullopt;</highlight></codeline>
<codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="83"><highlight class="normal"></highlight></codeline>
<codeline lineno="85"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>State&gt;</highlight></codeline>
<codeline lineno="86" refid="structserif_1_1solver_1_1_newton_checkpoint" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_newton_checkpoint" kindref="compound">NewtonCheckpoint</ref><sp/>{</highlight></codeline>
<codeline lineno="87"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>State<sp/><ref refid="structserif_1_1solver_1_1_newton_checkpoint_1a5b01b64c7ac8657ad97d29269d08526f" kindref="member">state</ref>;</highlight></codeline>
<codeline lineno="88"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_newton_progress" kindref="compound">NewtonProgress</ref><sp/><ref refid="structserif_1_1solver_1_1_newton_checkpoint_1a0abac0ed6bcc6bd5121d7b10a3e49507" kindref="member">progress</ref>;</highlight></codeline>
<codeline lineno="89"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="90"><highlight class="normal"></highlight></codeline>
<codeline lineno="92"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464" kindref="member">EventKind</ref><sp/>{<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464acc51b81974287ab79cef9e94fe778cc9" kindref="member">initial</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464a57054ff3283d5f50b905c8d1a492c8a3" kindref="member">before_iteration</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464a8746f4ec6db7fdda6018d314e8c3ae02" kindref="member">trial_rejected</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464a6e563563af598fa7575b0944e785a7d5" kindref="member">before_accept</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464a3e4d891a5df3d6d0d7dd9432a1bc6470" kindref="member">accepted</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464aa5d7ceb2c59b8cee46c2953fec9abc19" kindref="member">finished</ref>,<sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464a121ad2eb76415d284215a4c9deddf79c" kindref="member">resumed</ref><sp/>};</highlight></codeline>
<codeline lineno="93"><highlight class="normal"></highlight></codeline>
<codeline lineno="95"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1af4b1a8caa8d8f54f51fc013688c7b21c" kindref="member">SolveControl</ref><sp/>{<sp/><ref refid="namespaceserif_1_1solver_1af4b1a8caa8d8f54f51fc013688c7b21ca1c2afff196eca9b02ad6a8dcc4aee0e0" kindref="member">continue_solve</ref>,<sp/><ref refid="namespaceserif_1_1solver_1af4b1a8caa8d8f54f51fc013688c7b21caef399b2d446bb37b7c32ad2cc1b6045b" kindref="member">stop</ref><sp/>};</highlight></codeline>
<codeline lineno="96"><highlight class="normal"></highlight></codeline>
<codeline lineno="98" refid="structserif_1_1solver_1_1_solve_event" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_solve_event" kindref="compound">SolveEvent</ref><sp/>{</highlight></codeline>
<codeline lineno="99"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1a6fa8bbc306fbf990b16ade9fb7771464" kindref="member">EventKind</ref><sp/><ref refid="structserif_1_1solver_1_1_solve_event_1ab7f3f13ffa9611e9e12a3bdee0b07871" kindref="member">kind</ref>;</highlight></codeline>
<codeline lineno="100"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_event_1a2a6a0d11d26a885969de80a22936393a" kindref="member">iteration</ref>{0};</highlight></codeline>
<codeline lineno="101"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_event_1a35f7be83c45e387565c91730949fff29" kindref="member">trial</ref>{0};</highlight></codeline>
<codeline lineno="102"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_event_1ae139ae0d372e37d677a6e93f7e4cee56" kindref="member">step</ref>{0.0};</highlight></codeline>
<codeline lineno="103"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;MetricEvaluation&gt;<sp/><ref refid="structserif_1_1solver_1_1_solve_event_1a6d0116911be82d489f9adfa03a43c9d7" kindref="member">metric</ref>;</highlight></codeline>
<codeline lineno="104"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="structserif_1_1solver_1_1_solve_event_1a93c36f16788b776a5407ae6dad249232" kindref="member">message</ref>;</highlight></codeline>
<codeline lineno="105"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref>&amp;<sp/><ref refid="structserif_1_1solver_1_1_solve_event_1a6e72e41a44597dcd1618da3dd82d10df" kindref="member">diagnostics</ref>;</highlight></codeline>
<codeline lineno="106"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="107"><highlight class="normal"></highlight></codeline>
<codeline lineno="109" refid="structserif_1_1solver_1_1_no_observer" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_no_observer" kindref="compound">NoObserver</ref><sp/>{</highlight></codeline>
<codeline lineno="111"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_no_observer_1a5e2233e3ee68d7176ae1da6fe8319bd2" kindref="member">operator()</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_event" kindref="compound">SolveEvent</ref>&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{}</highlight></codeline>
<codeline lineno="112"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="113"><highlight class="normal"></highlight></codeline>
<codeline lineno="115" refid="structserif_1_1solver_1_1_no_model" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_no_model" kindref="compound">NoModel</ref><sp/>{};</highlight></codeline>
<codeline lineno="116"><highlight class="normal"></highlight></codeline>
<codeline lineno="122"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>State,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>System,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Model<sp/>=<sp/>NoModel&gt;</highlight></codeline>
<codeline lineno="123" refid="classserif_1_1solver_1_1_solve_result" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1solver_1_1_solve_result_1a16b319ba4fa951fba242eecd092c2fd9" kindref="member">SolveResult</ref><sp/>{</highlight></codeline>
<codeline lineno="124"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="126"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a16b319ba4fa951fba242eecd092c2fd9" kindref="member">SolveResult</ref>(std::shared_ptr&lt;const<sp/>Model&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a257baac3cc44e9c8baaee2f3198379c7" kindref="member">model</ref><sp/>=<sp/>{})<sp/>:<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a5fbfe07cefb396b0b444be8df4486a96" kindref="member">m_model</ref>(std::move(<ref refid="classserif_1_1solver_1_1_solve_result_1a257baac3cc44e9c8baaee2f3198379c7" kindref="member">model</ref>))<sp/>{}</highlight></codeline>
<codeline lineno="127"><highlight class="normal"></highlight></codeline>
<codeline lineno="129"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aa86839c348ee76c237bc628816005bdf" kindref="member">converged</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aabad407d66810c63db32fbe06955d74a" kindref="member">m_status</ref><sp/>==<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a7de33615d7fbc1cb7bc608d12f1993d2" kindref="member">SolveStatus::converged</ref>;<sp/>}</highlight></codeline>
<codeline lineno="131"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1afad01e45c78da89088a3bc31b9e1f8b3" kindref="member">has_state</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ab01e362bfa7b8ffda73f499017de6242" kindref="member">m_state</ref>.has_value();<sp/>}</highlight></codeline>
<codeline lineno="133"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>State&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ac81485d04d69072defdfcca1db9d0bd4" kindref="member">state</ref>()</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="134"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1utils_1_1errors_1a7fefa3a63ca7895a875f2672026df02d" kindref="member">utils::errors::serif_ensure&lt;utils::errors::SERiFErrorCode::INVALID_ARGUMENT&gt;</ref>(<ref refid="classserif_1_1solver_1_1_solve_result_1afad01e45c78da89088a3bc31b9e1f8b3" kindref="member">has_state</ref>(),</highlight></codeline>
<codeline lineno="135"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;This<sp/>solve<sp/>has<sp/>no<sp/>accepted<sp/>stellar<sp/>state.<sp/>Inspect<sp/>status()<sp/>and<sp/>message()<sp/>before<sp/>requesting<sp/>its<sp/>state.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="136"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>*<ref refid="classserif_1_1solver_1_1_solve_result_1ab01e362bfa7b8ffda73f499017de6242" kindref="member">m_state</ref>;</highlight></codeline>
<codeline lineno="137"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="139"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::shared_ptr&lt;const<sp/>System&gt;&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a8c8185166efe56073e69a65e21820086" kindref="member">system</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a24147bc1d1b560e3ff9f6d59fd2748bc" kindref="member">m_system</ref>;<sp/>}</highlight></codeline>
<codeline lineno="141"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Model&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a257baac3cc44e9c8baaee2f3198379c7" kindref="member">model</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>(!std::same_as&lt;Model,<sp/>NoModel&gt;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>*<ref refid="classserif_1_1solver_1_1_solve_result_1a5fbfe07cefb396b0b444be8df4486a96" kindref="member">m_model</ref>;<sp/>}</highlight></codeline>
<codeline lineno="143"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref>&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a1e49da26f2a4783af2007811c0293aa0" kindref="member">diagnostics</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ac73480e798eb33f5c65ac1694b7f4443" kindref="member">m_diagnostics</ref>;<sp/>}</highlight></codeline>
<codeline lineno="145"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64" kindref="member">SolveStatus</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1af73bea6544604b010c0887e57393bcaf" kindref="member">status</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aabad407d66810c63db32fbe06955d74a" kindref="member">m_status</ref>;<sp/>}</highlight></codeline>
<codeline lineno="147"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a4701ad23a897afcb2a8f2e28ade56a57" kindref="member">message</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a5e1362da192597f61b98f7d9ac663ade" kindref="member">m_message</ref>;<sp/>}</highlight></codeline>
<codeline lineno="148"><highlight class="normal"></highlight></codeline>
<codeline lineno="150"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a91ef8dde02af95afe60ca8426e7abc45" kindref="member">has_checkpoint</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aac4a8443cf9da5163697a59cebe4a2ee" kindref="member">m_progress</ref>.has_value();<sp/>}</highlight></codeline>
<codeline lineno="152"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="structserif_1_1solver_1_1_newton_checkpoint" kindref="compound">NewtonCheckpoint&lt;State&gt;</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a4f96d193867f69959b087edc438a1f9e" kindref="member">checkpoint</ref>()</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="153"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1utils_1_1errors_1a7fefa3a63ca7895a875f2672026df02d" kindref="member">utils::errors::serif_ensure&lt;utils::errors::SERiFErrorCode::INVALID_ARGUMENT&gt;</ref>(<ref refid="classserif_1_1solver_1_1_solve_result_1afad01e45c78da89088a3bc31b9e1f8b3" kindref="member">has_state</ref>()<sp/>&amp;&amp;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a91ef8dde02af95afe60ca8426e7abc45" kindref="member">has_checkpoint</ref>(),</highlight></codeline>
<codeline lineno="154"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;This<sp/>result<sp/>has<sp/>no<sp/>supported<sp/>Newton<sp/>checkpoint.<sp/>Checkpointing<sp/>requires<sp/>an<sp/>accepted<sp/>state<sp/>with<sp/>StandardNewton,<sp/>NormalizedResidualMetric<sp/>and<sp/>FGMRES;<sp/>custom<sp/>policies<sp/>need<sp/>an<sp/>explicit<sp/>history<sp/>restoration<sp/>implementation.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="155"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{.state<sp/>=<sp/>*<ref refid="classserif_1_1solver_1_1_solve_result_1ab01e362bfa7b8ffda73f499017de6242" kindref="member">m_state</ref>,<sp/>.progress<sp/>=<sp/>*<ref refid="classserif_1_1solver_1_1_solve_result_1aac4a8443cf9da5163697a59cebe4a2ee" kindref="member">m_progress</ref>};</highlight></codeline>
<codeline lineno="156"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="158"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a4f96d193867f69959b087edc438a1f9e" kindref="member">checkpoint</ref>(<ref refid="structserif_1_1solver_1_1_newton_progress" kindref="compound">NewtonProgress</ref><sp/>progress)<sp/>{<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aac4a8443cf9da5163697a59cebe4a2ee" kindref="member">m_progress</ref><sp/>=<sp/>std::move(progress);<sp/>}</highlight></codeline>
<codeline lineno="159"><highlight class="normal"></highlight></codeline>
<codeline lineno="161"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a8b2438788d6aee37dc72d4fc286c833f" kindref="member">accept</ref>(State<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ac81485d04d69072defdfcca1db9d0bd4" kindref="member">state</ref>,<sp/>std::shared_ptr&lt;const<sp/>System&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a8c8185166efe56073e69a65e21820086" kindref="member">system</ref>)<sp/>{</highlight></codeline>
<codeline lineno="162"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ab01e362bfa7b8ffda73f499017de6242" kindref="member">m_state</ref><sp/>=<sp/>std::move(<ref refid="classserif_1_1solver_1_1_solve_result_1ac81485d04d69072defdfcca1db9d0bd4" kindref="member">state</ref>);</highlight></codeline>
<codeline lineno="163"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a24147bc1d1b560e3ff9f6d59fd2748bc" kindref="member">m_system</ref><sp/>=<sp/>std::move(<ref refid="classserif_1_1solver_1_1_solve_result_1a8c8185166efe56073e69a65e21820086" kindref="member">system</ref>);</highlight></codeline>
<codeline lineno="164"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="166"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1af55880088add43cb3c80a120e7098c10" kindref="member">finish</ref>(<ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64" kindref="member">SolveStatus</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1af73bea6544604b010c0887e57393bcaf" kindref="member">status</ref>,<sp/>std::string<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a4701ad23a897afcb2a8f2e28ade56a57" kindref="member">message</ref>,<sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a1e49da26f2a4783af2007811c0293aa0" kindref="member">diagnostics</ref>)<sp/>{</highlight></codeline>
<codeline lineno="167"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aabad407d66810c63db32fbe06955d74a" kindref="member">m_status</ref><sp/>=<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1af73bea6544604b010c0887e57393bcaf" kindref="member">status</ref>;</highlight></codeline>
<codeline lineno="168"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a5e1362da192597f61b98f7d9ac663ade" kindref="member">m_message</ref><sp/>=<sp/>std::move(<ref refid="classserif_1_1solver_1_1_solve_result_1a4701ad23a897afcb2a8f2e28ade56a57" kindref="member">message</ref>);</highlight></codeline>
<codeline lineno="169"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ac73480e798eb33f5c65ac1694b7f4443" kindref="member">m_diagnostics</ref><sp/>=<sp/>std::move(<ref refid="classserif_1_1solver_1_1_solve_result_1a1e49da26f2a4783af2007811c0293aa0" kindref="member">diagnostics</ref>);</highlight></codeline>
<codeline lineno="170"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="171"><highlight class="normal"></highlight></codeline>
<codeline lineno="172"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="173"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::shared_ptr&lt;const<sp/>Model&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a5fbfe07cefb396b0b444be8df4486a96" kindref="member">m_model</ref>;</highlight></codeline>
<codeline lineno="174"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;State&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ab01e362bfa7b8ffda73f499017de6242" kindref="member">m_state</ref>;</highlight></codeline>
<codeline lineno="175"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::shared_ptr&lt;const<sp/>System&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a24147bc1d1b560e3ff9f6d59fd2748bc" kindref="member">m_system</ref>;</highlight></codeline>
<codeline lineno="176"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;NewtonProgress&gt;<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aac4a8443cf9da5163697a59cebe4a2ee" kindref="member">m_progress</ref>;</highlight></codeline>
<codeline lineno="177"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64" kindref="member">SolveStatus</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1aabad407d66810c63db32fbe06955d74a" kindref="member">m_status</ref>{<ref refid="namespaceserif_1_1solver_1a0c5b4c0a272429c1c5807ebb757aad64a00284e15e20ba8bd246e70c06567efbd" kindref="member">SolveStatus::initial_state_rejected</ref>};</highlight></codeline>
<codeline lineno="178"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="classserif_1_1solver_1_1_solve_result_1a5e1362da192597f61b98f7d9ac663ade" kindref="member">m_message</ref>;</highlight></codeline>
<codeline lineno="179"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref><sp/><ref refid="classserif_1_1solver_1_1_solve_result_1ac73480e798eb33f5c65ac1694b7f4443" kindref="member">m_diagnostics</ref>;</highlight></codeline>
<codeline lineno="180"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="181"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/solver/nonlinear/result.hpp"/>
  </compounddef>
</doxygen>