cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

_s_d_l__visualtest__random__variator_8h.tex (6479B)


      1\hypertarget{_s_d_l__visualtest__random__variator_8h}{\section{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.h File Reference}
      2\label{_s_d_l__visualtest__random__variator_8h}\index{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h@{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}}
      3}
      4{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-harness\-\_\-argparser.\-h\char`\"{}}\\*
      5{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-variator\-\_\-common.\-h\char`\"{}}\\*
      6\subsection*{Data Structures}
      7\begin{DoxyCompactItemize}
      8\item 
      9struct \hyperlink{struct_s_d_l_visual_test___random_variator}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}
     10\end{DoxyCompactItemize}
     11\subsection*{Typedefs}
     12\begin{DoxyCompactItemize}
     13\item 
     14typedef struct \\*
     15\hyperlink{struct_s_d_l_visual_test___random_variator}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} \hyperlink{_s_d_l__visualtest__random__variator_8h_ab0df6ee6ec21b5070bfd8e90a7d79974}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}
     16\end{DoxyCompactItemize}
     17\subsection*{Functions}
     18\begin{DoxyCompactItemize}
     19\item 
     20int \hyperlink{_s_d_l__visualtest__random__variator_8h_a807486069b7180c3b3bf8af4616d055f}{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator} (\hyperlink{struct_s_d_l_visual_test___random_variator}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$variator, \hyperlink{struct_s_d_l_visual_test___s_u_t_config}{S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$config, Uint64 seed)
     21\item 
     22char $\ast$ \hyperlink{_s_d_l__visualtest__random__variator_8h_a479aceb74b5355c1d22856fc7efce890}{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation} (\hyperlink{struct_s_d_l_visual_test___random_variator}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$variator)
     23\item 
     24void \hyperlink{_s_d_l__visualtest__random__variator_8h_ac95d9e0716e4c918c6902b10f9591d4b}{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator} (\hyperlink{struct_s_d_l_visual_test___random_variator}{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$variator)
     25\end{DoxyCompactItemize}
     26
     27
     28\subsection{Detailed Description}
     29Header for the random variator. 
     30
     31\subsection{Typedef Documentation}
     32\hypertarget{_s_d_l__visualtest__random__variator_8h_ab0df6ee6ec21b5070bfd8e90a7d79974}{\index{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}}
     33\index{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}!SDL_visualtest_random_variator.h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}}
     34\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}  {\bf S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator}}}\label{_s_d_l__visualtest__random__variator_8h_ab0df6ee6ec21b5070bfd8e90a7d79974}
     35Struct for the variator that randomly generates variations of command line arguments to the S\-U\-T. 
     36
     37\subsection{Function Documentation}
     38\hypertarget{_s_d_l__visualtest__random__variator_8h_ac95d9e0716e4c918c6902b10f9591d4b}{\index{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator}}
     39\index{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator}!SDL_visualtest_random_variator.h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}}
     40\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}void S\-D\-L\-Visual\-Test\-\_\-\-Free\-Random\-Variator (
     41\begin{DoxyParamCaption}
     42\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$}]{variator}
     43\end{DoxyParamCaption}
     44)}}\label{_s_d_l__visualtest__random__variator_8h_ac95d9e0716e4c918c6902b10f9591d4b}
     45Frees any resources associated with the variator. \hypertarget{_s_d_l__visualtest__random__variator_8h_a479aceb74b5355c1d22856fc7efce890}{\index{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation@{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation}}
     46\index{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation@{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation}!SDL_visualtest_random_variator.h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}}
     47\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Random\-Variation (
     48\begin{DoxyParamCaption}
     49\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$}]{variator}
     50\end{DoxyParamCaption}
     51)}}\label{_s_d_l__visualtest__random__variator_8h_a479aceb74b5355c1d22856fc7efce890}
     52Generates a new random variation.
     53
     54\begin{DoxyReturn}{Returns}
     55The arguments string representing the random variation on success, and N\-U\-L\-L on failure. The pointer returned should not be freed. 
     56\end{DoxyReturn}
     57\hypertarget{_s_d_l__visualtest__random__variator_8h_a807486069b7180c3b3bf8af4616d055f}{\index{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator}}
     58\index{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator}!SDL_visualtest_random_variator.h@{S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h}}
     59\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}int S\-D\-L\-Visual\-Test\-\_\-\-Init\-Random\-Variator (
     60\begin{DoxyParamCaption}
     61\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Random\-Variator} $\ast$}]{variator, }
     62\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$}]{config, }
     63\item[{Uint64}]{seed}
     64\end{DoxyParamCaption}
     65)}}\label{_s_d_l__visualtest__random__variator_8h_a807486069b7180c3b3bf8af4616d055f}
     66Initializes the variator.
     67
     68\begin{DoxyReturn}{Returns}
     691 on success, 0 on failure 
     70\end{DoxyReturn}