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)
57 lines
3.0 KiB
TeX
57 lines
3.0 KiB
TeX
\doxysection{src/include/serif/discretization/forms/runtime.hpp File Reference}
|
|
\hypertarget{discretization_2forms_2runtime_8hpp}{}\label{discretization_2forms_2runtime_8hpp}\index{src/include/serif/discretization/forms/runtime.hpp@{src/include/serif/discretization/forms/runtime.hpp}}
|
|
|
|
|
|
file defining some utilities to project form information from compile time into runtime
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include $<$format$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/runtime.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/forms/concept.\+hpp"{}}\newline
|
|
Include dependency graph for runtime.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2forms_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_2forms_2runtime_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_descriptor}{serif\+::discretization\+::forms\+::\+Form\+Descriptor}}
|
|
\begin{DoxyCompactList}\small\item\em Runtime form descriptor including runtime term information. Used to represented the compile-\/time form type at runtime. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1forms_1_1_form_descriptor_01_4}{std\+::formatter$<$ serif\+::discretization\+::forms\+::\+Form\+Descriptor $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Overload to allow println for Form\+Descriptors. \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_1forms}{serif\+::discretization\+::forms}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Form FormT$>$ }\\constexpr \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_descriptor}{Form\+Descriptor}} \mbox{\hyperlink{namespaceserif_1_1discretization_1_1forms_aa9c9e5345d458df1a069b05fccf45394}{serif\+::discretization\+::forms\+::form\+\_\+descriptor}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of the \doxylink{structserif_1_1discretization_1_1forms_1_1_form_descriptor}{Form\+Descriptor} class at compile time for some particular compile-\/time form. This allows us to generate constexpr instances of this struct at compile time and usable at runtime. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
file defining some utilities to project form information from compile time into runtime
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|