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)
56 lines
3.3 KiB
TeX
56 lines
3.3 KiB
TeX
\doxysection{src/include/serif/eos/runtime/concepts.hpp File Reference}
|
|
\hypertarget{eos_2runtime_2concepts_8hpp}{}\label{eos_2runtime_2concepts_8hpp}\index{src/include/serif/eos/runtime/concepts.hpp@{src/include/serif/eos/runtime/concepts.hpp}}
|
|
|
|
|
|
File containing concepts for the eos runtime module. These concepts are used to constrain template parameters in the eos runtime module.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/eos/models/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/runtime/details.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{eos_2runtime_2concepts_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=219pt]{eos_2runtime_2concepts_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1eos}{serif\+::eos}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1eos_1_1runtime}{serif\+::eos\+::runtime}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1runtime_1_1_runtime_e_o_s_model}{serif\+::eos\+::runtime\+::\+Runtime\+EOSModel}}
|
|
\begin{DoxyCompactList}\small\item\em A concept to determine if a type is a valid runtime EOS model. A type is a valid Runtime\+EOSModel if it satisfies the EOSModel concept and if its Relations catalog is supported by the runtime system. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Runtime\+EOSModel EOSCandidate$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1eos_1_1runtime_af34d4e019ddbfd7eca9b4c20fddbae2f}{serif\+::eos\+::runtime\+::\+Runtime\+EOSAdapter}} = \mbox{\hyperlink{structserif_1_1eos_1_1runtime_1_1_runtime_catalog_dispatch}{Runtime\+Catalog\+Dispatch}}$<$EOSCandidate, typename EOSCandidate\+::\+Relations$>$
|
|
\begin{DoxyCompactList}\small\item\em A helper alias to adapt a runtime EOS model to the runtime catalog dispatch system. This is used to simplify the usage of runtime EOS models in the runtime system. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Runtime\+EOSModel EOSCandidate$>$ }\\constexpr std\+::span$<$ const \mbox{\hyperlink{structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor}{dimensions\+::runtime\+::\+Runtime\+Relation\+Descriptor}} $>$ \mbox{\hyperlink{namespaceserif_1_1eos_1_1runtime_a25ab7f40da798676afd459e004a8c06d}{serif\+::eos\+::runtime\+::runtime\+Relation\+Descriptors}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em A helper function to get the runtime relation descriptors for a runtime EOS model. This is used to simplify the usage of runtime EOS models in the runtime system. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing concepts for the eos runtime module. These concepts are used to constrain template parameters in the eos runtime module.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|