Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
90 lines
5.1 KiB
XML
90 lines
5.1 KiB
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="namespaceserif_1_1operators_1_1detail" kind="namespace" language="C++">
|
|
<compoundname>serif::operators::detail</compoundname>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_as_key_list" prot="public">serif::operators::detail::AsKeyList</innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_as_key_list_3_01utils_1_1types_1_1_type_list_3_01_t_8_8_8_01_4_01_4" prot="public">serif::operators::detail::AsKeyList< utils::types::TypeList< T... > ></innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_columns" prot="public">serif::operators::detail::Columns</innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_columns_3_01utils_1_1types_1_1_type_list_3_01_o_8_8_8_01_4_01_4" prot="public">serif::operators::detail::Columns< utils::types::TypeList< O... > ></innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_contribution_children" prot="public">serif::operators::detail::ContributionChildren</innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_contribution_operands" prot="public">serif::operators::detail::ContributionOperands</innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_contribution_operands_3_01std_1_1tuple_3_01_c_8_8_8_01_4_01_4" prot="public">serif::operators::detail::ContributionOperands< std::tuple< C... > ></innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_coupling_form" prot="public">serif::operators::detail::CouplingForm</innerclass>
|
|
<innerclass refid="structserif_1_1operators_1_1detail_1_1_join" prot="public">serif::operators::detail::Join</innerclass>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1operators_1_1detail_1ac8fb0d1f638701b243724fd18d084d84" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename EquationT</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::operators::detail::bind_contributions</definition>
|
|
<argsstring>(std::shared_ptr< const EquationT > equation, double coefficient)</argsstring>
|
|
<name>bind_contributions</name>
|
|
<qualifiedname>serif::operators::detail::bind_contributions</qualifiedname>
|
|
<param>
|
|
<type>std::shared_ptr< const EquationT ></type>
|
|
<declname>equation</declname>
|
|
</param>
|
|
<param>
|
|
<type>double</type>
|
|
<declname>coefficient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Flatten equation arithmetic while preserving every generated tuple and borrowed parent. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/operators/contributions.hpp" line="36" column="15" bodyfile="src/include/serif/operators/contributions.hpp" bodystart="36" bodyend="51"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1operators_1_1detail_1a5628ff21c25ad64ca69255e8eace4afc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename EquationT</type>
|
|
</param>
|
|
<param>
|
|
<type>typename FunctionT</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::operators::detail::visit_contributions</definition>
|
|
<argsstring>(const EquationT &equation, FunctionT &function, std::size_t &index, double coefficient)</argsstring>
|
|
<name>visit_contributions</name>
|
|
<qualifiedname>serif::operators::detail::visit_contributions</qualifiedname>
|
|
<param>
|
|
<type>const EquationT &</type>
|
|
<declname>equation</declname>
|
|
</param>
|
|
<param>
|
|
<type>FunctionT &</type>
|
|
<declname>function</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::size_t &</type>
|
|
<declname>index</declname>
|
|
</param>
|
|
<param>
|
|
<type>double</type>
|
|
<declname>coefficient</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Visit arithmetic leaves without retaining them beyond the supplied callback. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/operators/contributions.hpp" line="55" column="14" bodyfile="src/include/serif/operators/contributions.hpp" bodystart="55" bodyend="66"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/operators/contributions.hpp" line="19" column="5"/>
|
|
</compounddef>
|
|
</doxygen>
|