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)
66 lines
5.8 KiB
TeX
66 lines
5.8 KiB
TeX
\doxysection{src/include/serif/model/detail/specification\+\_\+endpoints.hpp File Reference}
|
|
\hypertarget{specification__endpoints_8hpp}{}\label{specification__endpoints_8hpp}\index{src/include/serif/model/detail/specification\_endpoints.hpp@{src/include/serif/model/detail/specification\_endpoints.hpp}}
|
|
{\ttfamily \#include "{}serif/model/specification.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/specifications/physical\+\_\+names.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/concepts/filter.\+hpp"{}}\newline
|
|
Include dependency graph for specification\+\_\+endpoints.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{specification__endpoints_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]{specification__endpoints_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_endpoint_owner}{serif\+::model\+::detail\+::\+Endpoint\+Owner$<$ Endpoint $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Recognize generated endpoint identities without interpreting unrelated physical names. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_endpoint_owner_3_01_generated_coordinate_of_3_01_specification_01_4_01_4}{serif\+::model\+::detail\+::\+Endpoint\+Owner$<$ Generated\+Coordinate\+Of$<$ Specification $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_endpoint_owner_3_01_constraint_of_3_01_specification_01_4_01_4}{serif\+::model\+::detail\+::\+Endpoint\+Owner$<$ Constraint\+Of$<$ Specification $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_resolved_endpoints_3_01_owner_00_01utils_1_1types_1_1_type_li2430ab0d86fbd9154758559351ff5179}{serif\+::model\+::detail\+::\+Resolved\+Endpoints$<$ Owner, utils\+::types\+::\+Type\+List$<$ Endpoints... $>$, Bindings $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_enforcement_dependencies}{serif\+::model\+::detail\+::\+Enforcement\+Dependencies$<$ Specification, Bindings, bool $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Legacy prescriptions retain their original dependencies unless an equation explicitly registers another enforcement. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_enforcement_dependencies_3_01_specification_00_01_bindings_00_01true_01_4}{serif\+::model\+::detail\+::\+Enforcement\+Dependencies$<$ Specification, Bindings, true $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_resolved_specification}{serif\+::model\+::detail\+::\+Resolved\+Specification$<$ Specification, Bindings $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Share resolved physical identities between endpoint and numerical-\/provider checks. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1detail}{serif\+::model\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Specification$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_ae427ccffd89556bd768fed6b07d0172a}{serif\+::model\+::detail\+::\+Generates\+State}} = std\+::bool\+\_\+constant$<$Specification\+::\+Model\+Definition\+::generated\+\_\+state\+\_\+kind != \mbox{\hyperlink{namespaceserif_1_1model_a9dbd561b48b9cbb817a4102517d065caa334c4a4c42fdb79d7ebc3e73b517e6f8}{Generated\+State\+Kind\+::none}}$>$
|
|
\item
|
|
{\footnotesize template$<$typename Model$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_a7dc206380569e07235666a9efbe09756}{serif\+::model\+::detail\+::\+Generated\+Specifications}} = \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1concepts_a7f4d5acf6ecfec39214a93e40c82bbf7}{utils\+::misc\+::concepts\+::\+FilterT}}$<$typename Model\+::\+Specification\+Types, \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_ae427ccffd89556bd768fed6b07d0172a}{Generates\+State}}$>$
|
|
\begin{DoxyCompactList}\small\item\em Numerical checks operate only on prescriptions that introduce a coordinate and equation. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Owner, typename Endpoint, typename Bindings$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_a47f2eeb5ccf35b63be85b56181ca52f2}{serif\+::model\+::detail\+::\+Resolved\+Endpoint}} = typename decltype(\mbox{\hyperlink{namespaceserif_1_1model_1_1detail_a9505ea2d4e0316e88ebfb5b9bed66546}{resolved\+\_\+endpoint}}$<$Owner, Endpoint, Bindings$>$())\+::type
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Owner, typename Endpoint, typename Bindings$>$ }\\consteval auto \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_a9505ea2d4e0316e88ebfb5b9bed66546}{serif\+::model\+::detail\+::resolved\+\_\+endpoint}} ()
|
|
\begin{DoxyCompactList}\small\item\em Resolve owned aliases and explicit bindings without merging same-\/unit identities. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Model, typename Endpoint$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_abfcd2310778365acc2776af95c1e26de}{serif\+::model\+::detail\+::endpoint\+\_\+owner\+\_\+present}} ()
|
|
\begin{DoxyCompactList}\small\item\em A coordinate binding cannot supply an absent or non-\/generating physical prescription. \end{DoxyCompactList}\end{DoxyCompactItemize}
|