Files
MeanField_SERiF/docs/latex/solver_2normalization_2detail_2validation_8hpp.tex

42 lines
2.7 KiB
TeX
Raw Permalink Normal View History

\doxysection{src/include/serif/solver/normalization/detail/validation.hpp File Reference}
\hypertarget{solver_2normalization_2detail_2validation_8hpp}{}\label{solver_2normalization_2detail_2validation_8hpp}\index{src/include/serif/solver/normalization/detail/validation.hpp@{src/include/serif/solver/normalization/detail/validation.hpp}}
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$span$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
Include dependency graph for validation.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=315pt]{solver_2normalization_2detail_2validation_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]{solver_2normalization_2detail_2validation_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization}{serif\+::solver\+::normalization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail}{serif\+::solver\+::normalization\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ void, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_ad54763a72b7afba4466448d6ea8cd92d}{serif\+::solver\+::normalization\+::detail\+::validate\+\_\+factors}} (std\+::span$<$ const double $>$ factors)
\begin{DoxyCompactList}\small\item\em Require finite positive factors before accepting custom or packed normalization. \end{DoxyCompactList}\item
std\+::expected$<$ std\+::size\+\_\+t, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_aac461ba7041bb6e9dae73cfdadd90ba0}{serif\+::solver\+::normalization\+::detail\+::validate\+\_\+coordinate\+\_\+size}} (std\+::size\+\_\+t size, bool global\+\_\+scalar)
\begin{DoxyCompactList}\small\item\em Check representable coordinate storage and the fixed arity of global scalar terms. \end{DoxyCompactList}\item
std\+::expected$<$ void, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_af20704165b9fea14118ef8de67f23e4e}{serif\+::solver\+::normalization\+::detail\+::check\+\_\+coordinate\+\_\+size}} (std\+::size\+\_\+t expected, std\+::size\+\_\+t received)
\begin{DoxyCompactList}\small\item\em Compare metric or factor size with the independently declared coordinate layout. \end{DoxyCompactList}\end{DoxyCompactItemize}