MeanField_SERiF/docs/xml/strategies_2surface_2calibrated__mass_8cpp.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="strategies_2surface_2calibrated__mass_8cpp" kind="file" language="C++">
    <compoundname>calibrated_mass.cpp</compoundname>
    <includes refid="strategies_2surface_2calibrated__mass_8hpp" local="yes">serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp</includes>
    <includes local="no">cmath</includes>
    <incdepgraph>
      <node id="8">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>serif/solver/preconditioner/failure.hpp</label>
        <link refid="solver_2preconditioner_2failure_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/solver/preconditioner/strategies/inverse/diagonal_regularization.hpp</label>
        <link refid="diagonal__regularization_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp</label>
        <link refid="strategies_2surface_2calibrated__mass_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/lib/serif/solver/preconditioner/strategies/surface/calibrated_mass.cpp</label>
        <link refid="strategies_2surface_2calibrated__mass_8cpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>cmath</label>
      </node>
      <node id="13">
        <label>cstddef</label>
      </node>
      <node id="7">
        <label>cstdint</label>
      </node>
      <node id="3">
        <label>expected</label>
      </node>
      <node id="11">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="5">
        <label>string</label>
      </node>
      <node id="10">
        <label>type_traits</label>
      </node>
      <node id="9">
        <label>unordered_map</label>
      </node>
    </incdepgraph>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner">serif::solver::preconditioner</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies">serif::solver::preconditioner::strategies</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface">serif::solver::preconditioner::strategies::surface</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&quot;<ref refid="strategies_2surface_2calibrated__mass_8hpp" kindref="compound">serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp</ref>&quot;</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;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface" kindref="compound">serif::solver::preconditioner::strategies::surface</ref></highlight></codeline>
<codeline lineno="6"><highlight class="normal">{</highlight></codeline>
<codeline lineno="7"><highlight class="normal"><sp/><sp/><sp/><sp/>std::expected&lt;SurfaceMassFit,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1aab4d374bcad901242fb8aba2dc170a6e" kindref="member">try_fit_surface_mass</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>numerator,<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>denominator,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1a5a1ecfdc4d0dd17d3e40c197ff2b73c6" kindref="member">CalibrationObjective</ref><sp/>objective)</highlight></codeline>
<codeline lineno="8"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="9"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" kindref="member">utils::errors::SERiFErrorCode</ref>;</highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!std::isfinite(numerator)<sp/>||<sp/>!std::isfinite(denominator)<sp/>||<sp/>denominator<sp/>&lt;=<sp/>0.0<sp/>||<sp/>numerator<sp/>==<sp/>0.0)</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="13"><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/>std::unexpected(Failure{.code<sp/>=<sp/>SERiFErrorCode::PRECONDITIONER_INVALID_CALIBRATION,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Surface<sp/>mass<sp/>calibration<sp/>requires<sp/>finite<sp/>nonzero<sp/>correlation<sp/>and<sp/>positive<sp/>probe<sp/>energy.<sp/>Choose<sp/>a<sp/>resolved<sp/>nonzero<sp/>physical<sp/>target.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(objective<sp/>!=<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1a5a1ecfdc4d0dd17d3e40c197ff2b73c6a55b711669591e3cb8e7075982eefd616" kindref="member">CalibrationObjective::operator_action</ref><sp/>&amp;&amp;<sp/>objective<sp/>!=<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1a5a1ecfdc4d0dd17d3e40c197ff2b73c6af0b88e4644862f60d9d038cb06160142" kindref="member">CalibrationObjective::right_preconditioned_action</ref>)</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="17"><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/>std::unexpected(Failure{.code<sp/>=<sp/>SERiFErrorCode::PRECONDITIONER_INVALID_OPTIONS,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Surface<sp/>mass<sp/>calibration<sp/>requires<sp/>an<sp/>operator-action<sp/>or<sp/>right-preconditioned-action<sp/>objective.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065caa2375dfa839ccd84978745547605b21e4" kindref="member">multiplier</ref><sp/>=<sp/>numerator<sp/>/<sp/>denominator;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>scale<sp/>=<sp/>objective<sp/>==<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1a5a1ecfdc4d0dd17d3e40c197ff2b73c6a55b711669591e3cb8e7075982eefd616" kindref="member">CalibrationObjective::operator_action</ref><sp/>?<sp/><ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065caa2375dfa839ccd84978745547605b21e4" kindref="member">multiplier</ref><sp/>:<sp/>1.0<sp/>/<sp/><ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065caa2375dfa839ccd84978745547605b21e4" kindref="member">multiplier</ref>;</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>inverse_multiplier<sp/>=<sp/>1.0<sp/>/<sp/>scale;</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!std::isfinite(scale)<sp/>||<sp/>scale<sp/>==<sp/>0.0<sp/>||<sp/>!std::isfinite(inverse_multiplier)<sp/>||<sp/>inverse_multiplier<sp/>==<sp/>0.0)</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="24"><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/>std::unexpected(Failure{.code<sp/>=<sp/>SERiFErrorCode::PRECONDITIONER_INVALID_CALIBRATION,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;The<sp/>fitted<sp/>surface<sp/>mass<sp/>scale<sp/>or<sp/>its<sp/>inverse<sp/>is<sp/>not<sp/>finite<sp/>and<sp/>nonzero.<sp/>Rescale<sp/>the<sp/>reference<sp/>units<sp/>or<sp/>choose<sp/>another<sp/>target.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1_1_surface_mass_fit" kindref="compound">SurfaceMassFit</ref>{.numerator<sp/>=<sp/>numerator,<sp/>.denominator<sp/>=<sp/>denominator,<sp/>.scale<sp/>=<sp/>scale,<sp/>.inverse_multiplier<sp/>=<sp/>inverse_multiplier};</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="28"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::solver::preconditioner::strategies::surface</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/lib/serif/solver/preconditioner/strategies/surface/calibrated_mass.cpp"/>
  </compounddef>
</doxygen>