docs(docs): built docs

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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,47 @@
\doxysection{serif\+::equations\+::Contributions\texorpdfstring{$<$}{<} T, typename \texorpdfstring{$>$}{>} Struct Template Reference}
\hypertarget{structserif_1_1equations_1_1_contributions}{}\label{structserif_1_1equations_1_1_contributions}\index{serif::equations::Contributions$<$ T, typename $>$@{serif::equations::Contributions$<$ T, typename $>$}}
Helper struct to pack a list of contributions into a tuple. This is used to define the set of contributions of an equation.
{\ttfamily \#include $<$contributions.\+hpp$>$}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item
using \mbox{\hyperlink{structserif_1_1equations_1_1_contributions_a81c2e79e3478c29ca2053a9c803cadb6}{type}} = std\+::tuple$<$T$>$
\begin{DoxyCompactList}\small\item\em tuple of whatever is T \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename T, typename = void$>$\newline
struct serif\+::equations\+::\+Contributions$<$ T, typename $>$}
Helper struct to pack a list of contributions into a tuple. This is used to define the set of contributions of an equation.
\begin{DoxyTemplParams}{Template Parameters}
{\em T} & The type to pack into a tuple of contributions. This can be a single contribution or a tuple of contributions. \\
\hline
\end{DoxyTemplParams}
\doxysubsection{Member Typedef Documentation}
\Hypertarget{structserif_1_1equations_1_1_contributions_a81c2e79e3478c29ca2053a9c803cadb6}\index{serif::equations::Contributions$<$ T, typename $>$@{serif::equations::Contributions$<$ T, typename $>$}!type@{type}}
\index{type@{type}!serif::equations::Contributions$<$ T, typename $>$@{serif::equations::Contributions$<$ T, typename $>$}}
\doxysubsubsection{\texorpdfstring{type}{type}}
{\footnotesize\ttfamily \label{structserif_1_1equations_1_1_contributions_a81c2e79e3478c29ca2053a9c803cadb6}
template$<$typename T, typename = void$>$ \\
using \mbox{\hyperlink{structserif_1_1equations_1_1_contributions}{serif\+::equations\+::\+Contributions}}$<$ T, typename $>$\+::type = std\+::tuple$<$T$>$}
tuple of whatever is T
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
src/include/serif/equations/\mbox{\hyperlink{equations_2contributions_8hpp}{contributions.\+hpp}}\end{DoxyCompactItemize}