tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
MeanField_SERiF/docs/xml/namespaceserif_1_1utils_1_1misc.xml

159 lines
6.9 KiB
XML
Raw Permalink Normal View History

docs(docs): built docs 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)
2026-11-09 14:09:44 -05:00
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
<compounddef id="namespaceserif_1_1utils_1_1misc" kind="namespace" language="C++">
<compoundname>serif::utils::misc</compoundname>
<innernamespace refid="namespaceserif_1_1utils_1_1misc_1_1concepts">serif::utils::misc::concepts</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1misc_1_1format">serif::utils::misc::format</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1misc_1_1std__helper">serif::utils::misc::std_helper</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1misc_1_1terminal">serif::utils::misc::terminal</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1misc_1_1traits">serif::utils::misc::traits</innernamespace>
<sectiondef kind="func">
<memberdef kind="function" id="namespaceserif_1_1utils_1_1misc_1a81150dfc59c33d2e767a9e572cb15fce" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<templateparamlist>
<param>
<type>typename ExceptionType</type>
</param>
<param>
<type>errors::SERiFErrorCode</type>
<declname>ErrorCode</declname>
<defname>ErrorCode</defname>
</param>
<param>
<type>concepts::IsNumeric</type>
<declname>Scalar</declname>
<defname>Scalar</defname>
</param>
</templateparamlist>
<type>void</type>
<definition>void serif::utils::misc::validate_finite</definition>
<argsstring>(const Scalar value)</argsstring>
<name>validate_finite</name>
<qualifiedname>serif::utils::misc::validate_finite</qualifiedname>
<param>
<type>const Scalar</type>
<declname>value</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/utils/misc/finite.hpp" line="12" column="10" bodyfile="src/include/serif/utils/misc/finite.hpp" bodystart="12" bodyend="16"/>
</memberdef>
<memberdef kind="function" id="namespaceserif_1_1utils_1_1misc_1a21655a5b8f48ae49f385e0a7ea836f3a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<templateparamlist>
<param>
<type>typename ExceptionType</type>
</param>
<param>
<type>errors::SERiFErrorCode</type>
<declname>ErrorCode</declname>
<defname>ErrorCode</defname>
</param>
<param>
<type>concepts::IsComparableToNumeric</type>
<declname>Scalar</declname>
<defname>Scalar</defname>
</param>
</templateparamlist>
<type>void</type>
<definition>void serif::utils::misc::validate_greater_than</definition>
<argsstring>(const Scalar value, const Scalar predicate)</argsstring>
<name>validate_greater_than</name>
<qualifiedname>serif::utils::misc::validate_greater_than</qualifiedname>
<param>
<type>const Scalar</type>
<declname>value</declname>
</param>
<param>
<type>const Scalar</type>
<declname>predicate</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/utils/misc/finite.hpp" line="19" column="10" bodyfile="src/include/serif/utils/misc/finite.hpp" bodystart="19" bodyend="24"/>
</memberdef>
<memberdef kind="function" id="namespaceserif_1_1utils_1_1misc_1ade362937d8732832b60a4d829b15d611" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<templateparamlist>
<param>
<type>typename ExceptionType</type>
</param>
<param>
<type>errors::SERiFErrorCode</type>
<declname>ErrorCode</declname>
<defname>ErrorCode</defname>
</param>
<param>
<type>concepts::IsComparableToNumeric</type>
<declname>Scalar</declname>
<defname>Scalar</defname>
</param>
</templateparamlist>
<type>void</type>
<definition>void serif::utils::misc::validate_less_than</definition>
<argsstring>(const Scalar value, const Scalar predicate)</argsstring>
<name>validate_less_than</name>
<qualifiedname>serif::utils::misc::validate_less_than</qualifiedname>
<param>
<type>const Scalar</type>
<declname>value</declname>
</param>
<param>
<type>const Scalar</type>
<declname>predicate</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/utils/misc/finite.hpp" line="27" column="10" bodyfile="src/include/serif/utils/misc/finite.hpp" bodystart="27" bodyend="32"/>
</memberdef>
<memberdef kind="function" id="namespaceserif_1_1utils_1_1misc_1a7f0bf6f20695cc8bb3c052c8a8f16dff" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<templateparamlist>
<param>
<type>typename ExceptionType</type>
</param>
<param>
<type>errors::SERiFErrorCode</type>
<declname>ErrorCode</declname>
<defname>ErrorCode</defname>
</param>
<param>
<type>concepts::IsComparableToNumeric</type>
<declname>Scalar</declname>
<defname>Scalar</defname>
</param>
</templateparamlist>
<type>void</type>
<definition>void serif::utils::misc::validate_nonnegativity</definition>
<argsstring>(const Scalar value)</argsstring>
<name>validate_nonnegativity</name>
<qualifiedname>serif::utils::misc::validate_nonnegativity</qualifiedname>
<param>
<type>const Scalar</type>
<declname>value</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/utils/misc/finite.hpp" line="35" column="10" bodyfile="src/include/serif/utils/misc/finite.hpp" bodystart="35" bodyend="38"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/utils/format/strings.hpp" line="8" column="1"/>
</compounddef>
</doxygen>
Reference in New Issue Copy Permalink