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)
128 lines
15 KiB
XML
128 lines
15 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_2runtime_8hpp" kind="file" language="C++">
|
|
<compoundname>runtime.hpp</compoundname>
|
|
<includes local="no">string_view</includes>
|
|
<includes local="no">span</includes>
|
|
<includes local="no">cstdint</includes>
|
|
<includedby refid="dimensions_2runtime_2concepts_8hpp" local="yes">src/include/serif/dimensions/runtime/concepts.hpp</includedby>
|
|
<incdepgraph>
|
|
<node id="1">
|
|
<label>src/include/serif/dimensions/runtime/runtime.hpp</label>
|
|
<link refid="dimensions_2runtime_2runtime_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="4">
|
|
<label>cstdint</label>
|
|
</node>
|
|
<node id="3">
|
|
<label>span</label>
|
|
</node>
|
|
<node id="2">
|
|
<label>string_view</label>
|
|
</node>
|
|
</incdepgraph>
|
|
<invincdepgraph>
|
|
<node id="4">
|
|
<label>src/compile_time_checks/serif/eos/runtime/details.cpp</label>
|
|
<link refid="details_8cpp"/>
|
|
</node>
|
|
<node id="7">
|
|
<label>src/compile_time_checks/serif/eos/runtime/views.cpp</label>
|
|
<link refid="views_8cpp"/>
|
|
</node>
|
|
<node id="2">
|
|
<label>src/include/serif/dimensions/runtime/concepts.hpp</label>
|
|
<link refid="dimensions_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="3" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="1">
|
|
<label>src/include/serif/dimensions/runtime/runtime.hpp</label>
|
|
<link refid="dimensions_2runtime_2runtime_8hpp"/>
|
|
<childnode refid="2" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="5">
|
|
<label>src/include/serif/eos/runtime/concepts.hpp</label>
|
|
<link refid="eos_2runtime_2concepts_8hpp"/>
|
|
<childnode refid="6" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="3">
|
|
<label>src/include/serif/eos/runtime/details.hpp</label>
|
|
<link refid="eos_2runtime_2details_8hpp"/>
|
|
<childnode refid="4" relation="include">
|
|
</childnode>
|
|
<childnode refid="5" relation="include">
|
|
</childnode>
|
|
</node>
|
|
<node id="6">
|
|
<label>src/include/serif/eos/runtime/views.hpp</label>
|
|
<link refid="views_8hpp"/>
|
|
<childnode refid="7" relation="include">
|
|
</childnode>
|
|
</node>
|
|
</invincdepgraph>
|
|
<innerclass refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d" prot="public">serif::dimensions::runtime::ThermodynamicQuantityID</innerclass>
|
|
<innerclass refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value" prot="public">serif::dimensions::runtime::RuntimeQuantityValue</innerclass>
|
|
<innerclass refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor" prot="public">serif::dimensions::runtime::RuntimeRelationDescriptor</innerclass>
|
|
<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 usable types representing the compile time dimension type system. Note that generally this is not a dimensional analysis library. Though perhaps in the future it will grow to something like that. Rather, this system is intended to ensure that developers are explicit which what numeric values mean. There is more detail on this in the file comment for <ref refid="dimensions_8hpp" kindref="compound">dimensions.hpp</ref> and <ref refid="quantities_8hpp" kindref="compound">quantities.hpp</ref> </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="12"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="13"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><string_view></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="14"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><span></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="15"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><cstdint></highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="17"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="18"><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="25" refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1aee3596b55d79950de8c58e5ef03f8f77" kindref="member">ThermodynamicQuantityID</ref><sp/>final<sp/>{</highlight></codeline>
|
|
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
|
|
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1aee3596b55d79950de8c58e5ef03f8f77" kindref="member">ThermodynamicQuantityID</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string_view<sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1a761bd1ab05eca65afbb7d5cabfab1da7" kindref="member">name</ref>)<sp/>noexcept<sp/>:<sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1acd5a8a1a33a41edac273f597595740f6" kindref="member">m_name</ref>(<ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1a761bd1ab05eca65afbb7d5cabfab1da7" kindref="member">name</ref>)<sp/>{};</highlight></codeline>
|
|
<codeline lineno="28"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::string_view<sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1a761bd1ab05eca65afbb7d5cabfab1da7" kindref="member">name</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{</highlight></codeline>
|
|
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1acd5a8a1a33a41edac273f597595740f6" kindref="member">m_name</ref>;</highlight></codeline>
|
|
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
|
|
<codeline lineno="32"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">friend</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1a62536cd5e14b48084cb3d30a3b1a7065" kindref="member">operator==</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1aee3596b55d79950de8c58e5ef03f8f77" kindref="member">ThermodynamicQuantityID</ref><sp/>&,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1aee3596b55d79950de8c58e5ef03f8f77" kindref="member">ThermodynamicQuantityID</ref><sp/>&)<sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>=<sp/></highlight><highlight class="keywordflow">default</highlight><highlight class="normal">;</highlight></codeline>
|
|
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
|
|
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string_view<sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d_1acd5a8a1a33a41edac273f597595740f6" kindref="member">m_name</ref>;<sp/></highlight><highlight class="comment">//<sp/>We<sp/>can<sp/>use<sp/>a<sp/>string<sp/>view<sp/>here<sp/>since<sp/>the<sp/>constructor<sp/>is<sp/>constexpr<sp/>and<sp/>the<sp/>string<sp/>view<sp/>will<sp/>be<sp/>valid<sp/>for<sp/>the<sp/>lifetime<sp/>of<sp/>the<sp/>program.</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
|
|
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="46" refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value" kindref="compound">RuntimeQuantityValue</ref><sp/>final<sp/>{</highlight></codeline>
|
|
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d" kindref="compound">ThermodynamicQuantityID</ref><sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value_1a9843f2d7e942fb012481fbbd3e32c561" kindref="member">id</ref>;</highlight></codeline>
|
|
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value_1a16b98a510df008778d9ad6524afdc698" kindref="member">value</ref>{};</highlight></codeline>
|
|
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
|
|
<codeline lineno="50"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>TODO:<sp/>This<sp/>should<sp/>be<sp/>refactored<sp/>into<sp/>the<sp/>eos<sp/>module<sp/>rather<sp/>than<sp/>the<sp/>dimensions<sp/>module</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="52" refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor" kindref="compound">RuntimeRelationDescriptor</ref><sp/>final<sp/>{</highlight></codeline>
|
|
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d" kindref="compound">ThermodynamicQuantityID</ref><sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1af4b35e7a640a303181edae83409edabe" kindref="member">outputQuantity</ref>;</highlight></codeline>
|
|
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::span<const<sp/>ThermodynamicQuantityID><sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1a4e51ef144271f3e7b41593660ca993b9" kindref="member">inputQuantities</ref>;</highlight></codeline>
|
|
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::uint64_t<sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1ace7cfa2da8df80b833024875880fd046" kindref="member">partialDerivativeMask</ref>;</highlight></codeline>
|
|
<codeline lineno="56"><highlight class="normal"></highlight></codeline>
|
|
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1a8d3d61d45bdf1a9d97146171308c3183" kindref="member">hasPartialDerivative</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::size_t<sp/>inputIndex)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{</highlight></codeline>
|
|
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>inputIndex<sp/><<sp/><ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1a4e51ef144271f3e7b41593660ca993b9" kindref="member">inputQuantities</ref>.size()<sp/>&&<sp/>(<ref refid="structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor_1ace7cfa2da8df80b833024875880fd046" kindref="member">partialDerivativeMask</ref><sp/>&<sp/>(std::uint64_t{1}<sp/><<<sp/>inputIndex))<sp/>!=<sp/>0;</highlight></codeline>
|
|
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
|
|
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
|
|
<codeline lineno="61"><highlight class="normal">}</highlight></codeline>
|
|
</programlisting>
|
|
<location file="src/include/serif/dimensions/runtime/runtime.hpp"/>
|
|
</compounddef>
|
|
</doxygen>
|