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)
64 lines
4.5 KiB
TeX
64 lines
4.5 KiB
TeX
\doxysection{src/include/serif/utils/dependencies/key\+\_\+list.hpp File Reference}
|
|
\hypertarget{key__list_8hpp}{}\label{key__list_8hpp}\index{src/include/serif/utils/dependencies/key\_list.hpp@{src/include/serif/utils/dependencies/key\_list.hpp}}
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/traits/type\+\_\+uniqueness.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/types/type\+\_\+list.\+hpp"{}}\newline
|
|
Include dependency graph for key\+\_\+list.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{key__list_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]{key__list_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{serif\+::utils\+::dependencies\+::\+Key\+List$<$ Key\+Ts $>$}}
|
|
\begin{DoxyCompactList}\small\item\em An ordered collection of role keys, independent of their associated value types. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list_bindings_3_01_bindings_t_00_01_key_list_3_01_key_ts_8_8_8_01_4_01_4}{serif\+::utils\+::dependencies\+::\+Key\+List\+Bindings$<$ Bindings\+T, Key\+List$<$ Key\+Ts... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_resolve_keys_3_01_bindings_t_00_01_key_list_3_01_key_ts_8_8_8_01_4_01_4}{serif\+::utils\+::dependencies\+::\+Resolve\+Keys$<$ Bindings\+T, Key\+List$<$ Key\+Ts... $>$ $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies}{serif\+::utils\+::dependencies}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1utils_1_1dependencies_1_1_is_key_list}{serif\+::utils\+::dependencies\+::\+Is\+Key\+List}}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1utils_1_1dependencies_1_1_satisfies_key_list}{serif\+::utils\+::dependencies\+::\+Satisfies\+Key\+List}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename... Key\+Ts$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a22eef682b02dad9de4774e4b68b003ba}{serif\+::utils\+::dependencies\+::\+Input\+List}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{Key\+List}}$<$Key\+Ts...$>$
|
|
\begin{DoxyCompactList}\small\item\em \doxylink{classserif_1_1utils_1_1dependencies_1_1_computation}{Computation} arguments are supplied in this key order. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename... Key\+Ts$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a0674f826a11ecdab76236fa550cd88d5}{serif\+::utils\+::dependencies\+::\+Requested\+Results}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{Key\+List}}$<$Key\+Ts...$>$
|
|
\begin{DoxyCompactList}\small\item\em Preparing these results also prepares their required intermediate computations. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename BindingsT, typename KeysT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_ad50a04df4c202c11f49d6a2cf594b5da}{serif\+::utils\+::dependencies\+::\+Resolved\+Targets}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_resolve_keys}{Resolve\+Keys}}$<$BindingsT, std\+::remove\+\_\+cvref\+\_\+t$<$KeysT$>$$>$\+::type
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename T$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a25fa55523bb000e3162a850a7912b249}{serif\+::utils\+::dependencies\+::is\+\_\+key\+\_\+list\+\_\+v}} = false
|
|
\item
|
|
{\footnotesize template$<$typename... Key\+Ts$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_ac02e21a813bf00c2f5debac9b251b757}{serif\+::utils\+::dependencies\+::is\+\_\+key\+\_\+list\+\_\+v$<$ Key\+List$<$ Key\+Ts... $>$ $>$}} = \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1traits_a8cb5b9ce5869ecf88101859ace70f92a}{misc\+::traits\+::all\+\_\+unique\+\_\+types\+\_\+v}}$<$Key\+Ts...$>$
|
|
\end{DoxyCompactItemize}
|