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)
44 lines
1.6 KiB
TeX
44 lines
1.6 KiB
TeX
\doxysection{serif\+::equations\+::Equation Concept Reference}
|
|
\hypertarget{conceptserif_1_1equations_1_1_equation}{}\label{conceptserif_1_1equations_1_1_equation}\index{serif::equations::Equation@{serif::equations::Equation}}
|
|
|
|
|
|
A concept that defines the requirements for a valid SERiF equation.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$concepts.\+hpp$>$}
|
|
|
|
\doxysubsection{Concept definition}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{\textcolor{keyword}{template}<\textcolor{keyword}{typename}\ T>}
|
|
\DoxyCodeLine{\textcolor{keyword}{concept\ }\mbox{\hyperlink{conceptserif_1_1equations_1_1_equation}{serif::equations::Equation}}\ =\ \ \textcolor{keyword}{requires}\ \{}
|
|
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{keyword}{typename}\ T::Test;}
|
|
\DoxyCodeLine{\ \ \ \ \ \ \ \ \{\ T::name\ \}\ -\/>\ std::convertible\_to<std::string\_view>;}
|
|
\DoxyCodeLine{\ \ \ \ \}\ \&\&\ ValidContributions<typename\ T::Test,\ ContributionsOf<T>>::value}
|
|
|
|
\end{DoxyCode}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
A concept that defines the requirements for a valid SERiF equation.
|
|
|
|
\tabulinesep=1mm
|
|
\begin{longtabu}spread 0pt [c]{*{1}{|X[-1]}|}
|
|
\hline
|
|
\cellcolor{\tableheadbgcolor}\textbf{ Requirements}\\\cline{1-1}
|
|
\endfirsthead
|
|
\hline
|
|
\endfoot
|
|
\hline
|
|
\cellcolor{\tableheadbgcolor}\textbf{ Requirements}\\\cline{1-1}
|
|
\endhead
|
|
|
|
\begin{DoxyItemize}
|
|
\item The equation must have a test type (\+::\+Test) and a name (\+::name).
|
|
\item The name must be convertible to a std\+::string\+\_\+view.
|
|
\item The contributions of the equation must be valid for the test type, as defined by the Valid\+Contributions struct.
|
|
\end{DoxyItemize}\\\cline{1-1}
|
|
\end{longtabu}
|