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)
303 lines
14 KiB
XML
303 lines
14 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="eos_2runtime_2concepts_8hpp" kind="file" language="C++">
|
|
<compoundname>concepts.hpp</compoundname>
|
|
<includes refid="eos_2models_2concepts_8hpp" local="yes">serif/eos/models/concepts.hpp</includes>
|
|
<includes refid="eos_2runtime_2details_8hpp" local="yes">serif/eos/runtime/details.hpp</includes>
|
|
<includedby refid="views_8hpp" local="yes">src/include/serif/eos/runtime/views.hpp</includedby>
|
|
<incdepgraph>
|
|
<node id="20">
|
|
<label>serif/dimensions/dimensions.hpp</label>
|
|
<link refid="dimensions_8hpp"/>
|
|
<childnode refid="21" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="11">
|
|
<label>serif/dimensions/partial.hpp</label>
|
|
<link refid="partial_8hpp"/>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
<childnode refid="10" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="4">
|
|
<label>serif/dimensions/quantities.hpp</label>
|
|
<link refid="quantities_8hpp"/>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
<childnode refid="6" relation="include">
|
|
</childnode>
|
|
<childnode refid="7" relation="include">
|
|
</childnode>
|
|
<childnode refid="8" relation="include">
|
|
</childnode>
|
|
<childnode refid="9" relation="include">
|
|
</childnode>
|
|
<childnode refid="10" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="25">
|
|
<label>serif/dimensions/runtime/concepts.hpp</label>
|
|
<link refid="dimensions_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="21" relation="include">
|
|
</childnode>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
<childnode refid="26" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="26">
|
|
<label>serif/dimensions/runtime/runtime.hpp</label>
|
|
<link refid="dimensions_2runtime_2runtime_8hpp"/>
|
|
<childnode refid="21" relation="include">
|
|
</childnode>
|
|
<childnode refid="27" relation="include">
|
|
</childnode>
|
|
<childnode refid="28" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="32">
|
|
<label>serif/eos/evaluation.hpp</label>
|
|
<link refid="eos_2evaluation_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="29">
|
|
<label>serif/eos/exceptions.hpp</label>
|
|
<link refid="eos_2exceptions_8hpp"/>
|
|
<childnode refid="28" relation="include">
|
|
</childnode>
|
|
<childnode refid="30" relation="include">
|
|
</childnode>
|
|
<childnode refid="31" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="2">
|
|
<label>serif/eos/models/concepts.hpp</label>
|
|
<link refid="eos_2models_2concepts_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
<childnode refid="19" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="3">
|
|
<label>serif/eos/models/traits.hpp</label>
|
|
<link refid="eos_2models_2traits_8hpp"/>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
<childnode refid="11" relation="include">
|
|
</childnode>
|
|
<childnode refid="12" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="14">
|
|
<label>serif/eos/relations/catalog.hpp</label>
|
|
<link refid="catalog_8hpp"/>
|
|
<childnode refid="15" relation="include">
|
|
</childnode>
|
|
<childnode refid="17" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="12">
|
|
<label>serif/eos/relations/concepts.hpp</label>
|
|
<link refid="eos_2relations_2concepts_8hpp"/>
|
|
<childnode refid="13" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="19">
|
|
<label>serif/eos/relations/relations.hpp</label>
|
|
<link refid="eos_2relations_2relations_8hpp"/>
|
|
<childnode refid="14" relation="include">
|
|
</childnode>
|
|
<childnode refid="20" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="13">
|
|
<label>serif/eos/relations/traits.hpp</label>
|
|
<link refid="eos_2relations_2traits_8hpp"/>
|
|
<childnode refid="14" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="1">
|
|
<label>src/include/serif/eos/runtime/concepts.hpp</label>
|
|
<link refid="eos_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
<childnode refid="22" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="22">
|
|
<label>serif/eos/runtime/details.hpp</label>
|
|
<link refid="eos_2runtime_2details_8hpp"/>
|
|
<childnode refid="23" relation="include">
|
|
</childnode>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
<childnode refid="8" relation="include">
|
|
</childnode>
|
|
<childnode refid="24" relation="include">
|
|
</childnode>
|
|
<childnode refid="25" relation="include">
|
|
</childnode>
|
|
<childnode refid="29" relation="include">
|
|
</childnode>
|
|
<childnode refid="32" relation="include">
|
|
</childnode>
|
|
<childnode refid="14" relation="include">
|
|
</childnode>
|
|
<childnode refid="33" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="34">
|
|
<label>serif/meta/enums.hpp</label>
|
|
<link refid="enums_8hpp"/>
|
|
<childnode refid="35" relation="include">
|
|
</childnode>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
<childnode refid="36" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="33">
|
|
<label>serif/utils/error/codes.hpp</label>
|
|
<link refid="codes_8hpp"/>
|
|
<childnode refid="28" relation="include">
|
|
</childnode>
|
|
<childnode refid="34" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="10">
|
|
<label>serif/utils/misc/concepts/numeric.hpp</label>
|
|
<link refid="numeric_8hpp"/>
|
|
<childnode refid="7" relation="include">
|
|
</childnode>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="15">
|
|
<label>serif/utils/misc/concepts/type_uniqueness.hpp</label>
|
|
<link refid="concepts_2type__uniqueness_8hpp"/>
|
|
<childnode refid="16" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="9">
|
|
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
|
|
<link refid="cleaning_8hpp"/>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="17">
|
|
<label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
|
|
<link refid="variadic__cleaning_8hpp"/>
|
|
<childnode refid="18" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="16">
|
|
<label>serif/utils/misc/traits/type_uniqueness.hpp</label>
|
|
<link refid="traits_2type__uniqueness_8hpp"/>
|
|
<childnode refid="9" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="23">
|
|
<label>array</label>
|
|
</node>
|
|
<node id="6">
|
|
<label>compare</label>
|
|
</node>
|
|
<node id="7">
|
|
<label>concepts</label>
|
|
</node>
|
|
<node id="18">
|
|
<label>cstddef</label>
|
|
</node>
|
|
<node id="28">
|
|
<label>cstdint</label>
|
|
</node>
|
|
<node id="24">
|
|
<label>expected</label>
|
|
</node>
|
|
<node id="36">
|
|
<label>magic_enum/magic_enum_all.hpp</label>
|
|
</node>
|
|
<node id="27">
|
|
<label>span</label>
|
|
</node>
|
|
<node id="30">
|
|
<label>stdexcept</label>
|
|
</node>
|
|
<node id="31">
|
|
<label>string</label>
|
|
</node>
|
|
<node id="21">
|
|
<label>string_view</label>
|
|
</node>
|
|
<node id="8">
|
|
<label>tuple</label>
|
|
</node>
|
|
<node id="5">
|
|
<label>type_traits</label>
|
|
</node>
|
|
<node id="35">
|
|
<label>unordered_map</label>
|
|
</node>
|
|
</incdepgraph>
|
|
<invincdepgraph>
|
|
<node id="3">
|
|
<label>src/compile_time_checks/serif/eos/runtime/views.cpp</label>
|
|
<link refid="views_8cpp"/>
|
|
</node>
|
|
<node id="1">
|
|
<label>src/include/serif/eos/runtime/concepts.hpp</label>
|
|
<link refid="eos_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="2">
|
|
<label>src/include/serif/eos/runtime/views.hpp</label>
|
|
<link refid="views_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
</node>
|
|
</invincdepgraph>
|
|
<innernamespace refid="namespaceserif">serif</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1eos">serif::eos</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1eos_1_1runtime">serif::eos::runtime</innernamespace>
|
|
<briefdescription>
|
|
<para>File containing concepts for the eos runtime module. These concepts are used to constrain template parameters in the eos runtime module. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="author"><para>Emily M. Boudreaux </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<programlisting>
|
|
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="9"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="10"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="eos_2models_2concepts_8hpp" kindref="compound">serif/eos/models/concepts.hpp</ref>"</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="eos_2runtime_2details_8hpp" kindref="compound">serif/eos/runtime/details.hpp</ref>"</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="12"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="13" refid="namespaceserif_1_1eos_1_1runtime" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1eos_1_1runtime" kindref="compound">serif::eos::runtime</ref><sp/>{</highlight></codeline>
|
|
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/><</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Cand</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ate></highlight></codeline>
|
|
<codeline lineno="19" refid="conceptserif_1_1eos_1_1runtime_1_1_runtime_e_o_s_model" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="conceptserif_1_1eos_1_1runtime_1_1_runtime_e_o_s_model" kindref="compound">RuntimeEOSModel</ref><sp/>=<sp/><ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_model" kindref="compound">eos::models::EOSModel<Candidate></ref><sp/>&&</highlight></codeline>
|
|
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1eos_1_1runtime_1_1_runtime_catalog_is_supported" kindref="compound">RuntimeCatalogIsSupported<typename std::remove_cvref_t<Candidate>::Relations</ref>>::value;</highlight></codeline>
|
|
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/><RuntimeEOSModel<sp/>EOSCand</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ate></highlight></codeline>
|
|
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1eos_1_1runtime_1af34d4e019ddbfd7eca9b4c20fddbae2f" kindref="member">RuntimeEOSAdapter</ref><sp/>=<sp/><ref refid="structserif_1_1eos_1_1runtime_1_1_runtime_catalog_dispatch" kindref="compound">RuntimeCatalogDispatch<EOSCandidate, typename EOSCandidate::Relations></ref>;</highlight></codeline>
|
|
<codeline lineno="28"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/><RuntimeEOSModel<sp/>EOSCand</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ate></highlight></codeline>
|
|
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::span<const<sp/>dimensions::runtime::RuntimeRelationDescriptor><sp/><ref refid="namespaceserif_1_1eos_1_1runtime_1a25ab7f40da798676afd459e004a8c06d" kindref="member">runtimeRelationDescriptors</ref>()<sp/>noexcept<sp/>{</highlight></codeline>
|
|
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1eos_1_1runtime_1_1_runtime_catalog_storage" kindref="compound">RuntimeCatalogStorage<EOSCandidate, typename EOSCandidate::Relations>::descriptors</ref>;</highlight></codeline>
|
|
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
|
|
<codeline lineno="38"><highlight class="normal">}</highlight></codeline>
|
|
</programlisting>
|
|
<location file="src/include/serif/eos/runtime/concepts.hpp"/>
|
|
</compounddef>
|
|
</doxygen>
|