epochryphon/marigold_vector
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api largely finished, polish and comments still needed.

Browse Source
This commit is contained in:
epochryphon
2026-05-17 02:38:56 -05:00
parent 11c2ad914c
commit 2440359748
166 changed files with 17690 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
documentation/latex/Makefile Normal file
View File

@@ -0,0 +1,27 @@
LATEX_CMD?=pdflatex
MKIDX_CMD?=makeindex
BIBTEX_CMD?=bibtex
LATEX_COUNT?=8
MANUAL_FILE?=refman
all: $(MANUAL_FILE).pdf
pdf: $(MANUAL_FILE).pdf
$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex
$(LATEX_CMD) $(MANUAL_FILE)
$(MKIDX_CMD) $(MANUAL_FILE).idx
$(LATEX_CMD) $(MANUAL_FILE)
latex_count=$(LATEX_COUNT) ; \
while grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\
do \
echo "Rerunning latex...." ;\
$(LATEX_CMD) $(MANUAL_FILE) ;\
latex_count=`expr $$latex_count - 1` ;\
done
$(MKIDX_CMD) $(MANUAL_FILE).idx
$(LATEX_CMD) $(MANUAL_FILE)
clean:
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf

2
documentation/latex/README_8md.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{README.\+md File Reference}
\hypertarget{README_8md}{}\label{README_8md}\index{README.md@{README.md}}

4
documentation/latex/annotated.tex Normal file
View File

@@ -0,0 +1,4 @@
\doxysection{Class List}
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} }{\pageref{structdynamic__array}}{}
\end{DoxyCompactList}

17
documentation/latex/dir_2cc67ec09dd8d7c49a4be4d708a4c3a4.tex Normal file
View File

@@ -0,0 +1,17 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal Directory Reference}
\hypertarget{dir_2cc67ec09dd8d7c49a4be4d708a4c3a4}{}\label{dir_2cc67ec09dd8d7c49a4be4d708a4c3a4}\index{source\_code/MODULE\_marigold\_dynamic\_array/internal Directory Reference@{source\_code/MODULE\_marigold\_dynamic\_array/internal Directory Reference}}
Directory dependency graph for internal\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=251pt]{dir_2cc67ec09dd8d7c49a4be4d708a4c3a4_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{internal__marigold__dynamic__array_8c}{internal\+\_\+marigold\+\_\+dynamic\+\_\+array.\+c}}
\item
file \mbox{\hyperlink{internal__marigold__dynamic__array_8h}{internal\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}}
\end{DoxyCompactItemize}

1
documentation/latex/dir_2cc67ec09dd8d7c49a4be4d708a4c3a4_dep.md5 Normal file
View File

@@ -0,0 +1 @@
c99d92860567e7349896677f0c3dd526

BIN
documentation/latex/dir_2cc67ec09dd8d7c49a4be4d708a4c3a4_dep.pdf Normal file
View File

Binary file not shown.

17
documentation/latex/dir_90c81d02fc708513d653b7a692be146e.tex Normal file
View File

@@ -0,0 +1,17 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/tests Directory Reference}
\hypertarget{dir_90c81d02fc708513d653b7a692be146e}{}\label{dir_90c81d02fc708513d653b7a692be146e}\index{source\_code/MODULE\_marigold\_dynamic\_array/tests Directory Reference@{source\_code/MODULE\_marigold\_dynamic\_array/tests Directory Reference}}
Directory dependency graph for tests\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=251pt]{dir_90c81d02fc708513d653b7a692be146e_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{test__marigold__dynamic__array_8c}{test\+\_\+marigold\+\_\+dynamic\+\_\+array.\+c}}
\item
file \mbox{\hyperlink{test__marigold__dynamic__array_8h}{test\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}}
\end{DoxyCompactItemize}

1
documentation/latex/dir_90c81d02fc708513d653b7a692be146e_dep.md5 Normal file
View File

@@ -0,0 +1 @@
b0e3329e8b60d4db8493b8c679d91ffe

BIN
documentation/latex/dir_90c81d02fc708513d653b7a692be146e_dep.pdf Normal file
View File

Binary file not shown.

24
documentation/latex/dir_a37174a683638c83c8672ee30c9f26b4.tex Normal file
View File

@@ -0,0 +1,24 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array Directory Reference}
\hypertarget{dir_a37174a683638c83c8672ee30c9f26b4}{}\label{dir_a37174a683638c83c8672ee30c9f26b4}\index{source\_code/MODULE\_marigold\_dynamic\_array Directory Reference@{source\_code/MODULE\_marigold\_dynamic\_array Directory Reference}}
Directory dependency graph for MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{dir_a37174a683638c83c8672ee30c9f26b4_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Directories}
\begin{DoxyCompactItemize}
\item
directory \mbox{\hyperlink{dir_2cc67ec09dd8d7c49a4be4d708a4c3a4}{internal}}
\item
directory \mbox{\hyperlink{dir_90c81d02fc708513d653b7a692be146e}{tests}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{marigold__dynamic__array_8c}{marigold\+\_\+dynamic\+\_\+array.\+c}}
\item
file \mbox{\hyperlink{marigold__dynamic__array_8h}{marigold\+\_\+dynamic\+\_\+array.\+h}}
\end{DoxyCompactItemize}

1
documentation/latex/dir_a37174a683638c83c8672ee30c9f26b4_dep.md5 Normal file
View File

@@ -0,0 +1 @@
6460d2dfdd176f03d8b354d2e4656819

BIN
documentation/latex/dir_a37174a683638c83c8672ee30c9f26b4_dep.pdf Normal file
View File

Binary file not shown.

22
documentation/latex/dir_fa8e847d942c8fabd99ac1c662089f31.tex Normal file
View File

