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)
58 lines
5.6 KiB
TeX
58 lines
5.6 KiB
TeX
\doxysection{serif\+::utils\+::misc Namespace Reference}
|
|
\hypertarget{namespaceserif_1_1utils_1_1misc}{}\label{namespaceserif_1_1utils_1_1misc}\index{serif::utils::misc@{serif::utils::misc}}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1concepts}{concepts}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1format}{format}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1std__helper}{std\+\_\+helper}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1terminal}{terminal}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_1_1traits}{traits}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Numeric Scalar$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_a81150dfc59c33d2e767a9e572cb15fce}{validate\+\_\+finite}} (const Scalar value)
|
|
\item
|
|
{\footnotesize template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_a21655a5b8f48ae49f385e0a7ea836f3a}{validate\+\_\+greater\+\_\+than}} (const Scalar value, const Scalar predicate)
|
|
\item
|
|
{\footnotesize template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_ade362937d8732832b60a4d829b15d611}{validate\+\_\+less\+\_\+than}} (const Scalar value, const Scalar predicate)
|
|
\item
|
|
{\footnotesize template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1utils_1_1misc_a7f0bf6f20695cc8bb3c052c8a8f16dff}{validate\+\_\+nonnegativity}} (const Scalar value)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Function Documentation}
|
|
\Hypertarget{namespaceserif_1_1utils_1_1misc_a81150dfc59c33d2e767a9e572cb15fce}\index{serif::utils::misc@{serif::utils::misc}!validate\_finite@{validate\_finite}}
|
|
\index{validate\_finite@{validate\_finite}!serif::utils::misc@{serif::utils::misc}}
|
|
\doxysubsubsection{\texorpdfstring{validate\_finite()}{validate\_finite()}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1misc_a81150dfc59c33d2e767a9e572cb15fce}
|
|
template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Numeric Scalar$>$ \\
|
|
void serif\+::utils\+::misc\+::validate\+\_\+finite (\begin{DoxyParamCaption}\item[{const Scalar}]{value}{}\end{DoxyParamCaption})}
|
|
|
|
\Hypertarget{namespaceserif_1_1utils_1_1misc_a21655a5b8f48ae49f385e0a7ea836f3a}\index{serif::utils::misc@{serif::utils::misc}!validate\_greater\_than@{validate\_greater\_than}}
|
|
\index{validate\_greater\_than@{validate\_greater\_than}!serif::utils::misc@{serif::utils::misc}}
|
|
\doxysubsubsection{\texorpdfstring{validate\_greater\_than()}{validate\_greater\_than()}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1misc_a21655a5b8f48ae49f385e0a7ea836f3a}
|
|
template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ \\
|
|
void serif\+::utils\+::misc\+::validate\+\_\+greater\+\_\+than (\begin{DoxyParamCaption}\item[{const Scalar}]{value}{, }\item[{const Scalar}]{predicate}{}\end{DoxyParamCaption})}
|
|
|
|
\Hypertarget{namespaceserif_1_1utils_1_1misc_ade362937d8732832b60a4d829b15d611}\index{serif::utils::misc@{serif::utils::misc}!validate\_less\_than@{validate\_less\_than}}
|
|
\index{validate\_less\_than@{validate\_less\_than}!serif::utils::misc@{serif::utils::misc}}
|
|
\doxysubsubsection{\texorpdfstring{validate\_less\_than()}{validate\_less\_than()}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1misc_ade362937d8732832b60a4d829b15d611}
|
|
template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ \\
|
|
void serif\+::utils\+::misc\+::validate\+\_\+less\+\_\+than (\begin{DoxyParamCaption}\item[{const Scalar}]{value}{, }\item[{const Scalar}]{predicate}{}\end{DoxyParamCaption})}
|
|
|
|
\Hypertarget{namespaceserif_1_1utils_1_1misc_a7f0bf6f20695cc8bb3c052c8a8f16dff}\index{serif::utils::misc@{serif::utils::misc}!validate\_nonnegativity@{validate\_nonnegativity}}
|
|
\index{validate\_nonnegativity@{validate\_nonnegativity}!serif::utils::misc@{serif::utils::misc}}
|
|
\doxysubsubsection{\texorpdfstring{validate\_nonnegativity()}{validate\_nonnegativity()}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1misc_a7f0bf6f20695cc8bb3c052c8a8f16dff}
|
|
template$<$typename Exception\+Type, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{errors\+::\+SERi\+FError\+Code}} Error\+Code, concepts\+::\+Is\+Comparable\+To\+Numeric Scalar$>$ \\
|
|
void serif\+::utils\+::misc\+::validate\+\_\+nonnegativity (\begin{DoxyParamCaption}\item[{const Scalar}]{value}{}\end{DoxyParamCaption})}
|
|
|