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)
47 lines
1.8 KiB
TeX
47 lines
1.8 KiB
TeX
\doxysection{src/include/serif/equations/registry.hpp File Reference}
|
|
\hypertarget{registry_8hpp}{}\label{registry_8hpp}\index{src/include/serif/equations/registry.hpp@{src/include/serif/equations/registry.hpp}}
|
|
|
|
|
|
System for registering multiple equations. The idea here is that a model will be defined partly by an equation registry (e.\+g. all the equations that must be satisfied for a given model).
|
|
|
|
|
|
{\ttfamily \#include $<$tuple$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/equations/concepts.\+hpp"{}}\newline
|
|
Include dependency graph for registry.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{registry_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
This graph shows which files directly or indirectly include this file\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{registry_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1equations_1_1_equation_registry}{serif\+::equations\+::\+Equation\+Registry$<$ Equation\+Ts $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A compile-\/time registry of equations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
System for registering multiple equations. The idea here is that a model will be defined partly by an equation registry (e.\+g. all the equations that must be satisfied for a given model).
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|