@@ -0,0 +1,22 @@
\doxysection{source\+\_\+code Directory Reference}
\hypertarget{dir_fa8e847d942c8fabd99ac1c662089f31}{}\label{dir_fa8e847d942c8fabd99ac1c662089f31}\index{source\_code Directory Reference@{source\_code Directory Reference}}
Directory dependency graph for source\+\_\+code\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=268pt]{dir_fa8e847d942c8fabd99ac1c662089f31_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Directories}
\begin{DoxyCompactItemize}
\item
directory \mbox{\hyperlink{dir_a37174a683638c83c8672ee30c9f26b4}{MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{main_8c}{main.\+c}}
\item
file \mbox{\hyperlink{test__main_8c}{test\+\_\+main.\+c}}
\end{DoxyCompactItemize}

1
documentation/latex/dir_fa8e847d942c8fabd99ac1c662089f31_dep.md5 Normal file
View File

@@ -0,0 +1 @@
0382bc33a805a775168fb415895ea64c

BIN
documentation/latex/dir_fa8e847d942c8fabd99ac1c662089f31_dep.pdf Normal file
View File

Binary file not shown.

694
documentation/latex/doxygen.sty Normal file
View File

@@ -0,0 +1,694 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{doxygen}
% Packages used by this style file
\RequirePackage{alltt}
%%\RequirePackage{array} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
\RequirePackage{calc}
\RequirePackage{float}
%%\RequirePackage{ifthen} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
\RequirePackage{verbatim}
\RequirePackage[table]{xcolor}
\RequirePackage{longtable_doxygen}
\RequirePackage{tabu_doxygen}
\RequirePackage{fancyvrb}
\RequirePackage{tabularx}
\RequirePackage{multicol}
\RequirePackage{multirow}
\RequirePackage{hanging}
\RequirePackage{ifpdf}
\RequirePackage{adjustbox}
\RequirePackage{amssymb}
\RequirePackage{stackengine}
\RequirePackage{enumitem}
\RequirePackage{alphalph}
\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis
%---------- Internal commands used in this style file ----------------
\newcommand{\ensurespace}[1]{%
\begingroup%
\setlength{\dimen@}{#1}%
\vskip\z@\@plus\dimen@%
\penalty -100\vskip\z@\@plus -\dimen@%
\vskip\dimen@%
\penalty 9999%
\vskip -\dimen@%
\vskip\z@skip% hide the previous |\vskip| from |\addvspace|
\endgroup%
}
\newcommand{\DoxyHorRuler}[1]{%
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
\ifthenelse{#1=0}%
{%
\hrule%
}%
{%
\hrulefilll%
}%
}
\newcommand{\DoxyLabelFont}{}
\newcommand{\entrylabel}[1]{%
{%
\parbox[b]{\labelwidth-4pt}{%
\makebox[0pt][l]{\DoxyLabelFont#1}%
\vspace{1.5\baselineskip}%
}%
}%
}
\newenvironment{DoxyDesc}[1]{%
\ensurespace{4\baselineskip}%
\begin{list}{}{%
\settowidth{\labelwidth}{20pt}%
%\setlength{\parsep}{0pt}%
\setlength{\itemsep}{0pt}%
\setlength{\leftmargin}{\labelwidth+\labelsep}%
\renewcommand{\makelabel}{\entrylabel}%
}%
\item[#1]%
}{%
\end{list}%
}
\newsavebox{\xrefbox}
\newlength{\xreflength}
\newcommand{\xreflabel}[1]{%
\sbox{\xrefbox}{#1}%
\setlength{\xreflength}{\wd\xrefbox}%
\ifthenelse{\xreflength>\labelwidth}{%
\begin{minipage}{\textwidth}%
\setlength{\parindent}{0pt}%
\hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
\end{minipage}%
}{%
\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
}%
}
%---------- Commands used by doxygen LaTeX output generator ----------
% Used by <pre> ... </pre>
\newenvironment{DoxyPre}{%
\small%
\begin{alltt}%
}{%
\end{alltt}%
\normalsize%
}
% Necessary for redefining not defined characters, i.e. "Replacement Character" in tex output.
\newlength{\CodeWidthChar}
\newlength{\CodeHeightChar}
\settowidth{\CodeWidthChar}{?}
\settoheight{\CodeHeightChar}{?}
% Necessary for hanging indent
\newlength{\DoxyCodeWidth}
\newcommand\DoxyCodeLine[1]{
\ifthenelse{\equal{\detokenize{#1}}{}}
{
\vspace*{\baselineskip}
}
{
\hangpara{\DoxyCodeWidth}{1}{#1}\par
}
}
\newcommand\NiceSpace{%
\discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}%
}
% Used by @code ... @endcode
\newenvironment{DoxyCode}[1]{%
\par%
\scriptsize%
\normalfont\ttfamily%
\rightskip0pt plus 1fil%
\settowidth{\DoxyCodeWidth}{000000}%
\settowidth{\CodeWidthChar}{?}%
\settoheight{\CodeHeightChar}{?}%
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
\ifthenelse{\equal{#1}{0}}
{
{\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces%
}
{
{\lccode`~32 \lowercase{\global\let~}}\obeyspaces%
}
}{%
\normalfont%
\normalsize%
\settowidth{\CodeWidthChar}{?}%
\settoheight{\CodeHeightChar}{?}%
}
% Redefining not defined characters, i.e. "Replacement Character" in tex output.
\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{%
\textcolor{white}{\sffamily\bfseries\small ?}}{%
\rotatebox{45}{$\blacksquare$}}}}
% Used by @example, @include, @includelineno and @dontinclude
\newenvironment{DoxyCodeInclude}[1]{%
\DoxyCode{#1}%
}{%
\endDoxyCode%
}
% Used by @verbatim ... @endverbatim
\newenvironment{DoxyVerb}{%
\par%
\footnotesize%
\verbatim%
}{%
\endverbatim%
\normalsize%
}
% Used by @verbinclude
\newenvironment{DoxyVerbInclude}{%
\DoxyVerb%
}{%
\endDoxyVerb%
}
% Used by numbered lists (using '-#' or <ol> ... </ol>)
\setlistdepth{12}
\newlist{DoxyEnumerate}{enumerate}{12}
\setlist[DoxyEnumerate,1]{label=\arabic*.}
\setlist[DoxyEnumerate,2]{label=(\enumalphalphcnt*)}
\setlist[DoxyEnumerate,3]{label=\roman*.}
\setlist[DoxyEnumerate,4]{label=\enumAlphAlphcnt*.}
\setlist[DoxyEnumerate,5]{label=\arabic*.}
\setlist[DoxyEnumerate,6]{label=(\enumalphalphcnt*)}
\setlist[DoxyEnumerate,7]{label=\roman*.}
\setlist[DoxyEnumerate,8]{label=\enumAlphAlphcnt*.}
\setlist[DoxyEnumerate,9]{label=\arabic*.}
\setlist[DoxyEnumerate,10]{label=(\enumalphalphcnt*)}
\setlist[DoxyEnumerate,11]{label=\roman*.}
\setlist[DoxyEnumerate,12]{label=\enumAlphAlphcnt*.}
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
\setlistdepth{12}
\newlist{DoxyItemize}{itemize}{12}
\setlist[DoxyItemize]{label=\textperiodcentered}
\setlist[DoxyItemize,1]{label=\textbullet}
\setlist[DoxyItemize,2]{label=\normalfont\bfseries \textendash}
\setlist[DoxyItemize,3]{label=\textasteriskcentered}
\setlist[DoxyItemize,4]{label=\textperiodcentered}
% Used by description lists (using <dl> ... </dl>)
\newenvironment{DoxyDescription}{%
\description%
}{%
\enddescription%
}
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
% (only if caption is specified)
\newenvironment{DoxyImage}{%
\begin{figure}[H]%
\centering%
}{%
\end{figure}%
}
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
% (only if no caption is specified)
\newenvironment{DoxyImageNoCaption}{%
\begin{center}%
}{%
\end{center}%
}
% Used by @image
% (only if inline is specified)
\newenvironment{DoxyInlineImage}{%
}{%
}
% Used by @attention
\newenvironment{DoxyAttention}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @author and @authors
\newenvironment{DoxyAuthor}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @date
\newenvironment{DoxyDate}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @invariant
\newenvironment{DoxyInvariant}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @note
\newenvironment{DoxyNote}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @post
\newenvironment{DoxyPostcond}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @pre
\newenvironment{DoxyPrecond}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @copyright
\newenvironment{DoxyCopyright}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @remark
\newenvironment{DoxyRemark}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @return and @returns
\newenvironment{DoxyReturn}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @since
\newenvironment{DoxySince}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @see
\newenvironment{DoxySeeAlso}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @version
\newenvironment{DoxyVersion}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @warning
\newenvironment{DoxyWarning}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by @par and @paragraph
\newenvironment{DoxyParagraph}[1]{%
\begin{DoxyDesc}{#1}%
}{%
\end{DoxyDesc}%
}
% Used by parameter lists
\newenvironment{DoxyParams}[2][]{%
\tabulinesep=1mm%
\par%
\ifthenelse{\equal{#1}{}}%
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description
{\ifthenelse{\equal{#1}{1}}%
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc
}
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used for fields of simple structs
\newenvironment{DoxyFields}[1]{%
\tabulinesep=1mm%
\par%
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}%
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used for fields simple class style enums
\newenvironment{DoxyEnumFields}[1]{%
\tabulinesep=1mm%
\par%
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used for parameters within a detailed function description
\newenvironment{DoxyParamCaption}{%
\renewcommand{\item}[2][]{\\ \hspace*{2.0cm} ##1 {\em ##2}}%
}{%
}
% Used by return value lists
\newenvironment{DoxyRetVals}[1]{%
\tabulinesep=1mm%
\par%
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used by exception lists
\newenvironment{DoxyExceptions}[1]{%
\tabulinesep=1mm%
\par%
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used by template parameter lists
\newenvironment{DoxyTemplParams}[1]{%
\tabulinesep=1mm%
\par%
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endfirsthead%
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
\hline%
\endhead%
}{%
\end{longtabu*}%
\vspace{6pt}%
}
% Used for member lists
\newenvironment{DoxyCompactItemize}{%
\begin{itemize}%
\setlength{\itemsep}{-3pt}%
\setlength{\parsep}{0pt}%
\setlength{\topsep}{0pt}%
\setlength{\partopsep}{0pt}%
}{%
\end{itemize}%
}
% Used for member descriptions
\newenvironment{DoxyCompactList}{%
\begin{list}{}{%
\setlength{\leftmargin}{0.5cm}%
\setlength{\itemsep}{0pt}%
\setlength{\parsep}{0pt}%
\setlength{\topsep}{0pt}%
\renewcommand{\makelabel}{\hfill}%
}%
}{%
\end{list}%
}
% Used for reference lists (@bug, @deprecated, @todo, etc.)
\newenvironment{DoxyRefList}{%
\begin{list}{}{%
\setlength{\labelwidth}{10pt}%
\setlength{\leftmargin}{\labelwidth}%
\addtolength{\leftmargin}{\labelsep}%
\renewcommand{\makelabel}{\xreflabel}%
}%
}{%
\end{list}%
}
% Used by @bug, @deprecated, @todo, etc.
\newenvironment{DoxyRefDesc}[1]{%
\begin{list}{}{%
\renewcommand\makelabel[1]{\textbf{##1}}%
\settowidth\labelwidth{\makelabel{#1}}%
\setlength\leftmargin{\labelwidth+\labelsep}%
}%
}{%
\end{list}%
}
% Used by parameter lists and simple sections
\newenvironment{Desc}
{\begin{list}{}{%
\settowidth{\labelwidth}{20pt}%
\setlength{\parsep}{0pt}%
\setlength{\itemsep}{0pt}%
\setlength{\leftmargin}{\labelwidth+\labelsep}%
\renewcommand{\makelabel}{\entrylabel}%
}
}{%
\end{list}%
}
% Used by tables
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
\newenvironment{TabularC}[1]%
{\tabulinesep=1mm
\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}%
{\end{longtabu*}\par}%
\newenvironment{TabularNC}[1]%
{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}%
{\end{tabu}\par}%
% Used for member group headers
\newenvironment{Indent}{%
\begin{list}{}{%
\setlength{\leftmargin}{0.5cm}%
}%
\item[]\ignorespaces%
}{%
\unskip%
\end{list}%
}
% Used when hyperlinks are turned on
\newcommand{\doxylink}[2]{%
\mbox{\hyperlink{#1}{#2}}%
}
% Used when hyperlinks are turned on
% Third argument is the SectionType, see the doxygen internal
% documentation for the values (relevant: Page ... Subsubsection).
\newcommand{\doxysectlink}[3]{%
\mbox{\hyperlink{#1}{#2}}%
}
% Used when hyperlinks are turned off
\newcommand{\doxyref}[3]{%
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
}
% Used when hyperlinks are turned off
% Fourth argument is the SectionType, see the doxygen internal
% documentation for the values (relevant: Page ... Subsubsection).
\newcommand{\doxysectref}[4]{%
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
}
% Used to link to a table when hyperlinks are turned on
\newcommand{\doxytablelink}[2]{%
\ref{#1}%
}
% Used to link to a table when hyperlinks are turned off
\newcommand{\doxytableref}[3]{%
\ref{#3}%
}
% Used by @addindex
\newcommand{\lcurly}{\{}
\newcommand{\rcurly}{\}}
% Colors used for syntax highlighting
\definecolor{comment}{rgb}{0.5,0.0,0.0}
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
\definecolor{xmlcdata}{rgb}{0.0,0.0,0.0}
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
% Color used for table heading
\newcommand{\tableheadbgcolor}{lightgray}%
% Version of hypertarget with correct landing location
\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}}
% possibility to have sections etc. be within the margins
% unfortunately had to copy part of book.cls and add \raggedright
\makeatletter
\newcounter{subsubsubsection}[subsubsection]
\newcounter{subsubsubsubsection}[subsubsubsection]
\newcounter{subsubsubsubsubsection}[subsubsubsubsection]
\newcounter{subsubsubsubsubsubsection}[subsubsubsubsubsection]
\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}}
\renewcommand{\thesubsubsubsubsection}{\thesubsubsubsection.\arabic{subsubsubsubsection}}
\renewcommand{\thesubsubsubsubsubsection}{\thesubsubsubsubsection.\arabic{subsubsubsubsubsection}}
\renewcommand{\thesubsubsubsubsubsubsection}{\thesubsubsubsubsubsection.\arabic{subsubsubsubsubsubsection}}
\newcommand{\subsubsubsectionmark}[1]{}
\newcommand{\subsubsubsubsectionmark}[1]{}
\newcommand{\subsubsubsubsubsectionmark}[1]{}
\newcommand{\subsubsubsubsubsubsectionmark}[1]{}
\def\toclevel@subsubsubsection{4}
\def\toclevel@subsubsubsubsection{5}
\def\toclevel@subsubsubsubsubsection{6}
\def\toclevel@subsubsubsubsubsubsection{7}
\def\toclevel@paragraph{8}
\def\toclevel@subparagraph{9}
\newcommand\doxysection{\@startsection {section}{1}{\z@}%
{-3.5ex \@plus -1ex \@minus -.2ex}%
{2.3ex \@plus.2ex}%
{\raggedright\normalfont\Large\bfseries}}
\newcommand\doxysubsection{\@startsection{subsection}{2}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\large\bfseries}}
\newcommand\doxysubsubsection{\@startsection{subsubsection}{3}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxysubsubsubsection{\@startsection{subsubsubsection}{4}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxysubsubsubsubsection{\@startsection{subsubsubsubsection}{5}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxysubsubsubsubsubsection{\@startsection{subsubsubsubsubsection}{6}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxysubsubsubsubsubsubsection{\@startsection{subsubsubsubsubsubsection}{7}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxyparagraph{\@startsection{paragraph}{8}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\doxysubparagraph{\@startsection{subparagraph}{9}{\parindent}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\raggedright\normalfont\normalsize\bfseries}}
\newcommand\l@subsubsubsection{\@dottedtocline{4}{6.1em}{7.8em}}
\newcommand\l@subsubsubsubsection{\@dottedtocline{5}{6.1em}{9.4em}}
\newcommand\l@subsubsubsubsubsection{\@dottedtocline{6}{6.1em}{11em}}
\newcommand\l@subsubsubsubsubsubsection{\@dottedtocline{7}{6.1em}{12.6em}}
\renewcommand\l@paragraph{\@dottedtocline{8}{6.1em}{14.2em}}
\renewcommand\l@subparagraph{\@dottedtocline{9}{6.1em}{15.8em}}
\makeatother
% the sectsty doesn't look to be maintained but gives, in our case, some warning like:
% LaTeX Warning: Command \underline has changed.
% Check if current package is valid.
% unfortunately had to copy the relevant part
\newcommand*{\doxypartfont} [1]
{\gdef\SS@partnumberfont{\SS@sectid{0}\SS@nopart\SS@makeulinepartchap#1}
\gdef\SS@parttitlefont{\SS@sectid{0}\SS@titlepart\SS@makeulinepartchap#1}}
\newcommand*{\doxychapterfont} [1]
{\gdef\SS@chapnumfont{\SS@sectid{1}\SS@nopart\SS@makeulinepartchap#1}
\gdef\SS@chaptitlefont{\SS@sectid{1}\SS@titlepart\SS@makeulinepartchap#1}}
\newcommand*{\doxysectionfont} [1]
{\gdef\SS@sectfont{\SS@sectid{2}\SS@rr\SS@makeulinesect#1}}
\newcommand*{\doxysubsectionfont} [1]
{\gdef\SS@subsectfont{\SS@sectid{3}\SS@rr\SS@makeulinesect#1}}
\newcommand*{\doxysubsubsectionfont} [1]
{\gdef\SS@subsubsectfont{\SS@sectid{4}\SS@rr\SS@makeulinesect#1}}
\newcommand*{\doxyparagraphfont} [1]
{\gdef\SS@parafont{\SS@sectid{5}\SS@rr\SS@makeulinesect#1}}
\newcommand*{\doxysubparagraphfont} [1]
{\gdef\SS@subparafont{\SS@sectid{6}\SS@rr\SS@makeulinesect#1}}
\newcommand*{\doxyminisecfont} [1]
{\gdef\SS@minisecfont{\SS@sectid{7}\SS@rr\SS@makeulinepartchap#1}}
\newcommand*{\doxyallsectionsfont} [1] {\doxypartfont{#1}%
\doxychapterfont{#1}%
\doxysectionfont{#1}%
\doxysubsectionfont{#1}%
\doxysubsubsectionfont{#1}%
\doxyparagraphfont{#1}%
\doxysubparagraphfont{#1}%
\doxyminisecfont{#1}}%
% Define caption that is also suitable in a table
\makeatletter
\def\doxyfigcaption{%
\H@refstepcounter{figure}%
\@dblarg{\@caption{figure}}}
\makeatother
% Define alpha enumarative names for counters > 26
\makeatletter
\def\enumalphalphcnt#1{\expandafter\@enumalphalphcnt\csname c@#1\endcsname}
\def\@enumalphalphcnt#1{\alphalph{#1}}
\def\enumAlphAlphcnt#1{\expandafter\@enumAlphAlphcnt\csname c@#1\endcsname}
\def\@enumAlphAlphcnt#1{\AlphAlph{#1}}
\makeatother
\AddEnumerateCounter{\enumalphalphcnt}{\@enumalphalphcnt}{aa}
\AddEnumerateCounter{\enumAlphAlphcnt}{\@enumAlphAlphcnt}{AA}

2178
documentation/latex/etoc_doxygen.sty Normal file
View File

File diff suppressed because it is too large Load Diff

11
documentation/latex/files.tex Normal file
View File

@@ -0,0 +1,11 @@
\doxysection{File List}
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{source\+\_\+code/\mbox{\hyperlink{main_8c}{main.\+c}} }{\pageref{main_8c}}{}
\item\contentsline{section}{source\+\_\+code/\mbox{\hyperlink{test__main_8c}{test\+\_\+main.\+c}} }{\pageref{test__main_8c}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/\mbox{\hyperlink{marigold__dynamic__array_8c}{marigold\+\_\+dynamic\+\_\+array.\+c}} }{\pageref{marigold__dynamic__array_8c}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/\mbox{\hyperlink{marigold__dynamic__array_8h}{marigold\+\_\+dynamic\+\_\+array.\+h}} }{\pageref{marigold__dynamic__array_8h}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal/\mbox{\hyperlink{internal__marigold__dynamic__array_8c}{internal\+\_\+marigold\+\_\+dynamic\+\_\+array.\+c}} }{\pageref{internal__marigold__dynamic__array_8c}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal/\mbox{\hyperlink{internal__marigold__dynamic__array_8h}{internal\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}} }{\pageref{internal__marigold__dynamic__array_8h}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/tests/\mbox{\hyperlink{test__marigold__dynamic__array_8c}{test\+\_\+marigold\+\_\+dynamic\+\_\+array.\+c}} }{\pageref{test__marigold__dynamic__array_8c}}{}
\item\contentsline{section}{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/tests/\mbox{\hyperlink{test__marigold__dynamic__array_8h}{test\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}} }{\pageref{test__marigold__dynamic__array_8h}}{}
\end{DoxyCompactList}

2
documentation/latex/internal__marigold__dynamic__array_8c.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal/internal\+\_\+marigold\+\_\+dynamic\+\_\+array.c File Reference}
\hypertarget{internal__marigold__dynamic__array_8c}{}\label{internal__marigold__dynamic__array_8c}\index{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.c@{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.c}}

27
documentation/latex/internal__marigold__dynamic__array_8h.tex Normal file
View File

@@ -0,0 +1,27 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal/internal\+\_\+marigold\+\_\+dynamic\+\_\+array.h File Reference}
\hypertarget{internal__marigold__dynamic__array_8h}{}\label{internal__marigold__dynamic__array_8h}\index{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h}}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}{dynamic\+\_\+array\+\_\+destroy}} (\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Destroy a dynamic array and free its memory. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Function Documentation}
\Hypertarget{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}\label{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}
\index{internal\_marigold\_dynamic\_array.h@{internal\_marigold\_dynamic\_array.h}!dynamic\_array\_destroy@{dynamic\_array\_destroy}}
\index{dynamic\_array\_destroy@{dynamic\_array\_destroy}!internal\_marigold\_dynamic\_array.h@{internal\_marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_destroy()}{dynamic\_array\_destroy()}}
{\footnotesize\ttfamily void dynamic\+\_\+array\+\_\+destroy (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Destroy a dynamic array and free its memory.
Frees the memory block and the array structure itself. Sets owner\+\_\+count to 0 before freeing.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array} to destroy. \\
\hline
\end{DoxyParams}

8
documentation/latex/internal__marigold__dynamic__array_8h_source.tex Normal file
View File

@@ -0,0 +1,8 @@
\doxysection{internal\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}
\hypertarget{internal__marigold__dynamic__array_8h_source}{}\label{internal__marigold__dynamic__array_8h_source}\index{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h}}
\mbox{\hyperlink{internal__marigold__dynamic__array_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{00001\ }
\DoxyCodeLine{00010\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}{dynamic\_array\_destroy}}(\mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\end{DoxyCode}

456
documentation/latex/longtable_doxygen.sty Normal file
View File

@@ -0,0 +1,456 @@
%%
%% This is file `longtable.sty',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% longtable.dtx (with options: `package')
%%
%% This is a generated file.
%%
%% The source is maintained by the LaTeX Project team and bug
%% reports for it can be opened at http://latex-project.org/bugs.html
%% (but please observe conditions on bug reports sent to that address!)
%%
%% Copyright 1993-2016
%% The LaTeX3 Project and any individual authors listed elsewhere
%% in this file.
%%
%% This file was generated from file(s) of the Standard LaTeX `Tools Bundle'.
%% --------------------------------------------------------------------------
%%
%% It may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3c
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
%% and version 1.3c or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This file may only be distributed together with a copy of the LaTeX
%% `Tools Bundle'. You may however distribute the LaTeX `Tools Bundle'
%% without such generated files.
%%
%% The list of all files belonging to the LaTeX `Tools Bundle' is
%% given in the file `manifest.txt'.
%%
%% File: longtable.dtx Copyright (C) 1990-2001 David Carlisle
\NeedsTeXFormat{LaTeX2e}[1995/06/01]
\ProvidesPackage{longtable_doxygen}
[2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen]
\def\LT@err{\PackageError{longtable}}
\def\LT@warn{\PackageWarning{longtable}}
\def\LT@final@warn{%
\AtEndDocument{%
\LT@warn{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}%
\global\let\LT@final@warn\relax}
\DeclareOption{errorshow}{%
\def\LT@warn{\PackageInfo{longtable}}}
\DeclareOption{pausing}{%
\def\LT@warn#1{%
\LT@err{#1}{This is not really an error}}}
\DeclareOption{set}{}
\DeclareOption{final}{}
\ProcessOptions
\newskip\LTleft \LTleft=\fill
\newskip\LTright \LTright=\fill
\newskip\LTpre \LTpre=\bigskipamount
\newskip\LTpost \LTpost=\bigskipamount
\newcount\LTchunksize \LTchunksize=20
\let\c@LTchunksize\LTchunksize
\newdimen\LTcapwidth \LTcapwidth=4in
\newbox\LT@head
\newbox\LT@firsthead
\newbox\LT@foot
\newbox\LT@lastfoot
\newcount\LT@cols
\newcount\LT@rows
\newcounter{LT@tables}
\newcounter{LT@chunks}[LT@tables]
\ifx\c@table\undefined
\newcounter{table}
\def\fnum@table{\tablename~\thetable}
\fi
\ifx\tablename\undefined
\def\tablename{Table}
\fi
\newtoks\LT@p@ftn
\mathchardef\LT@end@pen=30000
\def\longtable{%
\par
\ifx\multicols\@undefined
\else
\ifnum\col@number>\@ne
\@twocolumntrue
\fi
\fi
\if@twocolumn
\LT@err{longtable not in 1-column mode}\@ehc
\fi
\begingroup
\@ifnextchar[\LT@array{\LT@array[x]}}
\def\LT@array[#1]#2{%
\refstepcounter{table}\stepcounter{LT@tables}%
\if l#1%
\LTleft\z@ \LTright\fill
\else\if r#1%
\LTleft\fill \LTright\z@
\else\if c#1%
\LTleft\fill \LTright\fill
\fi\fi\fi
\let\LT@mcol\multicolumn
\let\LT@@tabarray\@tabarray
\let\LT@@hl\hline
\def\@tabarray{%
\let\hline\LT@@hl
\LT@@tabarray}%
\let\\\LT@tabularcr\let\tabularnewline\\%
\def\newpage{\noalign{\break}}%
\def\pagebreak{\noalign{\ifnum`}=0\fi\@testopt{\LT@no@pgbk-}4}%
\def\nopagebreak{\noalign{\ifnum`}=0\fi\@testopt\LT@no@pgbk4}%
\let\hline\LT@hline \let\kill\LT@kill\let\caption\LT@caption
\@tempdima\ht\strutbox
\let\@endpbox\LT@endpbox
\ifx\extrarowheight\@undefined
\let\@acol\@tabacol
\let\@classz\@tabclassz \let\@classiv\@tabclassiv
\def\@startpbox{\vtop\LT@startpbox}%
\let\@@startpbox\@startpbox
\let\@@endpbox\@endpbox
\let\LT@LL@FM@cr\@tabularcr
\else
\advance\@tempdima\extrarowheight
\col@sep\tabcolsep
\let\@startpbox\LT@startpbox\let\LT@LL@FM@cr\@arraycr
\fi
\setbox\@arstrutbox\hbox{\vrule
\@height \arraystretch \@tempdima
\@depth \arraystretch \dp \strutbox
\@width \z@}%
\let\@sharp##\let\protect\relax
\begingroup
\@mkpream{#2}%
\xdef\LT@bchunk{%
\global\advance\c@LT@chunks\@ne
\global\LT@rows\z@\setbox\z@\vbox\bgroup
\LT@setprevdepth
\tabskip\LTleft \noexpand\halign to\hsize\bgroup
\tabskip\z@ \@arstrut \@preamble \tabskip\LTright \cr}%
\endgroup
\expandafter\LT@nofcols\LT@bchunk&\LT@nofcols
\LT@make@row
\m@th\let\par\@empty
\everycr{}\lineskip\z@\baselineskip\z@
\LT@bchunk}
\def\LT@no@pgbk#1[#2]{\penalty #1\@getpen{#2}\ifnum`{=0\fi}}
\def\LT@start{%
\let\LT@start\endgraf
\endgraf\penalty\z@\vskip\LTpre
\dimen@\pagetotal
\advance\dimen@ \ht\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
\advance\dimen@ \dp\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
\advance\dimen@ \ht\LT@foot
\dimen@ii\vfuzz
\vfuzz\maxdimen
\setbox\tw@\copy\z@
\setbox\tw@\vsplit\tw@ to \ht\@arstrutbox
\setbox\tw@\vbox{\unvbox\tw@}%
\vfuzz\dimen@ii
\advance\dimen@ \ht
\ifdim\ht\@arstrutbox>\ht\tw@\@arstrutbox\else\tw@\fi
\advance\dimen@\dp
\ifdim\dp\@arstrutbox>\dp\tw@\@arstrutbox\else\tw@\fi
\advance\dimen@ -\pagegoal
\ifdim \dimen@>\z@\vfil\break\fi
\global\@colroom\@colht
\ifvoid\LT@foot\else
\advance\vsize-\ht\LT@foot
\global\advance\@colroom-\ht\LT@foot
\dimen@\pagegoal\advance\dimen@-\ht\LT@foot\pagegoal\dimen@
\maxdepth\z@
\fi
\ifvoid\LT@firsthead\copy\LT@head\else\box\LT@firsthead\fi\nobreak
\output{\LT@output}}
\def\endlongtable{%
\crcr
\noalign{%
\let\LT@entry\LT@entry@chop
\xdef\LT@save@row{\LT@save@row}}%
\LT@echunk
\LT@start
\unvbox\z@
\LT@get@widths
\if@filesw
{\let\LT@entry\LT@entry@write\immediate\write\@auxout{%
\gdef\expandafter\noexpand
\csname LT@\romannumeral\c@LT@tables\endcsname
{\LT@save@row}}}%
\fi
\ifx\LT@save@row\LT@@save@row
\else
\LT@warn{Column \@width s have changed\MessageBreak
in table \thetable}%
\LT@final@warn
\fi
\endgraf\penalty -\LT@end@pen
\endgroup
\global\@mparbottom\z@
\pagegoal\vsize
\endgraf\penalty\z@\addvspace\LTpost
\ifvoid\footins\else\insert\footins{}\fi}
\def\LT@nofcols#1&{%
\futurelet\@let@token\LT@n@fcols}
\def\LT@n@fcols{%
\advance\LT@cols\@ne
\ifx\@let@token\LT@nofcols
\expandafter\@gobble
\else
\expandafter\LT@nofcols
\fi}
\def\LT@tabularcr{%
\relax\iffalse{\fi\ifnum0=`}\fi
\@ifstar
{\def\crcr{\LT@crcr\noalign{\nobreak}}\let\cr\crcr
\LT@t@bularcr}%
{\LT@t@bularcr}}
\let\LT@crcr\crcr
\let\LT@setprevdepth\relax
\def\LT@t@bularcr{%
\global\advance\LT@rows\@ne
\ifnum\LT@rows=\LTchunksize
\gdef\LT@setprevdepth{%
\prevdepth\z@\global
\global\let\LT@setprevdepth\relax}%
\expandafter\LT@xtabularcr
\else
\ifnum0=`{}\fi
\expandafter\LT@LL@FM@cr
\fi}
\def\LT@xtabularcr{%
\@ifnextchar[\LT@argtabularcr\LT@ntabularcr}
\def\LT@ntabularcr{%
\ifnum0=`{}\fi
\LT@echunk
\LT@start
\unvbox\z@
\LT@get@widths
\LT@bchunk}
\def\LT@argtabularcr[#1]{%
\ifnum0=`{}\fi
\ifdim #1>\z@
\unskip\@xargarraycr{#1}%
\else
\@yargarraycr{#1}%
\fi
\LT@echunk
\LT@start
\unvbox\z@
\LT@get@widths
\LT@bchunk}
\def\LT@echunk{%
\crcr\LT@save@row\cr\egroup
\global\setbox\@ne\lastbox
\unskip
\egroup}
\def\LT@entry#1#2{%
\ifhmode\@firstofone{&}\fi\omit
\ifnum#1=\c@LT@chunks
\else
\kern#2\relax
\fi}
\def\LT@entry@chop#1#2{%
\noexpand\LT@entry
{\ifnum#1>\c@LT@chunks
1}{0pt%
\else
#1}{#2%
\fi}}
\def\LT@entry@write{%
\noexpand\LT@entry^^J%
\@spaces}
\def\LT@kill{%
\LT@echunk
\LT@get@widths
\expandafter\LT@rebox\LT@bchunk}
\def\LT@rebox#1\bgroup{%
#1\bgroup
\unvbox\z@
\unskip
\setbox\z@\lastbox}
\def\LT@blank@row{%
\xdef\LT@save@row{\expandafter\LT@build@blank
\romannumeral\number\LT@cols 001 }}
\def\LT@build@blank#1{%
\if#1m%
\noexpand\LT@entry{1}{0pt}%
\expandafter\LT@build@blank
\fi}
\def\LT@make@row{%
\global\expandafter\let\expandafter\LT@save@row
\csname LT@\romannumeral\c@LT@tables\endcsname
\ifx\LT@save@row\relax
\LT@blank@row
\else
{\let\LT@entry\or
\if!%
\ifcase\expandafter\expandafter\expandafter\LT@cols
\expandafter\@gobble\LT@save@row
\or
\else
\relax
\fi
!%
\else
\aftergroup\LT@blank@row
\fi}%
\fi}
\let\setlongtables\relax
\def\LT@get@widths{%
\setbox\tw@\hbox{%
\unhbox\@ne
\let\LT@old@row\LT@save@row
\global\let\LT@save@row\@empty
\count@\LT@cols
\loop
\unskip
\setbox\tw@\lastbox
\ifhbox\tw@
\LT@def@row
\advance\count@\m@ne
\repeat}%
\ifx\LT@@save@row\@undefined
\let\LT@@save@row\LT@save@row
\fi}
\def\LT@def@row{%
\let\LT@entry\or
\edef\@tempa{%
\ifcase\expandafter\count@\LT@old@row
\else
{1}{0pt}%
\fi}%
\let\LT@entry\relax
\xdef\LT@save@row{%
\LT@entry
\expandafter\LT@max@sel\@tempa
\LT@save@row}}
\def\LT@max@sel#1#2{%
{\ifdim#2=\wd\tw@
#1%
\else
\number\c@LT@chunks
\fi}%
{\the\wd\tw@}}
\def\LT@hline{%
\noalign{\ifnum0=`}\fi
\penalty\@M
\futurelet\@let@token\LT@@hline}
\def\LT@@hline{%
\ifx\@let@token\hline
\global\let\@gtempa\@gobble
\gdef\LT@sep{\penalty-\@medpenalty\vskip\doublerulesep}%
\else
\global\let\@gtempa\@empty
\gdef\LT@sep{\penalty-\@lowpenalty\vskip-\arrayrulewidth}%
\fi
\ifnum0=`{\fi}%
\multispan\LT@cols
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
\noalign{\LT@sep}%
\multispan\LT@cols
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
\noalign{\penalty\@M}%
\@gtempa}
\def\LT@caption{%
\noalign\bgroup
\@ifnextchar[{\egroup\LT@c@ption\@firstofone}\LT@capti@n}
\def\LT@c@ption#1[#2]#3{%
\LT@makecaption#1\fnum@table{#3}%
\def\@tempa{#2}%
\ifx\@tempa\@empty\else
{\let\\\space
\addcontentsline{lot}{table}{\protect\numberline{\thetable}{#2}}}%
\fi}
\def\LT@capti@n{%
\@ifstar
{\egroup\LT@c@ption\@gobble[]}%
{\egroup\@xdblarg{\LT@c@ption\@firstofone}}}
\def\LT@makecaption#1#2#3{%
\LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
\sbox\@tempboxa{#1{#2: }#3}%
\ifdim\wd\@tempboxa>\hsize
#1{#2: }#3%
\else
\hbox to\hsize{\hfil\box\@tempboxa\hfil}%
\fi
\endgraf\vskip\baselineskip}%
\hss}}}
\def\LT@output{%
\ifnum\outputpenalty <-\@Mi
\ifnum\outputpenalty > -\LT@end@pen
\LT@err{floats and marginpars not allowed in a longtable}\@ehc
\else
\setbox\z@\vbox{\unvbox\@cclv}%
\ifdim \ht\LT@lastfoot>\ht\LT@foot
\dimen@\pagegoal
\advance\dimen@-\ht\LT@lastfoot
\ifdim\dimen@<\ht\z@
\setbox\@cclv\vbox{\unvbox\z@\copy\LT@foot\vss}%
\@makecol
\@outputpage
\setbox\z@\vbox{\box\LT@head}%
\fi
\fi
\global\@colroom\@colht
\global\vsize\@colht
\vbox
{\unvbox\z@\box\ifvoid\LT@lastfoot\LT@foot\else\LT@lastfoot\fi}%
\fi
\else
\setbox\@cclv\vbox{\unvbox\@cclv\copy\LT@foot\vss}%
\@makecol
\@outputpage
\global\vsize\@colroom
\copy\LT@head\nobreak
\fi}
\def\LT@end@hd@ft#1{%
\LT@echunk
\ifx\LT@start\endgraf
\LT@err
{Longtable head or foot not at start of table}%
{Increase LTchunksize}%
\fi
\setbox#1\box\z@
\LT@get@widths
\LT@bchunk}
\def\endfirsthead{\LT@end@hd@ft\LT@firsthead}
\def\endhead{\LT@end@hd@ft\LT@head}
\def\endfoot{\LT@end@hd@ft\LT@foot}
\def\endlastfoot{\LT@end@hd@ft\LT@lastfoot}
\def\LT@startpbox#1{%
\bgroup
\let\@footnotetext\LT@p@ftntext
\setlength\hsize{#1}%
\@arrayparboxrestore
\vrule \@height \ht\@arstrutbox \@width \z@}
\def\LT@endpbox{%
\@finalstrut\@arstrutbox
\egroup
\the\LT@p@ftn
\global\LT@p@ftn{}%
\hfil}
%% added \long to prevent:
% LaTeX Warning: Command \LT@p@ftntext has changed.
%
% from the original repository (https://github.com/latex3/latex2e/blob/develop/required/tools/longtable.dtx):
% \changes{v4.15}{2021/03/28}
% {make long for gh/364}
% Inside the `p' column, just save up the footnote text in a token
% register.
\long\def\LT@p@ftntext#1{%
\edef\@tempa{\the\LT@p@ftn\noexpand\footnotetext[\the\c@footnote]}%
\global\LT@p@ftn\expandafter{\@tempa{#1}}}%
\@namedef{ver@longtable.sty}{2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen}
\endinput
%%
%% End of file `longtable.sty'.

26
documentation/latex/main_8c.tex Normal file
View File

@@ -0,0 +1,26 @@
\doxysection{source\+\_\+code/main.c File Reference}
\hypertarget{main_8c}{}\label{main_8c}\index{source\_code/main.c@{source\_code/main.c}}
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include "{}MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/marigold\+\_\+dynamic\+\_\+array.\+h"{}}\newline
Include dependency graph for main.\+c\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=324pt]{main_8c__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
int \mbox{\hyperlink{main_8c_a840291bc02cba5474a4cb46a9b9566fe}{main}} (void)
\end{DoxyCompactItemize}
\doxysubsection{Function Documentation}
\Hypertarget{main_8c_a840291bc02cba5474a4cb46a9b9566fe}\label{main_8c_a840291bc02cba5474a4cb46a9b9566fe}
\index{main.c@{main.c}!main@{main}}
\index{main@{main}!main.c@{main.c}}
\doxysubsubsection{\texorpdfstring{main()}{main()}}
{\footnotesize\ttfamily int main (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

1
documentation/latex/main_8c__incl.md5 Normal file
View File

@@ -0,0 +1 @@
373d51ce459a8cf191919b09c4cf7f65

BIN
documentation/latex/main_8c__incl.pdf Normal file
View File

Binary file not shown.

2
documentation/latex/marigold__dynamic__array_8c.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/marigold\+\_\+dynamic\+\_\+array.c File Reference}
\hypertarget{marigold__dynamic__array_8c}{}\label{marigold__dynamic__array_8c}\index{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.c@{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.c}}

391
documentation/latex/marigold__dynamic__array_8h.tex Normal file
View File

@@ -0,0 +1,391 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/marigold\+\_\+dynamic\+\_\+array.h File Reference}
\hypertarget{marigold__dynamic__array_8h}{}\label{marigold__dynamic__array_8h}\index{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.h}}
{\ttfamily \#include $<$stdbool.\+h$>$}\newline
{\ttfamily \#include $<$stdint.\+h$>$}\newline
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
Include dependency graph for marigold\+\_\+dynamic\+\_\+array.\+h\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=285pt]{marigold__dynamic__array_8h__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=229pt]{marigold__dynamic__array_8h__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
typedef struct \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \mbox{\hyperlink{marigold__dynamic__array_8h_aa03749e816311cda5048f053a4bbc069}{dynamic\+\_\+array}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{marigold__dynamic__array_8h_a12a619cb69a69466342cf46c4ed32ca0}{dynamic\+\_\+array\+\_\+create}} (size\+\_\+t item\+\_\+size, unsigned int starting\+\_\+capacity, unsigned char growth\+\_\+factor, bool is\+\_\+multithread\+\_\+safe)
\begin{DoxyCompactList}\small\item\em Create and initialize a new dynamic array. \end{DoxyCompactList}\item
unsigned int \mbox{\hyperlink{marigold__dynamic__array_8h_af82db6ce1a4c0277250ac4545b992517}{dynamic\+\_\+array\+\_\+get\+\_\+occupancy}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Get the number of elements currently in the array. \end{DoxyCompactList}\item
unsigned int \mbox{\hyperlink{marigold__dynamic__array_8h_a97aef4192e7bf8bc6601a485b975e8a1}{dynamic\+\_\+array\+\_\+get\+\_\+capacity}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Get the total capacity of the array. \end{DoxyCompactList}\item
void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{marigold__dynamic__array_8h_aa716a8b7cc3e7e4f2776445956b6f20c}{dynamic\+\_\+array\+\_\+get\+\_\+pointer\+\_\+to\+\_\+index}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array, const unsigned int index)
\begin{DoxyCompactList}\small\item\em Get a pointer to the element at the specified index. \end{DoxyCompactList}\item
const void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{marigold__dynamic__array_8h_a54614709f28d2da67d1349b39d449a64}{dynamic\+\_\+array\+\_\+get\+\_\+const\+\_\+pointer\+\_\+to\+\_\+index}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array, const unsigned int index)
\begin{DoxyCompactList}\small\item\em Get a const pointer to the element at the specified index. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_a41f398054650aba92c3cf66e6278273f}{dynamic\+\_\+array\+\_\+append}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array, const void \texorpdfstring{$\ast$}{*}element)
\begin{DoxyCompactList}\small\item\em Append an element to the end of the array. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_a8ffd2d54341aa8daa04fdac517e85b0b}{dynamic\+\_\+array\+\_\+pop}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Remove the last element from the array. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_a6c315e8471380136e9b4d1b17537481b}{dynamic\+\_\+array\+\_\+remove}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array, const unsigned int index)
\begin{DoxyCompactList}\small\item\em Remove an element at the specified index. \end{DoxyCompactList}\item
void \mbox{\hyperlink{marigold__dynamic__array_8h_a263862e1f35e8bde17a1ba9307b60785}{dynamic\+\_\+array\+\_\+clear}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Clear all elements from the array. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_a860a30efb898e1e20631b95ae544ece9}{dynamic\+\_\+array\+\_\+is\+\_\+empty}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Check if the array is empty. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_ab10002f58472dcb5f04c04c56790640d}{dynamic\+\_\+array\+\_\+increase\+\_\+capacity}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array, const unsigned int new\+\_\+capacity)
\begin{DoxyCompactList}\small\item\em Reserve additional capacity without changing size. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_af813494ee16c94e4f9d031be1665d2be}{dynamic\+\_\+array\+\_\+acquire}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Increment the owner count for shared ownership. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_a0638d6e4c6aba0de9925609de03bd57a}{dynamic\+\_\+array\+\_\+release}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Decrement the owner count for shared ownership. \end{DoxyCompactList}\item
unsigned short \mbox{\hyperlink{marigold__dynamic__array_8h_ac0fcc3f5599e1fbb2b14f48dc8cf1551}{dynamic\+\_\+array\+\_\+get\+\_\+owner\+\_\+count}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Get the current owner count. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_afd8d4acd91ed7b5260881faf93c2e265}{dynamic\+\_\+array\+\_\+is\+\_\+thread\+\_\+safe}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
\begin{DoxyCompactList}\small\item\em Check if the array is thread-\/safe. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{marigold__dynamic__array_8h_ab26fb7035357345d1db2d2619a96112f}{dynamic\+\_\+array\+\_\+clone}} (const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}original\+\_\+array, const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}new\+\_\+array)
\begin{DoxyCompactList}\small\item\em Creates a deep copy of the array. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Typedef Documentation}
\Hypertarget{marigold__dynamic__array_8h_aa03749e816311cda5048f053a4bbc069}\label{marigold__dynamic__array_8h_aa03749e816311cda5048f053a4bbc069}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array@{dynamic\_array}}
\index{dynamic\_array@{dynamic\_array}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array}{dynamic\_array}}
{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}}}
\doxysubsection{Function Documentation}
\Hypertarget{marigold__dynamic__array_8h_af813494ee16c94e4f9d031be1665d2be}\label{marigold__dynamic__array_8h_af813494ee16c94e4f9d031be1665d2be}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_acquire@{dynamic\_array\_acquire}}
\index{dynamic\_array\_acquire@{dynamic\_array\_acquire}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_acquire()}{dynamic\_array\_acquire()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+acquire (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Increment the owner count for shared ownership.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false if owner\+\_\+count would overflow.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a41f398054650aba92c3cf66e6278273f}\label{marigold__dynamic__array_8h_a41f398054650aba92c3cf66e6278273f}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_append@{dynamic\_array\_append}}
\index{dynamic\_array\_append@{dynamic\_array\_append}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_append()}{dynamic\_array\_append()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+append (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array, }\item[{const void \texorpdfstring{$\ast$}{*}}]{element }\end{DoxyParamCaption})}
Append an element to the end of the array.
Automatically resizes if current\+\_\+size equals current\+\_\+capacity.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
{\em element} & Pointer to the element to append. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false on allocation failure.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a263862e1f35e8bde17a1ba9307b60785}\label{marigold__dynamic__array_8h_a263862e1f35e8bde17a1ba9307b60785}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_clear@{dynamic\_array\_clear}}
\index{dynamic\_array\_clear@{dynamic\_array\_clear}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_clear()}{dynamic\_array\_clear()}}
{\footnotesize\ttfamily void dynamic\+\_\+array\+\_\+clear (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Clear all elements from the array.
Sets current\+\_\+size to 0. Does not free the memory block.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\Hypertarget{marigold__dynamic__array_8h_ab26fb7035357345d1db2d2619a96112f}\label{marigold__dynamic__array_8h_ab26fb7035357345d1db2d2619a96112f}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_clone@{dynamic\_array\_clone}}
\index{dynamic\_array\_clone@{dynamic\_array\_clone}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_clone()}{dynamic\_array\_clone()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+clone (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{original\+\_\+array, }\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{new\+\_\+array }\end{DoxyParamCaption})}
Creates a deep copy of the array.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the copy being copied, and one to copy it onto. Must create your own struct instance.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if creation is successful. False if it fails for any reason.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a12a619cb69a69466342cf46c4ed32ca0}\label{marigold__dynamic__array_8h_a12a619cb69a69466342cf46c4ed32ca0}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_create@{dynamic\_array\_create}}
\index{dynamic\_array\_create@{dynamic\_array\_create}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_create()}{dynamic\_array\_create()}}
{\footnotesize\ttfamily \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*} dynamic\+\_\+array\+\_\+create (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{item\+\_\+size, }\item[{unsigned int}]{starting\+\_\+capacity, }\item[{unsigned char}]{growth\+\_\+factor, }\item[{bool}]{is\+\_\+multithread\+\_\+safe }\end{DoxyParamCaption})}
Create and initialize a new dynamic array.
Creates a dynamic array with the specified item size and starting capacity. The growth\+\_\+factor determines how the array expands when capacity is exceeded.
\begin{DoxyParams}{Parameters}
{\em item\+\_\+size} & Size of each element in bytes. \\
\hline
{\em starting\+\_\+capacity} & Initial number of elements to allocate space for. \\
\hline
{\em growth\+\_\+factor} & Growth strategy\+: 0 = linear (+starting\+\_\+capacity), 1 = 1.\+5x, 2+ = multiplier (2 = 2x, 3 = 3x, etc.) \\
\hline
{\em is\+\_\+multithread\+\_\+safe} & If true, enables thread-\/safe operations. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Pointer to the initialized \doxylink{structdynamic__array}{dynamic\+\_\+array}, or NULL on failure.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a97aef4192e7bf8bc6601a485b975e8a1}\label{marigold__dynamic__array_8h_a97aef4192e7bf8bc6601a485b975e8a1}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_get\_capacity@{dynamic\_array\_get\_capacity}}
\index{dynamic\_array\_get\_capacity@{dynamic\_array\_get\_capacity}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_get\_capacity()}{dynamic\_array\_get\_capacity()}}
{\footnotesize\ttfamily unsigned int dynamic\+\_\+array\+\_\+get\+\_\+capacity (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Get the total capacity of the array.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Total capacity (current\+\_\+capacity).
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a54614709f28d2da67d1349b39d449a64}\label{marigold__dynamic__array_8h_a54614709f28d2da67d1349b39d449a64}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_get\_const\_pointer\_to\_index@{dynamic\_array\_get\_const\_pointer\_to\_index}}
\index{dynamic\_array\_get\_const\_pointer\_to\_index@{dynamic\_array\_get\_const\_pointer\_to\_index}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_get\_const\_pointer\_to\_index()}{dynamic\_array\_get\_const\_pointer\_to\_index()}}
{\footnotesize\ttfamily const void \texorpdfstring{$\ast$}{*} dynamic\+\_\+array\+\_\+get\+\_\+const\+\_\+pointer\+\_\+to\+\_\+index (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array, }\item[{const unsigned int}]{index }\end{DoxyParamCaption})}
Get a const pointer to the element at the specified index.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
{\em index} & Index of the element to access. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Const pointer to the element, or NULL if index is out of bounds.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_af82db6ce1a4c0277250ac4545b992517}\label{marigold__dynamic__array_8h_af82db6ce1a4c0277250ac4545b992517}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_get\_occupancy@{dynamic\_array\_get\_occupancy}}
\index{dynamic\_array\_get\_occupancy@{dynamic\_array\_get\_occupancy}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_get\_occupancy()}{dynamic\_array\_get\_occupancy()}}
{\footnotesize\ttfamily unsigned int dynamic\+\_\+array\+\_\+get\+\_\+occupancy (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Get the number of elements currently in the array.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Number of elements (current\+\_\+size).
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_ac0fcc3f5599e1fbb2b14f48dc8cf1551}\label{marigold__dynamic__array_8h_ac0fcc3f5599e1fbb2b14f48dc8cf1551}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_get\_owner\_count@{dynamic\_array\_get\_owner\_count}}
\index{dynamic\_array\_get\_owner\_count@{dynamic\_array\_get\_owner\_count}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_get\_owner\_count()}{dynamic\_array\_get\_owner\_count()}}
{\footnotesize\ttfamily unsigned short dynamic\+\_\+array\+\_\+get\+\_\+owner\+\_\+count (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Get the current owner count.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Current owner\+\_\+count value.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_aa716a8b7cc3e7e4f2776445956b6f20c}\label{marigold__dynamic__array_8h_aa716a8b7cc3e7e4f2776445956b6f20c}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_get\_pointer\_to\_index@{dynamic\_array\_get\_pointer\_to\_index}}
\index{dynamic\_array\_get\_pointer\_to\_index@{dynamic\_array\_get\_pointer\_to\_index}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_get\_pointer\_to\_index()}{dynamic\_array\_get\_pointer\_to\_index()}}
{\footnotesize\ttfamily void \texorpdfstring{$\ast$}{*} dynamic\+\_\+array\+\_\+get\+\_\+pointer\+\_\+to\+\_\+index (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array, }\item[{const unsigned int}]{index }\end{DoxyParamCaption})}
Get a pointer to the element at the specified index.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
{\em index} & Index of the element to access. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Pointer to the element, or NULL if index is out of bounds.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_ab10002f58472dcb5f04c04c56790640d}\label{marigold__dynamic__array_8h_ab10002f58472dcb5f04c04c56790640d}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_increase\_capacity@{dynamic\_array\_increase\_capacity}}
\index{dynamic\_array\_increase\_capacity@{dynamic\_array\_increase\_capacity}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_increase\_capacity()}{dynamic\_array\_increase\_capacity()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+increase\+\_\+capacity (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array, }\item[{const unsigned int}]{new\+\_\+capacity }\end{DoxyParamCaption})}
Reserve additional capacity without changing size.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
{\em new\+\_\+capacity} & Desired capacity. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false on allocation failure.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a860a30efb898e1e20631b95ae544ece9}\label{marigold__dynamic__array_8h_a860a30efb898e1e20631b95ae544ece9}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_is\_empty@{dynamic\_array\_is\_empty}}
\index{dynamic\_array\_is\_empty@{dynamic\_array\_is\_empty}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_is\_empty()}{dynamic\_array\_is\_empty()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+is\+\_\+empty (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Check if the array is empty.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if current\+\_\+size is 0, false otherwise.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_afd8d4acd91ed7b5260881faf93c2e265}\label{marigold__dynamic__array_8h_afd8d4acd91ed7b5260881faf93c2e265}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_is\_thread\_safe@{dynamic\_array\_is\_thread\_safe}}
\index{dynamic\_array\_is\_thread\_safe@{dynamic\_array\_is\_thread\_safe}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_is\_thread\_safe()}{dynamic\_array\_is\_thread\_safe()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+is\+\_\+thread\+\_\+safe (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Check if the array is thread-\/safe.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if is\+\_\+multithread\+\_\+safe is set, false otherwise.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a8ffd2d54341aa8daa04fdac517e85b0b}\label{marigold__dynamic__array_8h_a8ffd2d54341aa8daa04fdac517e85b0b}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_pop@{dynamic\_array\_pop}}
\index{dynamic\_array\_pop@{dynamic\_array\_pop}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_pop()}{dynamic\_array\_pop()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+pop (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Remove the last element from the array.
Decrements current\+\_\+size. Does not free the memory block.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false if array is empty.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a0638d6e4c6aba0de9925609de03bd57a}\label{marigold__dynamic__array_8h_a0638d6e4c6aba0de9925609de03bd57a}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_release@{dynamic\_array\_release}}
\index{dynamic\_array\_release@{dynamic\_array\_release}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_release()}{dynamic\_array\_release()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+release (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
Decrement the owner count for shared ownership.
If owner\+\_\+count reaches 0, the array is automatically destroyed.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if owner\+\_\+count \texorpdfstring{$>$}{>} 0 after decrement, false if destroyed.
\end{DoxyReturn}
\Hypertarget{marigold__dynamic__array_8h_a6c315e8471380136e9b4d1b17537481b}\label{marigold__dynamic__array_8h_a6c315e8471380136e9b4d1b17537481b}
\index{marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}!dynamic\_array\_remove@{dynamic\_array\_remove}}
\index{dynamic\_array\_remove@{dynamic\_array\_remove}!marigold\_dynamic\_array.h@{marigold\_dynamic\_array.h}}
\doxysubsubsection{\texorpdfstring{dynamic\_array\_remove()}{dynamic\_array\_remove()}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+\_\+remove (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array, }\item[{const unsigned int}]{index }\end{DoxyParamCaption})}
Remove an element at the specified index.
Shifts subsequent elements down to fill the gap.
\begin{DoxyParams}{Parameters}
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array}. \\
\hline
{\em index} & Index of the element to remove. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false if index is out of bounds.
\end{DoxyReturn}

