tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-11 11:41:55 -04:00
parent 1e5938df0d
commit f0e1840c91
138 changed files with 18404 additions and 7317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
docs/latex/class_metadata.tex
View File

@@ -12,8 +12,7 @@ Represents metadata information for data objects in the dobj module.
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\Hypertarget{class_metadata_ae849560667461008cb72e83919c20be0}\label{class_metadata_ae849560667461008cb72e83919c20be0}
{\bfseries Metadata} ()=default
\mbox{\hyperlink{class_metadata_ae849560667461008cb72e83919c20be0}{Metadata}} ()=default
\begin{DoxyCompactList}\small\item\em Default constructor for \doxylink{class_metadata}{Metadata}. \end{DoxyCompactList}\item
\mbox{\hyperlink{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}{Metadata}} (std\+::size\+\_\+t byte\+Size, std\+::string data\+Type, std\+::vector$<$ std\+::size\+\_\+t $>$ dimensions, bool debug\+Flag=false)
\begin{DoxyCompactList}\small\item\em Constructor to initialize \doxylink{class_metadata}{Metadata} with specific attributes. \end{DoxyCompactList}\item
@@ -33,6 +32,17 @@ bool \mbox{\hyperlink{class_metadata_abe52c81e04665628666b4140cd346b69}{is\+Debu
\begin{DoxyCompactList}\small\item\em Checks if debugging information is enabled. \end{DoxyCompactList}\item
void \mbox{\hyperlink{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}{set\+Debug\+Enabled}} (bool debug\+Flag) noexcept
\begin{DoxyCompactList}\small\item\em Sets the debugging flag. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
int \mbox{\hyperlink{class_metadata_ac73a509797c98c0d52fb32e1f93e38bc}{byte\+Size\+\_\+}} = 0
\begin{DoxyCompactList}\small\item\em Total size of the data in bytes. \end{DoxyCompactList}\item
std\+::string \mbox{\hyperlink{class_metadata_a290205e5f46416dd0f48bd6ff62888ac}{data\+Type\+\_\+}}
\begin{DoxyCompactList}\small\item\em Type of the data (e.\+g., "{}float"{}, "{}double"{}). \end{DoxyCompactList}\item
std\+::vector$<$ std\+::size\+\_\+t $>$ \mbox{\hyperlink{class_metadata_a163f74d4ef9ecd13a34e7e9cab2e21ce}{dimensions\+\_\+}}
\begin{DoxyCompactList}\small\item\em Dimensions of the data (e.\+g., \{3, 4\} for a 3x4 matrix). \end{DoxyCompactList}\item
bool \mbox{\hyperlink{class_metadata_a65fd506f1bd41699d9cd19bc0dfc9701}{debug\+Flag\+\_\+}} = false
\begin{DoxyCompactList}\small\item\em Indicates whether debugging is enabled. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Friends}
\begin{DoxyCompactItemize}
\item
@@ -45,10 +55,24 @@ Represents metadata information for data objects in the dobj module.
The \doxylink{class_metadata}{Metadata} class encapsulates details such as data size, type, dimensions, and optional debugging flags. It is designed to provide descriptive attributes in a lightweight and efficient manner.
Definition at line \mbox{\hyperlink{_metadata_8h_source_l00051}{51}} of file \mbox{\hyperlink{_metadata_8h_source}{Metadata.\+h}}.
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{class_metadata_ae849560667461008cb72e83919c20be0}\index{Metadata@{Metadata}!Metadata@{Metadata}}
\index{Metadata@{Metadata}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{Metadata()}{Metadata()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{class_metadata_ae849560667461008cb72e83919c20be0}
Metadata\+::\+Metadata (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}}
Default constructor for \doxylink{class_metadata}{Metadata}.
\Hypertarget{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}\index{Metadata@{Metadata}!Metadata@{Metadata}}
\index{Metadata@{Metadata}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{Metadata()}{Metadata()}}
\doxysubsubsection{\texorpdfstring{Metadata()}{Metadata()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}
Metadata\+::\+Metadata (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{byte\+Size}{, }\item[{std\+::string}]{data\+Type}{, }\item[{std\+::vector$<$ std\+::size\+\_\+t $>$}]{dimensions}{, }\item[{bool}]{debug\+Flag}{ = {\ttfamily false}}\end{DoxyParamCaption})}
@@ -69,6 +93,10 @@ Constructor to initialize \doxylink{class_metadata}{Metadata} with specific attr
\end{DoxyParams}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00040}{40}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\doxysubsection{Member Function Documentation}
\Hypertarget{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}\index{Metadata@{Metadata}!getByteSize@{getByteSize}}
\index{getByteSize@{getByteSize}!Metadata@{Metadata}}
@@ -88,6 +116,10 @@ The size is often required for memory allocation and validation in numerical rou
\begin{DoxyReturn}{Returns}
The total byte size of the data.
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00050}{50}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}\index{Metadata@{Metadata}!getDataType@{getDataType}}
\index{getDataType@{getDataType}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{getDataType()}{getDataType()}}
@@ -106,6 +138,10 @@ The type (e.\+g., "{}float"{}, "{}double"{}) is critical for casting raw data or
\begin{DoxyReturn}{Returns}
A string representing the data type.
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00074}{74}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}\index{Metadata@{Metadata}!getDimensions@{getDimensions}}
\index{getDimensions@{getDimensions}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{getDimensions()}{getDimensions()}}
@@ -124,6 +160,10 @@ Dimensions define the shape of the data (e.\+g., 2D arrays, 3D matrices). This i
\begin{DoxyReturn}{Returns}
A vector representing the size of each dimension.
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00098}{98}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_abe52c81e04665628666b4140cd346b69}\index{Metadata@{Metadata}!isDebugEnabled@{isDebugEnabled}}
\index{isDebugEnabled@{isDebugEnabled}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{isDebugEnabled()}{isDebugEnabled()}}
@@ -142,6 +182,10 @@ Debugging flags can be useful for tracking performance metrics or error provenan
\begin{DoxyReturn}{Returns}
True if debugging is enabled, false otherwise.
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00120}{120}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}\index{Metadata@{Metadata}!setByteSize@{setByteSize}}
\index{setByteSize@{setByteSize}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{setByteSize()}{setByteSize()}}
@@ -164,6 +208,10 @@ It\textquotesingle{}s important to ensure this matches the actual data size in m
{\em byte\+Size} & The total byte size to set. \\
\hline
\end{DoxyParams}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00062}{62}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}\index{Metadata@{Metadata}!setDataType@{setDataType}}
\index{setDataType@{setDataType}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{setDataType()}{setDataType()}}
@@ -186,6 +234,10 @@ When setting the data type, ensure it aligns with the underlying data representa
{\em data\+Type} & A string representing the data type. \\
\hline
\end{DoxyParams}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00086}{86}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}\index{Metadata@{Metadata}!setDebugEnabled@{setDebugEnabled}}
\index{setDebugEnabled@{setDebugEnabled}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{setDebugEnabled()}{setDebugEnabled()}}
@@ -208,6 +260,10 @@ Enabling debugging can introduce performance overhead but provides valuable insi
{\em debug\+Flag} & Whether debugging is enabled. \\
\hline
\end{DoxyParams}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00132}{132}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\Hypertarget{class_metadata_af5264d1666839e69c192b565b5cfa606}\index{Metadata@{Metadata}!setDimensions@{setDimensions}}
\index{setDimensions@{setDimensions}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{setDimensions()}{setDimensions()}}
@@ -232,6 +288,10 @@ When modifying dimensions, verify that they are consistent with the actual data
\end{DoxyParams}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00109}{109}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\doxysubsection{Friends And Related Symbol Documentation}
\Hypertarget{class_metadata_a12949a1ea26c4ff1afeb97101c0493c5}\index{Metadata@{Metadata}!operator$<$$<$@{operator$<$$<$}}
\index{operator$<$$<$@{operator$<$$<$}!Metadata@{Metadata}}
@@ -267,6 +327,69 @@ A reference to the output stream.
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{_metadata_8cpp_source_l00146}{146}} of file \mbox{\hyperlink{_metadata_8cpp_source}{Metadata.\+cpp}}.
\doxysubsection{Member Data Documentation}
\Hypertarget{class_metadata_ac73a509797c98c0d52fb32e1f93e38bc}\index{Metadata@{Metadata}!byteSize\_@{byteSize\_}}
\index{byteSize\_@{byteSize\_}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{byteSize\_}{byteSize\_}}
{\footnotesize\ttfamily \label{class_metadata_ac73a509797c98c0d52fb32e1f93e38bc}
int Metadata\+::byte\+Size\+\_\+ = 0\hspace{0.3cm}{\ttfamily [private]}}
Total size of the data in bytes.
Definition at line \mbox{\hyperlink{_metadata_8h_source_l00126}{126}} of file \mbox{\hyperlink{_metadata_8h_source}{Metadata.\+h}}.
\Hypertarget{class_metadata_a290205e5f46416dd0f48bd6ff62888ac}\index{Metadata@{Metadata}!dataType\_@{dataType\_}}
\index{dataType\_@{dataType\_}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{dataType\_}{dataType\_}}
{\footnotesize\ttfamily \label{class_metadata_a290205e5f46416dd0f48bd6ff62888ac}
std\+::string Metadata\+::data\+Type\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
Type of the data (e.\+g., "{}float"{}, "{}double"{}).
Definition at line \mbox{\hyperlink{_metadata_8h_source_l00127}{127}} of file \mbox{\hyperlink{_metadata_8h_source}{Metadata.\+h}}.
\Hypertarget{class_metadata_a65fd506f1bd41699d9cd19bc0dfc9701}\index{Metadata@{Metadata}!debugFlag\_@{debugFlag\_}}
\index{debugFlag\_@{debugFlag\_}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{debugFlag\_}{debugFlag\_}}
{\footnotesize\ttfamily \label{class_metadata_a65fd506f1bd41699d9cd19bc0dfc9701}
bool Metadata\+::debug\+Flag\+\_\+ = false\hspace{0.3cm}{\ttfamily [private]}}
Indicates whether debugging is enabled.
Definition at line \mbox{\hyperlink{_metadata_8h_source_l00129}{129}} of file \mbox{\hyperlink{_metadata_8h_source}{Metadata.\+h}}.
\Hypertarget{class_metadata_a163f74d4ef9ecd13a34e7e9cab2e21ce}\index{Metadata@{Metadata}!dimensions\_@{dimensions\_}}
\index{dimensions\_@{dimensions\_}!Metadata@{Metadata}}
\doxysubsubsection{\texorpdfstring{dimensions\_}{dimensions\_}}
{\footnotesize\ttfamily \label{class_metadata_a163f74d4ef9ecd13a34e7e9cab2e21ce}
std\+::vector$<$std\+::size\+\_\+t$>$ Metadata\+::dimensions\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
Dimensions of the data (e.\+g., \{3, 4\} for a 3x4 matrix).
Definition at line \mbox{\hyperlink{_metadata_8h_source_l00128}{128}} of file \mbox{\hyperlink{_metadata_8h_source}{Metadata.\+h}}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/dobj/public/\mbox{\hyperlink{_metadata_8h}{Metadata.\+h}}\item