Files
MeanField_SERiF/docs/xml/structserif_1_1equations_1_1_contributions.xml

53 lines
2.5 KiB
XML
Raw Normal View History

<?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="structserif_1_1equations_1_1_contributions" kind="struct" language="C++" prot="public">
<compoundname>serif::equations::Contributions</compoundname>
<includes local="no">contributions.hpp</includes>
<templateparamlist>
<param>
<type>typename T</type>
</param>
<param>
<type>typename</type>
<defval>void</defval>
</param>
</templateparamlist>
<sectiondef kind="public-type">
<memberdef kind="typedef" id="structserif_1_1equations_1_1_contributions_1a81c2e79e3478c29ca2053a9c803cadb6" prot="public" static="no">
<type>std::tuple&lt; T &gt;</type>
<definition>using serif::equations::Contributions&lt; T, typename &gt;::type = std::tuple&lt;T&gt;</definition>
<argsstring></argsstring>
<name>type</name>
<qualifiedname>serif::equations::Contributions::type</qualifiedname>
<briefdescription>
<para>tuple of whatever is T </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/equations/contributions.hpp" line="135" column="9" bodyfile="src/include/serif/equations/contributions.hpp" bodystart="135" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Helper struct to pack a list of contributions into a tuple. This is used to define the set of contributions of an equation. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>T</parametername>
</parameternamelist>
<parameterdescription>
<para>The type to pack into a tuple of contributions. This can be a single contribution or a tuple of contributions. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<location file="src/include/serif/equations/contributions.hpp" line="134" column="5" bodyfile="src/include/serif/equations/contributions.hpp" bodystart="134" bodyend="136"/>
<listofallmembers>
<member refid="structserif_1_1equations_1_1_contributions_1a81c2e79e3478c29ca2053a9c803cadb6" prot="public" virt="non-virtual"><scope>serif::equations::Contributions</scope><name>type</name></member>
</listofallmembers>
</compounddef>
</doxygen>