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)
51 lines
3.5 KiB
TeX
51 lines
3.5 KiB
TeX
\doxysection{src/include/serif/dimensions/runtime/runtime.hpp File Reference}
|
|
\hypertarget{dimensions_2runtime_2runtime_8hpp}{}\label{dimensions_2runtime_2runtime_8hpp}\index{src/include/serif/dimensions/runtime/runtime.hpp@{src/include/serif/dimensions/runtime/runtime.hpp}}
|
|
|
|
|
|
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 \doxylink{dimensions_8hpp}{dimensions.\+hpp} and \doxylink{quantities_8hpp}{quantities.\+hpp}
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$cstdint$>$}\newline
|
|
Include dependency graph for runtime.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=263pt]{dimensions_2runtime_2runtime_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
This graph shows which files directly or indirectly include this file\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dimensions_2runtime_2runtime_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1dimensions_1_1runtime_1_1_thermodynamic_quantity_i_d}{serif\+::dimensions\+::runtime\+::\+Thermodynamic\+Quantity\+ID}}
|
|
\begin{DoxyCompactList}\small\item\em Runtime resolvable ID for a thermodynamic quantity. Used in conjunction with concepts to resolve compile time thermodynamic types to runtime values. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value}{serif\+::dimensions\+::runtime\+::\+Runtime\+Quantity\+Value}}
|
|
\begin{DoxyCompactList}\small\item\em Runtime resolved type for a quantity value. This holds both an ID and a value. This is the runtime equivalent to a \doxylink{classserif_1_1dimensions_1_1_quantity_value}{Quantity\+Value}. Note that where these differ is that \doxylink{classserif_1_1dimensions_1_1_quantity_value}{Quantity\+Value} is built with template types. This allows the compiler to resolve it to a plain numeric type and still do optimizations That is generally not the case with \doxylink{structserif_1_1dimensions_1_1runtime_1_1_runtime_quantity_value}{Runtime\+Quantity\+Value}. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1dimensions_1_1runtime_1_1_runtime_relation_descriptor}{serif\+::dimensions\+::runtime\+::\+Runtime\+Relation\+Descriptor}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1dimensions}{serif\+::dimensions}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1dimensions_1_1runtime}{serif\+::dimensions\+::runtime}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
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 \doxylink{dimensions_8hpp}{dimensions.\+hpp} and \doxylink{quantities_8hpp}{quantities.\+hpp}
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|