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,60 @@
\doxysection{src/include/serif/discretization/blocks/runtime.hpp File Reference}
\hypertarget{discretization_2blocks_2runtime_8hpp}{}\label{discretization_2blocks_2runtime_8hpp}\index{src/include/serif/discretization/blocks/runtime.hpp@{src/include/serif/discretization/blocks/runtime.hpp}}
Runtime descriptors for fields and terms, used to project compile time types into runtime values.
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
{\ttfamily \#include "{}serif/discretization/blocks/concepts.\+hpp"{}}\newline
Include dependency graph for runtime.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{discretization_2blocks_2runtime_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]{discretization_2blocks_2runtime_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_field_descriptor}{serif\+::discretization\+::blocks\+::\+Field\+Descriptor}}
\begin{DoxyCompactList}\small\item\em Runtime descriptor for a field, containing its name. Two Field\+Descriptors are equal if they have identical names. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_term_descriptor}{serif\+::discretization\+::blocks\+::\+Term\+Descriptor}}
\begin{DoxyCompactList}\small\item\em Runtime descriptor for a term, containing its associated field and name. Two Term\+Descriptors are equal if they have identical fields and names. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1blocks_1_1_field_descriptor_01_4}{std\+::formatter$<$ serif\+::discretization\+::blocks\+::\+Field\+Descriptor $>$}}
\begin{DoxyCompactList}\small\item\em Specialization of std\+::formatter for Field\+Descriptor and Term\+Descriptor to enable formatting with std\+::format. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1blocks_1_1_term_descriptor_01_4}{std\+::formatter$<$ serif\+::discretization\+::blocks\+::\+Term\+Descriptor $>$}}
\begin{DoxyCompactList}\small\item\em Specialization of std\+::formatter for Term\+Descriptor to enable formatting with std\+::format. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks}{serif\+::discretization\+::blocks}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Variables}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Field FieldT$>$ }\\constexpr \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_field_descriptor}{Field\+Descriptor}} \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a979c72b7f7e82015163d35bf5a970d90}{serif\+::discretization\+::blocks\+::field\+\_\+descriptor}} \{.name = Field\+T\+::name\}
\begin{DoxyCompactList}\small\item\em Create a \doxylink{structserif_1_1discretization_1_1blocks_1_1_field_descriptor}{Field\+Descriptor} for a given field type. \end{DoxyCompactList}\item
{\footnotesize template$<$Term TermT$>$ }\\constexpr \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_term_descriptor}{Term\+Descriptor}} \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aa9f0d01c3fa0c64f62d684acf9f7ae27}{serif\+::discretization\+::blocks\+::term\+\_\+descriptor}}
\begin{DoxyCompactList}\small\item\em Create a \doxylink{structserif_1_1discretization_1_1blocks_1_1_term_descriptor}{Term\+Descriptor} for a given term type. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Runtime descriptors for fields and terms, used to project compile time types into runtime values.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}