1
documentation/latex/marigold__dynamic__array_8h__dep__incl.md5 Normal file
View File

@@ -0,0 +1 @@
346939f1c00e7d92eddb43b49492aba5

BIN
documentation/latex/marigold__dynamic__array_8h__dep__incl.pdf Normal file
View File

Binary file not shown.

1
documentation/latex/marigold__dynamic__array_8h__incl.md5 Normal file
View File

@@ -0,0 +1 @@
e30c7e4e64171e798a55830b8f9e0a07

BIN
documentation/latex/marigold__dynamic__array_8h__incl.pdf Normal file
View File

Binary file not shown.

70
documentation/latex/marigold__dynamic__array_8h_source.tex Normal file
View File

@@ -0,0 +1,70 @@
\doxysection{marigold\+\_\+dynamic\+\_\+array.\+h}
\hypertarget{marigold__dynamic__array_8h_source}{}\label{marigold__dynamic__array_8h_source}\index{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/marigold\_dynamic\_array.h}}
\mbox{\hyperlink{marigold__dynamic__array_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{00001\ \textcolor{preprocessor}{\#ifndef\ DYNAMIC\_ARRAY\_H}}
\DoxyCodeLine{00002\ \textcolor{preprocessor}{\#define\ DYNAMIC\_ARRAY\_H}}
\DoxyCodeLine{00003\ }
\DoxyCodeLine{00004\ \textcolor{preprocessor}{\#include\ <stdbool.h>}}
\DoxyCodeLine{00005\ \textcolor{preprocessor}{\#include\ <stdint.h>}}
\DoxyCodeLine{00006\ \textcolor{preprocessor}{\#include\ <stdlib.h>}}
\DoxyCodeLine{00007\ }
\DoxyCodeLine{00008\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\mbox{\hyperlink{structdynamic__array}{dynamic\_array}}}
\DoxyCodeLine{00009\ \{}
\DoxyCodeLine{00010\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{size\_t}\ \mbox{\hyperlink{structdynamic__array_a3b19d692a6b8539bc58551e39bf6dfaa}{item\_size}};}
\DoxyCodeLine{00011\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{void}*\ \mbox{\hyperlink{structdynamic__array_a2fec64b33dac49cedbc5888cd8e8a846}{memory\_block\_pointer}};}
\DoxyCodeLine{00012\ }
\DoxyCodeLine{00013\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structdynamic__array_ac33ca1e3db1d4229852b9f36b62f2e08}{starting\_capacity}};}
\DoxyCodeLine{00014\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structdynamic__array_a633fcea60fb454a78a7a058e3bda0bbe}{current\_capacity}};}
\DoxyCodeLine{00015\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{structdynamic__array_ae7da5f21eb2bfdeff0e05b53598185c5}{current\_size}};}
\DoxyCodeLine{00016\ }
\DoxyCodeLine{00017\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{short}\ \mbox{\hyperlink{structdynamic__array_a105f76026911ac2665bf25a73ecf30a6}{owner\_count}};}
\DoxyCodeLine{00018\ }
\DoxyCodeLine{00019\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{char}\ \mbox{\hyperlink{structdynamic__array_aa3d42a1672d2015f89d8c607124fa3e5}{growth\_factor}};}
\DoxyCodeLine{00020\ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{structdynamic__array_affeb533fae8aa1d8d80abc61e3380cc1}{is\_multithread\_safe}};}
\DoxyCodeLine{00021\ \}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}};}
\DoxyCodeLine{00022\ }
\DoxyCodeLine{00036\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ \mbox{\hyperlink{marigold__dynamic__array_8h_a12a619cb69a69466342cf46c4ed32ca0}{dynamic\_array\_create}}(\textcolor{keywordtype}{size\_t}\ item\_size,}
\DoxyCodeLine{00037\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ starting\_capacity,}
\DoxyCodeLine{00038\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{char}\ growth\_factor,}
\DoxyCodeLine{00039\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{bool}\ is\_multithread\_safe);}
\DoxyCodeLine{00040\ }
\DoxyCodeLine{00047\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{marigold__dynamic__array_8h_af82db6ce1a4c0277250ac4545b992517}{dynamic\_array\_get\_occupancy}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00048\ }
\DoxyCodeLine{00055\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a97aef4192e7bf8bc6601a485b975e8a1}{dynamic\_array\_get\_capacity}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00056\ }
\DoxyCodeLine{00064\ \textcolor{keywordtype}{void}*\ \mbox{\hyperlink{marigold__dynamic__array_8h_aa716a8b7cc3e7e4f2776445956b6f20c}{dynamic\_array\_get\_pointer\_to\_index}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array,}
\DoxyCodeLine{00065\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ index);}
\DoxyCodeLine{00066\ }
\DoxyCodeLine{00074\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{void}*\ \mbox{\hyperlink{marigold__dynamic__array_8h_a54614709f28d2da67d1349b39d449a64}{dynamic\_array\_get\_const\_pointer\_to\_index}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array,}
\DoxyCodeLine{00075\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ index);}
\DoxyCodeLine{00076\ }
\DoxyCodeLine{00086\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a41f398054650aba92c3cf66e6278273f}{dynamic\_array\_append}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array,}
\DoxyCodeLine{00087\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{void}*\ element);}
\DoxyCodeLine{00088\ }
\DoxyCodeLine{00097\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a8ffd2d54341aa8daa04fdac517e85b0b}{dynamic\_array\_pop}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00098\ }
\DoxyCodeLine{00108\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a6c315e8471380136e9b4d1b17537481b}{dynamic\_array\_remove}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array,}
\DoxyCodeLine{00109\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ index);}
\DoxyCodeLine{00110\ }
\DoxyCodeLine{00118\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a263862e1f35e8bde17a1ba9307b60785}{dynamic\_array\_clear}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00119\ }
\DoxyCodeLine{00126\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a860a30efb898e1e20631b95ae544ece9}{dynamic\_array\_is\_empty}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00127\ }
\DoxyCodeLine{00135\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_ab10002f58472dcb5f04c04c56790640d}{dynamic\_array\_increase\_capacity}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array,}
\DoxyCodeLine{00136\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{int}\ new\_capacity);}
\DoxyCodeLine{00137\ }
\DoxyCodeLine{00144\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_af813494ee16c94e4f9d031be1665d2be}{dynamic\_array\_acquire}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00145\ }
\DoxyCodeLine{00154\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_a0638d6e4c6aba0de9925609de03bd57a}{dynamic\_array\_release}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00155\ }
\DoxyCodeLine{00162\ \textcolor{keywordtype}{unsigned}\ \textcolor{keywordtype}{short}\ \mbox{\hyperlink{marigold__dynamic__array_8h_ac0fcc3f5599e1fbb2b14f48dc8cf1551}{dynamic\_array\_get\_owner\_count}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00163\ }
\DoxyCodeLine{00170\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_afd8d4acd91ed7b5260881faf93c2e265}{dynamic\_array\_is\_thread\_safe}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ array);}
\DoxyCodeLine{00171\ }
\DoxyCodeLine{00180\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{marigold__dynamic__array_8h_ab26fb7035357345d1db2d2619a96112f}{dynamic\_array\_clone}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ original\_array,}
\DoxyCodeLine{00181\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{structdynamic__array}{dynamic\_array}}*\ new\_array);}
\DoxyCodeLine{00182\ }
\DoxyCodeLine{00183\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{/*\ DYNAMIC\_ARRAY\_H\ */}\textcolor{preprocessor}{}}
\end{DoxyCode}

