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)
761 lines
35 KiB
XML
761 lines
35 KiB
XML
<?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_1errors" kind="namespace" language="C++">
|
|
<compoundname>serif::utils::errors</compoundname>
|
|
<innerclass refid="classserif_1_1utils_1_1errors_1_1_non_finite_value" prot="public">serif::utils::errors::NonFiniteValue</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1errors_1_1serif__error__printer" prot="public">serif::utils::errors::serif_error_printer</innerclass>
|
|
<sectiondef kind="enum">
|
|
<memberdef kind="enum" id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" prot="public" static="no" strong="yes">
|
|
<type>uint16_t</type>
|
|
<name>SERiFErrorCode</name>
|
|
<qualifiedname>serif::utils::errors::SERiFErrorCode</qualifiedname>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a9a10f345b0f755d461a8673a5e9ef6b4" prot="public">
|
|
<name>UNKNOWN_ERROR</name>
|
|
<initializer>= 0</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346af295a0c3e37c94f078e1c5476479132d" prot="public">
|
|
<name>INVALID_ARGUMENT</name>
|
|
<initializer>= 100</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ab26e430d27d39fcdbc0fe2ea820df3fd" prot="public">
|
|
<name>INVALID_QUADRATURE_ORDER</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac212f14cd5a49cbc50455bb4f9c1e84c" prot="public">
|
|
<name>INVALID_DOMAIN_ERROR</name>
|
|
<initializer>=110</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ad32f95d919a74607c87d347b0185b92c" prot="public">
|
|
<name>NEGATIVE_VALUE_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a3f458281134cf7e4b19d7c97473cd7ec" prot="public">
|
|
<name>NON_FINITE_VALUE_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a23c8ae7f26b046be4ca7e274e6ab9020" prot="public">
|
|
<name>JACOBIAN_ERROR</name>
|
|
<initializer>= 200</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac29d8f4f77bbcb5244a6959819e3591d" prot="public">
|
|
<name>INVERTED_JACOBIAN</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac30ac4ea7e7347d7adc8fb51a060cf22" prot="public">
|
|
<name>NON_FINITE_DETERMINATE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a1fdfa3b9c5fc912a083c1a65d4bc7def" prot="public">
|
|
<name>EOS_ERROR</name>
|
|
<initializer>= 300</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a8e9f88cbd72f5fd2ea30e1a9fc980935" prot="public">
|
|
<name>EOS_UNSUPPORTED_RELATION</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a7abb36ccb39c78eee29ad309bfc92d83" prot="public">
|
|
<name>EOS_UNSUPPORTED_DERIVATIVE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a7d6ed736cc71b74321cff4980d0b366a" prot="public">
|
|
<name>EOS_WRONG_INPUT_COUNT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ab1a09e8dbe875f5042439869cb9c1a44" prot="public">
|
|
<name>EOS_WRONG_INPUT_QUANTITY</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a1dad27298692a9beea9d2eb1d4ddad7f" prot="public">
|
|
<name>EOS_NONFINITE_INPUT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a4103ab8cd923be43abf99797d43dbdbc" prot="public">
|
|
<name>EOS_OUTSIDE_DOMAIN</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346af2d6f3bb5552a94ca9afc6d116e0156b" prot="public">
|
|
<name>EOS_NONFINITE_RESULT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346afdc9ec844f0db8dbde01963b8bd60ef4" prot="public">
|
|
<name>EOS_INVALID_THERMODYNAMIC_INPUT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a6c849957a6a4a88b7fb6fcb716d651f1" prot="public">
|
|
<name>INVALID_DIMENSION</name>
|
|
<initializer>= 400</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a58690190e68105ca9d4c573f113ced94" prot="public">
|
|
<name>NON_FINITE_MAPPING_INPUT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a664863abf724900cacb79236732b0d24" prot="public">
|
|
<name>INVALID_REFERENCE_RADIUS</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a64cde656c0dea359e0e048c5b1a45020" prot="public">
|
|
<name>AT_COMPACTIFIED_INFINITY</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a46b382cdaef0bff17df6f22ed6ac0c80" prot="public">
|
|
<name>OUTSIDE_REFERENCE_DOMAIN</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346aed5aaccb3615a644e604d2867cb722a5" prot="public">
|
|
<name>NON_FINITE_MAPPING_RESULT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a8046940b838d63b536825ef425a6de82" prot="public">
|
|
<name>NON_POSITIVE_DETERMINATE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a099ab2aa35e6b3be35ddc36b33360102" prot="public">
|
|
<name>INVALID_MAPPING</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a5a8b51f24614b8ba55b97bcac6512bb3" prot="public">
|
|
<name>MISC_MAPPING_ERROR</name>
|
|
<initializer>=410</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a9d34d1c93ad6e3f58fd9023c1977cc39" prot="public">
|
|
<name>INVALID_DOF_COUNT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac618b9adeda9e855aab839a1046267e2" prot="public">
|
|
<name>INVALID_ELEMENT_GEOMETRY</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a6e7088395a408e24db367b8bf8602fa5" prot="public">
|
|
<name>INVALID_DOF_ORDERING</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a431e11f2136ff582c4c1d2909319a28b" prot="public">
|
|
<name>INVALID_COMPACTIFICATION_RANK</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346af0aa8cd82916235df25802da359563ef" prot="public">
|
|
<name>INVALID_COMPACTIFICATION_TYPE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a622945fe1c39f0b66b63f8b518283802" prot="public">
|
|
<name>INVALID_COMPACTIFICATION_DERIVATIVE_TYPE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a204f4389a3812083114bb4f4548ae2e4" prot="public">
|
|
<name>INVALID_VACUUM_ELEMENT_ATTRIBUTE_ID</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a79ad977c1f9edca04fb43eb538a8b134" prot="public">
|
|
<name>MISSING_EXTERIOR_MAP</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a917cf7dd1086e6a331d5359e75736dc8" prot="public">
|
|
<name>COMPACTIFICATION_MISMATCH</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a8d659ed8ea04bdf1ed64eecb06dba220" prot="public">
|
|
<name>MISSING_FACE_ELEMENT</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a7f7f6e0e6fc2c000ab0a8476f4cea12a" prot="public">
|
|
<name>JACOBIAN_SHAPE_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a624b043baa343cb321e202e442461fd5" prot="public">
|
|
<name>MISSING_DISPLACEMENT_FINITE_ELEMENT_SPACE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a4f4f078704931effa7d820e26dce3454" prot="public">
|
|
<name>MISMATCHED_MESHING_MAPS</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a58a142d4c0001edb06db63564fd9d6af" prot="public">
|
|
<name>IMPROPERLY_ORDERED_REFERENCE_RADII</name>
|
|
<initializer>= 450</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ad6df09fb432983c68957f902c0157ec3" prot="public">
|
|
<name>INVALID_COORDINATE_TOLERANCE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a121f6f85b83e9e7bdfed69f6e2663054" prot="public">
|
|
<name>EVALUATOR_ERROR</name>
|
|
<initializer>=460</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac1b1773f74d583c43e3ea9366462f4ee" prot="public">
|
|
<name>CACHE_FE_BINDING_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a35dc50a7205013e2de2b388f944a4673" prot="public">
|
|
<name>INVALID_ELEMENT_ID_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ac4f686058466ccdea15bb5faef3d5e97" prot="public">
|
|
<name>ELEMENT_NULLPTR_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a33afad1a9fc3288ff00e0d950433ceb4" prot="public">
|
|
<name>DISCRETIZATION_ERROR</name>
|
|
<initializer>= 500</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a4bc541f8f40c5d80f848cd135bd7d45a" prot="public">
|
|
<name>SCHEMA_ERROR</name>
|
|
<initializer>= 510</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a94f0b761a1623b1bb4e63f99642ec0f0" prot="public">
|
|
<name>INVALID_SCHEMA_ARGUMENTS</name>
|
|
<initializer>= 512</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a638521f48b9ccdc14fbebd29658c9366" prot="public">
|
|
<name>MATRIX_SHAPE_ERROR</name>
|
|
<initializer>= 600</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a21e55d5bfa09b9572bd3cf11e0abd4a9" prot="public">
|
|
<name>OUT_OF_RANGE_ERROR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a38e34c32c3cba67bf30e244ef61cc684" prot="public">
|
|
<name>SOLVER_ERROR</name>
|
|
<initializer>= 700</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a15400f420fff3eb6aef75ff5099547ec" prot="public">
|
|
<name>NORMALIZATION_ERROR</name>
|
|
<initializer>= 730</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a367b8f40bcb3d5afcbfd2277b1fa6582" prot="public">
|
|
<name>NORMALIZATION_VECTOR_SIZE_MISMATCH</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346ab44dc1e8c547259784038bb5a197e85e" prot="public">
|
|
<name>NORMALIZATION_BUFFER_OVERLAP</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a7628b67e5cb2d4f25b60dfa93582e069" prot="public">
|
|
<name>PRECONDITIONER_ERROR</name>
|
|
<initializer>= 750</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a6b10c7e7c89ea2b49c0a8aaf1ebc0eac" prot="public">
|
|
<name>PRECONDITIONER_INVALID_OPTIONS</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a49ead9a31669df283034426e7d90ac61" prot="public">
|
|
<name>PRECONDITIONER_INVALID_OPERATOR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a07ade0bcb07c32f51b8b1c81cda05fbe" prot="public">
|
|
<name>PRECONDITIONER_SIZE_MISMATCH</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a0ce53c151e37e01206ce4111620e2f25" prot="public">
|
|
<name>PRECONDITIONER_NONFINITE_VALUE</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346af48e0181a9931250d9a6a4af4187dac4" prot="public">
|
|
<name>PRECONDITIONER_SINGULAR_OPERATOR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a027e24378dc9f89c5c44730686138afc" prot="public">
|
|
<name>PRECONDITIONER_ILL_CONDITIONED_OPERATOR</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a4ff26ef5e43141b4040a0f020ef5ea5a" prot="public">
|
|
<name>PRECONDITIONER_STALE_LINEARIZATION</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346af9a768b24c2e60f744437f97d716757d" prot="public">
|
|
<name>PRECONDITIONER_INCOMPATIBLE_STRATEGY</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a3cbb7648de8d1e097b4dff01727e8a62" prot="public">
|
|
<name>PRECONDITIONER_UNPREPARED</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346aaede09a1ad3463a00f6f7838a941a7f9" prot="public">
|
|
<name>PRECONDITIONER_INVALID_CALIBRATION</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346a46288ff2dd3648953ae84bb04730d3aa" prot="public">
|
|
<name>EQUATION_ERROR</name>
|
|
<initializer>= 800</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346aac8248e8e14d703a968d5094031ba5b9" prot="public">
|
|
<name>FAILED_TYPE_INVARIANT</name>
|
|
<initializer>= 1000</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/codes.hpp" line="18" column="5" bodyfile="src/include/serif/utils/error/codes.hpp" bodystart="18" bodyend="116"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="var">
|
|
<memberdef kind="variable" id="namespaceserif_1_1utils_1_1errors_1a562f604deccc1abf04ae9efdc7f0ac98" prot="public" static="no" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::utils::errors::SERiFErrorCodeNameToTypeMap</definition>
|
|
<argsstring></argsstring>
|
|
<name>SERiFErrorCodeNameToTypeMap</name>
|
|
<qualifiedname>serif::utils::errors::SERiFErrorCodeNameToTypeMap</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1meta_1a27a478b13abbbddd3b16dce448ce87fa" kindref="member">meta::enum_to_string_enum_map</ref><<ref refid="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" kindref="member">SERiFErrorCode</ref>>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/codes.hpp" line="118" column="17" bodyfile="src/include/serif/utils/error/codes.hpp" bodystart="118" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1utils_1_1errors_1acdf570b1b41e2bbf923e94a0c689fe5e" prot="public" static="no" mutable="no">
|
|
<type>auto</type>
|
|
<definition>auto serif::utils::errors::SERiFErrorCodeTypeToNameMap</definition>
|
|
<argsstring></argsstring>
|
|
<name>SERiFErrorCodeTypeToNameMap</name>
|
|
<qualifiedname>serif::utils::errors::SERiFErrorCodeTypeToNameMap</qualifiedname>
|
|
<initializer>= <ref refid="namespaceserif_1_1meta_1a228074fe1d60918db17444e31b601c2f" kindref="member">meta::enum_to_enum_string_map</ref><<ref refid="namespaceserif_1_1utils_1_1errors_1ab04484c13887f78337c2331fb2911346" kindref="member">SERiFErrorCode</ref>>()</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/codes.hpp" line="119" column="17" bodyfile="src/include/serif/utils/error/codes.hpp" bodystart="119" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1a129d7f74364af257118bcf2ea594d83a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>std::string</type>
|
|
<definition>std::string serif::utils::errors::format_error_message</definition>
|
|
<argsstring>(const std::string_view message, auto... args)</argsstring>
|
|
<name>format_error_message</name>
|
|
<qualifiedname>serif::utils::errors::format_error_message</qualifiedname>
|
|
<param>
|
|
<type>const std::string_view</type>
|
|
<declname>message</declname>
|
|
</param>
|
|
<param>
|
|
<type>auto...</type>
|
|
<declname>args</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="26" column="17" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="26" bodyend="42"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1a2447eb80947534cdf0fbd205251cfd9c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>misc::concepts::IsException</type>
|
|
<declname>ExceptionT</declname>
|
|
<defname>ExceptionT</defname>
|
|
</param>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::utils::errors::serif_error</definition>
|
|
<argsstring>(const std::string_view message, auto... args)</argsstring>
|
|
<name>serif_error</name>
|
|
<qualifiedname>serif::utils::errors::serif_error</qualifiedname>
|
|
<param>
|
|
<type>const std::string_view</type>
|
|
<declname>message</declname>
|
|
</param>
|
|
<param>
|
|
<type>auto...</type>
|
|
<declname>args</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="45" column="10" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="45" bodyend="48"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1a980a92d4199f7d6b867ff79cdb9638b6" prot="public" static="no" constexpr="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
<param>
|
|
<type>bool</type>
|
|
<declname>condition</declname>
|
|
<defname>condition</defname>
|
|
</param>
|
|
<param>
|
|
<type>types::FixedString</type>
|
|
<declname>message</declname>
|
|
<defname>message</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::utils::errors::serif_assert</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>serif_assert</name>
|
|
<qualifiedname>serif::utils::errors::serif_assert</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
<para>This is the feature flag for C++26 user defined static_assert messages.</para>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="55" column="20" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="55" bodyend="65"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1ab713b9a6974bd192ff360e642a9ef51f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
<param>
|
|
<type>misc::concepts::IsException</type>
|
|
<declname>ExceptionT</declname>
|
|
<defname>ExceptionT</defname>
|
|
<defval>std::logic_error</defval>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::utils::errors::serif_assert</definition>
|
|
<argsstring>(const bool condition, const std::string_view message, auto &&... args)</argsstring>
|
|
<name>serif_assert</name>
|
|
<qualifiedname>serif::utils::errors::serif_assert</qualifiedname>
|
|
<param>
|
|
<type>const bool</type>
|
|
<declname>condition</declname>
|
|
</param>
|
|
<param>
|
|
<type>const std::string_view</type>
|
|
<declname>message</declname>
|
|
</param>
|
|
<param>
|
|
<type>auto &&...</type>
|
|
<declname>args</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="68" column="10" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="68" bodyend="74"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1acbc8179633950d97b5bca694b6b52805" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
<param>
|
|
<type>misc::concepts::IsException</type>
|
|
<declname>ExceptionT</declname>
|
|
<defname>ExceptionT</defname>
|
|
<defval>std::logic_error</defval>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::utils::errors::serif_ensure</definition>
|
|
<argsstring>(const bool condition, const std::string_view message, auto... args)</argsstring>
|
|
<name>serif_ensure</name>
|
|
<qualifiedname>serif::utils::errors::serif_ensure</qualifiedname>
|
|
<param>
|
|
<type>const bool</type>
|
|
<declname>condition</declname>
|
|
</param>
|
|
<param>
|
|
<type>const std::string_view</type>
|
|
<declname>message</declname>
|
|
</param>
|
|
<param>
|
|
<type>auto...</type>
|
|
<declname>args</declname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="80" column="10" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="80" bodyend="84"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1errors_1a7fefa3a63ca7895a875f2672026df02d" prot="public" static="no" constexpr="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>SERiFErrorCode</type>
|
|
<declname>code</declname>
|
|
<defname>code</defname>
|
|
</param>
|
|
<param>
|
|
<type>bool</type>
|
|
<declname>condition</declname>
|
|
<defname>condition</defname>
|
|
</param>
|
|
<param>
|
|
<type>types::CTString</type>
|
|
<declname>message</declname>
|
|
<defname>message</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>void</type>
|
|
<definition>void serif::utils::errors::serif_ensure</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>serif_ensure</name>
|
|
<qualifiedname>serif::utils::errors::serif_ensure</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
<para>This is the feature flag for C++26 user defined static_assert messages.</para>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/error/errors.hpp" line="87" column="20" bodyfile="src/include/serif/utils/error/errors.hpp" bodystart="87" bodyend="95"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/utils/error/codes.hpp" line="6" column="1"/>
|
|
</compounddef>
|
|
</doxygen>
|