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)
156 lines
9.0 KiB
XML
156 lines
9.0 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="dimensions_2runtime_2concepts_8hpp" kind="file" language="C++">
|
|
<compoundname>concepts.hpp</compoundname>
|
|
<includes local="no">string_view</includes>
|
|
<includes local="no">type_traits</includes>
|
|
<includes refid="quantities_8hpp" local="yes">serif/dimensions/quantities.hpp</includes>
|
|
<includes refid="dimensions_2runtime_2runtime_8hpp" local="yes">serif/dimensions/runtime/runtime.hpp</includes>
|
|
<includedby refid="eos_2runtime_2details_8hpp" local="yes">src/include/serif/eos/runtime/details.hpp</includedby>
|
|
<incdepgraph>
|
|
<node id="4">
|
|
<label>serif/dimensions/quantities.hpp</label>
|
|
<link refid="quantities_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
<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>
|
|
</node>
|
|
<node id="1">
|
|
<label>src/include/serif/dimensions/runtime/concepts.hpp</label>
|
|
<link refid="dimensions_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
<childnode refid="10" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="10">
|
|
<label>serif/dimensions/runtime/runtime.hpp</label>
|
|
<link refid="dimensions_2runtime_2runtime_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
<childnode refid="11" relation="include">
|
|
</childnode>
|
|
<childnode refid="12" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="9">
|
|
<label>serif/utils/misc/concepts/numeric.hpp</label>
|
|
<link refid="numeric_8hpp"/>
|
|
<childnode refid="6" relation="include">
|
|
</childnode>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="8">
|
|
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
|
|
<link refid="cleaning_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="5">
|
|
<label>compare</label>
|
|
</node>
|
|
<node id="6">
|
|
<label>concepts</label>
|
|
</node>
|
|
<node id="12">
|
|
<label>cstdint</label>
|
|
</node>
|
|
<node id="11">
|
|
<label>span</label>
|
|
</node>
|
|
<node id="2">
|
|
<label>string_view</label>
|
|
</node>
|
|
<node id="7">
|
|
<label>tuple</label>
|
|
</node>
|
|
<node id="3">
|
|
<label>type_traits</label>
|
|
</node>
|
|
</incdepgraph>
|
|
<invincdepgraph>
|
|
<node id="3">
|
|
<label>src/compile_time_checks/serif/eos/runtime/details.cpp</label>
|
|
<link refid="details_8cpp"/>
|
|
</node>
|
|
<node id="6">
|
|
<label>src/compile_time_checks/serif/eos/runtime/views.cpp</label>
|
|
<link refid="views_8cpp"/>
|
|
</node>
|
|
<node id="1">
|
|
<label>src/include/serif/dimensions/runtime/concepts.hpp</label>
|
|
<link refid="dimensions_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="4">
|
|
<label>src/include/serif/eos/runtime/concepts.hpp</label>
|
|
<link refid="eos_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="2">
|
|
<label>src/include/serif/eos/runtime/details.hpp</label>
|
|
<link refid="eos_2runtime_2details_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="5">
|
|
<label>src/include/serif/eos/runtime/views.hpp</label>
|
|
<link refid="views_8hpp"/>
|
|
<childnode refid="6" relation="include">
|
|
</childnode>
|
|
</node>
|
|
</invincdepgraph>
|
|
<innernamespace refid="namespaceserif">serif</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1dimensions">serif::dimensions</innernamespace>
|
|
<innernamespace refid="namespaceserif_1_1dimensions_1_1runtime">serif::dimensions::runtime</innernamespace>
|
|
<briefdescription>
|
|
<para>Runtime concept for a type that can be projected to a runtime type. This is useful when converting from the compile time type system to something that can be inspected at runtime. </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="preprocessor"></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><string_view></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="12"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><type_traits></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="13"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="14"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="quantities_8hpp" kindref="compound">serif/dimensions/quantities.hpp</ref>"</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="15"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="dimensions_2runtime_2runtime_8hpp" kindref="compound">serif/dimensions/runtime/runtime.hpp</ref>"</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="17" refid="namespaceserif_1_1dimensions_1_1runtime" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1dimensions_1_1runtime" kindref="compound">serif::dimensions::runtime</ref><sp/>{</highlight></codeline>
|
|
<codeline lineno="18"><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/><</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Quantity></highlight></codeline>
|
|
<codeline lineno="27" refid="conceptserif_1_1dimensions_1_1runtime_1_1_runtime_identified_thermodynamic_quantity" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="conceptserif_1_1dimensions_1_1runtime_1_1_runtime_identified_thermodynamic_quantity" kindref="compound">RuntimeIdentifiedThermodynamicQuantity</ref><sp/>=</highlight></codeline>
|
|
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="conceptserif_1_1dimensions_1_1_thermodynamic_quantity_type" kindref="compound">ThermodynamicQuantityType<Quantity></ref><sp/>&&</highlight></codeline>
|
|
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>{{Quantity::identifier}<sp/>-><sp/>std::convertible_to<std::string_view>;<sp/>}<sp/>&&</highlight></codeline>
|
|
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>(std::string_view{Quantity::identifier}.size()<sp/>><sp/>0);</highlight></codeline>
|
|
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/><RuntimeIdentifiedThermodynamicQuantity<sp/>Quantity></highlight></codeline>
|
|
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>ThermodynamicQuantityID<sp/><ref refid="namespaceserif_1_1dimensions_1_1runtime_1ad1eac97b6b9f34f3be395e42d7edc4ba" kindref="member">thermodynamicQuantityID</ref>{std::string_view{Quantity::identifier}};</highlight></codeline>
|
|
<codeline lineno="39"><highlight class="normal">}</highlight></codeline>
|
|
</programlisting>
|
|
<location file="src/include/serif/dimensions/runtime/concepts.hpp"/>
|
|
</compounddef>
|
|
</doxygen>
|