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)
43 lines
1.7 KiB
XML
43 lines
1.7 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="conceptserif_1_1equations_1_1_equation" kind="concept">
|
|
<compoundname>serif::equations::Equation</compoundname>
|
|
<includes local="no">concepts.hpp</includes>
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<initializer>template<typename T>
|
|
concept <ref refid="conceptserif_1_1equations_1_1_equation" kindref="compound">serif::equations::Equation</ref> = requires {
|
|
typename T::Test;
|
|
{ T::name } -> std::convertible_to<std::string_view>;
|
|
} && ValidContributions<typename T::Test, ContributionsOf<T>>::value </initializer>
|
|
<briefdescription>
|
|
<para>A concept that defines the requirements for a valid SERiF equation. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><table rows="2" cols="1"><row>
|
|
<entry thead="yes"><para>Requirements</para>
|
|
</entry></row>
|
|
<row>
|
|
<entry thead="no"><para><itemizedlist>
|
|
<listitem>
|
|
<para>The equation must have a test type (::Test) and a name (::name). </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The name must be convertible to a std::string_view. </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The contributions of the equation must be valid for the test type, as defined by the ValidContributions struct.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</entry></row>
|
|
</table>
|
|
</para>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/equations/concepts.hpp" line="86" column="5"/>
|
|
</compounddef>
|
|
</doxygen>
|