5
documentation/latex/md_README.tex Normal file
View File

@@ -0,0 +1,5 @@
\chapter{marigold\+\_\+dynamic\+\_\+array}
\hypertarget{md_README}{}\label{md_README}\index{marigold\_dynamic\_array@{marigold\_dynamic\_array}}
\label{md_README_autotoc_md0}%
\Hypertarget{md_README_autotoc_md0}%
\doxylink{structdynamic__array}{dynamic\+\_\+array} implementation in C99 with toggle-\/able thread-\/safety via mutex locks.

238
documentation/latex/refman.tex Normal file
View File

@@ -0,0 +1,238 @@
% Handle batch mode
% to overcome problems with too many open files
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
\pdfminorversion=7
% Set document class depending on configuration
\documentclass[twoside]{book}
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
\usepackage{ifthen}
\ifx\requestedLaTeXdate\undefined
\usepackage{array}
\else
\usepackage{array}[=2016-10-06]
\fi
%%
% Packages required by doxygen
\makeatletter
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
% suppress package identification of infwarerr as it contains the word "warning"
\let\@@protected@wlog\protected@wlog
\def\protected@wlog#1{\wlog{package info suppressed}}
\RequirePackage{infwarerr}
\let\protected@wlog\@@protected@wlog
\makeatother
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
\usepackage{doxygen}
\usepackage{graphicx}
\usepackage[utf8]{inputenc}
\usepackage{makeidx}
\PassOptionsToPackage{warn}{textcomp}
\usepackage{textcomp}
\usepackage[nointegrals]{wasysym}
\usepackage{ifxetex}
% NLS support packages
% Define default fonts
% Font selection
\usepackage[T1]{fontenc}
% set main and monospaced font
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\renewcommand{\familydefault}{\sfdefault}
\doxyallsectionsfont{%
\fontseries{bc}\selectfont%
\color{darkgray}%
}
\renewcommand{\DoxyLabelFont}{%
\fontseries{bc}\selectfont%
\color{darkgray}%
}
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
% Arguments of doxygenemoji:
% 1) ':<text>:' form of the emoji, already LaTeX-escaped
% 2) file with the name of the emoji without the .png extension
% in case image exist use this otherwise use the ':<text>:' form
\newcommand{\doxygenemoji}[2]{%
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
}
% Page & text layout
\usepackage{geometry}
\geometry{%
a4paper,%
top=2.5cm,%
bottom=2.5cm,%
left=2.5cm,%
right=2.5cm%
}
\usepackage{changepage}
% Allow a bit of overflow to go unnoticed by other means
\tolerance=750
\hfuzz=15pt
\hbadness=750
\setlength{\emergencystretch}{15pt}
\setlength{\parindent}{0cm}
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
\doxynormalparskip
% Redefine paragraph/subparagraph environments, using sectsty fonts
\makeatletter
\renewcommand{\paragraph}{%
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
\normalfont\normalsize\bfseries\SS@parafont%
}%
}
\renewcommand{\subparagraph}{%
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
\normalfont\normalsize\bfseries\SS@subparafont%
}%
}
\makeatother
\makeatletter
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
\makeatother
% Headers & footers
\usepackage{fancyhdr}
\pagestyle{fancyplain}
\renewcommand{\footrulewidth}{0.4pt}
\fancypagestyle{fancyplain}{
\fancyhf{}
\fancyhead[LE, RO]{\bfseries\thepage}
\fancyhead[LO]{\bfseries\rightmark}
\fancyhead[RE]{\bfseries\leftmark}
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
}
\fancypagestyle{plain}{
\fancyhf{}
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
\renewcommand{\headrulewidth}{0pt}
}
\pagestyle{fancyplain}
\renewcommand{\chaptermark}[1]{%
\markboth{#1}{}%
}
\renewcommand{\sectionmark}[1]{%
\markright{\thesection\ #1}%
}
% ToC, LoF, LoT, bibliography, and index
% Indices & bibliography
\usepackage{natbib}
\usepackage[titles]{tocloft}
\setcounter{tocdepth}{3}
\setcounter{secnumdepth}{5}
% creating indexes
\makeindex
\usepackage{newunicodechar}
\makeatletter
\def\doxynewunicodechar#1#2{%
\@tempswafalse
\edef\nuc@tempa{\detokenize{#1}}%
\if\relax\nuc@tempa\relax
\nuc@emptyargerr
\else
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
\nuc@check
\if@tempswa
\@namedef{u8:\nuc@tempa}{#2}%
\fi
\fi
}
\makeatother
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
% Hyperlinks
% Hyperlinks (required, but should be loaded last)
\ifpdf
\usepackage[pdftex,pagebackref=true]{hyperref}
\else
\ifxetex
\usepackage[pagebackref=true]{hyperref}
\else
\usepackage[ps2pdf,pagebackref=true]{hyperref}
\fi
\fi
\hypersetup{%
colorlinks=true,%
linkcolor=blue,%
citecolor=blue,%
unicode,%
pdftitle={My Project},%
pdfsubject={}%
}
% Custom commands used by the header
% Custom commands
\newcommand{\clearemptydoublepage}{%
\newpage{\pagestyle{empty}\cleardoublepage}%
}
% caption style definition
\usepackage{caption}
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
% in page table of contents
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
\etocsetlevel{subsubsubsection}{4}
\etocsetlevel{subsubsubsubsection}{5}
\etocsetlevel{subsubsubsubsubsection}{6}
\etocsetlevel{subsubsubsubsubsubsection}{7}
\etocsetlevel{paragraph}{8}
\etocsetlevel{subparagraph}{9}
% prevent numbers overlap the titles in toc
\renewcommand{\numberline}[1]{#1~}
% End of preamble, now comes the document contents
%===== C O N T E N T S =====
\begin{document}
\raggedbottom
% Titlepage & ToC
% To avoid duplicate page anchors due to reuse of same numbers for
% the index (be it as roman numbers)
\hypersetup{pageanchor=false,
bookmarksnumbered=true,
pdfencoding=unicode
}
\pagenumbering{alph}
\begin{titlepage}
\vspace*{7cm}
\begin{center}%
{\Large My Project}\\
\vspace*{1cm}
{\large Generated by Doxygen 1.9.8}\\
\end{center}
\end{titlepage}
\clearemptydoublepage
\pagenumbering{roman}
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
% re-enable anchors again
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\input{md_README}
\chapter{Class Index}
\input{annotated}
\chapter{File Index}
\input{files}
\chapter{Class Documentation}
\input{structdynamic__array}
\chapter{File Documentation}
\input{README_8md}
\input{main_8c}
\input{internal__marigold__dynamic__array_8c}
\input{internal__marigold__dynamic__array_8h}
\input{internal__marigold__dynamic__array_8h_source}
\input{marigold__dynamic__array_8c}
\input{marigold__dynamic__array_8h}
\input{marigold__dynamic__array_8h_source}
\input{test__marigold__dynamic__array_8c}
\input{test__marigold__dynamic__array_8h}
\input{test__marigold__dynamic__array_8h_source}
\input{test__main_8c}
%--- End generated contents ---
% Index
\backmatter
\newpage
\phantomsection
\clearemptydoublepage
\addcontentsline{toc}{chapter}{\indexname}
\printindex
% Required for some languages (in combination with latexdocumentpre from the header)
\end{document}

81
documentation/latex/structdynamic__array.tex Normal file
View File

@@ -0,0 +1,81 @@
\doxysection{dynamic\+\_\+array Struct Reference}
\hypertarget{structdynamic__array}{}\label{structdynamic__array}\index{dynamic\_array@{dynamic\_array}}
{\ttfamily \#include $<$marigold\+\_\+dynamic\+\_\+array.\+h$>$}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
size\+\_\+t \mbox{\hyperlink{structdynamic__array_a3b19d692a6b8539bc58551e39bf6dfaa}{item\+\_\+size}}
\item
void \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structdynamic__array_a2fec64b33dac49cedbc5888cd8e8a846}{memory\+\_\+block\+\_\+pointer}}
\item
unsigned int \mbox{\hyperlink{structdynamic__array_ac33ca1e3db1d4229852b9f36b62f2e08}{starting\+\_\+capacity}}
\item
unsigned int \mbox{\hyperlink{structdynamic__array_a633fcea60fb454a78a7a058e3bda0bbe}{current\+\_\+capacity}}
\item
unsigned int \mbox{\hyperlink{structdynamic__array_ae7da5f21eb2bfdeff0e05b53598185c5}{current\+\_\+size}}
\item
unsigned short \mbox{\hyperlink{structdynamic__array_a105f76026911ac2665bf25a73ecf30a6}{owner\+\_\+count}}
\item
unsigned char \mbox{\hyperlink{structdynamic__array_aa3d42a1672d2015f89d8c607124fa3e5}{growth\+\_\+factor}}
\item
bool \mbox{\hyperlink{structdynamic__array_affeb533fae8aa1d8d80abc61e3380cc1}{is\+\_\+multithread\+\_\+safe}}
\end{DoxyCompactItemize}
\doxysubsection{Member Data Documentation}
\Hypertarget{structdynamic__array_a633fcea60fb454a78a7a058e3bda0bbe}\label{structdynamic__array_a633fcea60fb454a78a7a058e3bda0bbe}
\index{dynamic\_array@{dynamic\_array}!current\_capacity@{current\_capacity}}
\index{current\_capacity@{current\_capacity}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{current\_capacity}{current\_capacity}}
{\footnotesize\ttfamily unsigned int dynamic\+\_\+array\+::current\+\_\+capacity}
\Hypertarget{structdynamic__array_ae7da5f21eb2bfdeff0e05b53598185c5}\label{structdynamic__array_ae7da5f21eb2bfdeff0e05b53598185c5}
\index{dynamic\_array@{dynamic\_array}!current\_size@{current\_size}}
\index{current\_size@{current\_size}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{current\_size}{current\_size}}
{\footnotesize\ttfamily unsigned int dynamic\+\_\+array\+::current\+\_\+size}
\Hypertarget{structdynamic__array_aa3d42a1672d2015f89d8c607124fa3e5}\label{structdynamic__array_aa3d42a1672d2015f89d8c607124fa3e5}
\index{dynamic\_array@{dynamic\_array}!growth\_factor@{growth\_factor}}
\index{growth\_factor@{growth\_factor}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{growth\_factor}{growth\_factor}}
{\footnotesize\ttfamily unsigned char dynamic\+\_\+array\+::growth\+\_\+factor}
\Hypertarget{structdynamic__array_affeb533fae8aa1d8d80abc61e3380cc1}\label{structdynamic__array_affeb533fae8aa1d8d80abc61e3380cc1}
\index{dynamic\_array@{dynamic\_array}!is\_multithread\_safe@{is\_multithread\_safe}}
\index{is\_multithread\_safe@{is\_multithread\_safe}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{is\_multithread\_safe}{is\_multithread\_safe}}
{\footnotesize\ttfamily bool dynamic\+\_\+array\+::is\+\_\+multithread\+\_\+safe}
\Hypertarget{structdynamic__array_a3b19d692a6b8539bc58551e39bf6dfaa}\label{structdynamic__array_a3b19d692a6b8539bc58551e39bf6dfaa}
\index{dynamic\_array@{dynamic\_array}!item\_size@{item\_size}}
\index{item\_size@{item\_size}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{item\_size}{item\_size}}
{\footnotesize\ttfamily size\+\_\+t dynamic\+\_\+array\+::item\+\_\+size}
\Hypertarget{structdynamic__array_a2fec64b33dac49cedbc5888cd8e8a846}\label{structdynamic__array_a2fec64b33dac49cedbc5888cd8e8a846}
\index{dynamic\_array@{dynamic\_array}!memory\_block\_pointer@{memory\_block\_pointer}}
\index{memory\_block\_pointer@{memory\_block\_pointer}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{memory\_block\_pointer}{memory\_block\_pointer}}
{\footnotesize\ttfamily void\texorpdfstring{$\ast$}{*} dynamic\+\_\+array\+::memory\+\_\+block\+\_\+pointer}
\Hypertarget{structdynamic__array_a105f76026911ac2665bf25a73ecf30a6}\label{structdynamic__array_a105f76026911ac2665bf25a73ecf30a6}
\index{dynamic\_array@{dynamic\_array}!owner\_count@{owner\_count}}
\index{owner\_count@{owner\_count}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{owner\_count}{owner\_count}}
{\footnotesize\ttfamily unsigned short dynamic\+\_\+array\+::owner\+\_\+count}
\Hypertarget{structdynamic__array_ac33ca1e3db1d4229852b9f36b62f2e08}\label{structdynamic__array_ac33ca1e3db1d4229852b9f36b62f2e08}
\index{dynamic\_array@{dynamic\_array}!starting\_capacity@{starting\_capacity}}
\index{starting\_capacity@{starting\_capacity}!dynamic\_array@{dynamic\_array}}
\doxysubsubsection{\texorpdfstring{starting\_capacity}{starting\_capacity}}
{\footnotesize\ttfamily unsigned int dynamic\+\_\+array\+::starting\+\_\+capacity}
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/\mbox{\hyperlink{marigold__dynamic__array_8h}{marigold\+\_\+dynamic\+\_\+array.\+h}}\end{DoxyCompactItemize}

2557
documentation/latex/tabu_doxygen.sty Normal file
View File

File diff suppressed because it is too large Load Diff

2
documentation/latex/test__main_8c.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{source\+\_\+code/test\+\_\+main.c File Reference}
\hypertarget{test__main_8c}{}\label{test__main_8c}\index{source\_code/test\_main.c@{source\_code/test\_main.c}}

2
documentation/latex/test__marigold__dynamic__array_8c.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/tests/test\+\_\+marigold\+\_\+dynamic\+\_\+array.c File Reference}
\hypertarget{test__marigold__dynamic__array_8c}{}\label{test__marigold__dynamic__array_8c}\index{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.c@{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.c}}

2
documentation/latex/test__marigold__dynamic__array_8h.tex Normal file
View File

@@ -0,0 +1,2 @@
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/tests/test\+\_\+marigold\+\_\+dynamic\+\_\+array.h File Reference}
\hypertarget{test__marigold__dynamic__array_8h}{}\label{test__marigold__dynamic__array_8h}\index{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.h}}

6
documentation/latex/test__marigold__dynamic__array_8h_source.tex Normal file
View File

@@ -0,0 +1,6 @@
\doxysection{test\+\_\+marigold\+\_\+dynamic\+\_\+array.\+h}
\hypertarget{test__marigold__dynamic__array_8h_source}{}\label{test__marigold__dynamic__array_8h_source}\index{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/tests/test\_marigold\_dynamic\_array.h}}
\mbox{\hyperlink{test__marigold__dynamic__array_8h}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\end{DoxyCode}