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)
54 lines
2.5 KiB
TeX
54 lines
2.5 KiB
TeX
\doxysection{src/include/serif/discretization/domain/ids/validation/unique\+\_\+ids.hpp File Reference}
|
|
\hypertarget{unique__ids_8hpp}{}\label{unique__ids_8hpp}\index{src/include/serif/discretization/domain/ids/validation/unique\_ids.hpp@{src/include/serif/discretization/domain/ids/validation/unique\_ids.hpp}}
|
|
|
|
|
|
This file defines a utility function to check if a pack of values are all unique. This is used to validate that domain and boundary IDs are distinct.
|
|
|
|
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/std\+\_\+helper/variadic\+\_\+cleaning.\+hpp"{}}\newline
|
|
Include dependency graph for unique\+\_\+ids.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{unique__ids_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]{unique__ids_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\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_1domain}{serif\+::discretization\+::domain}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids}{serif\+::discretization\+::domain\+::ids}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_1_1validation}{serif\+::discretization\+::domain\+::ids\+::validation}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename... Ts$>$ \newline
|
|
requires (std\+::equality\+\_\+comparable$<$Ts$>$ \&\& ...)}\\consteval bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_1_1validation_aa32cf1b94829069aacbae4c24d24ea50}{serif\+::discretization\+::domain\+::ids\+::validation\+::all\+\_\+unique\+\_\+values}} (Ts... values) noexcept
|
|
\begin{DoxyCompactList}\small\item\em Utility function to check if a pack of values are all unique. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines a utility function to check if a pack of values are all unique. This is used to validate that domain and boundary IDs are distinct.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|