foundational_lib 1.0 → 1.0.1

data/docs/html/html/foundationallib_8h.html

@@ -214,7 +214,7 @@ Macros</h2></td></tr>
 <tr class="separator:ac2b6e98f0f2ae30dbe31d59125b24ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:acb669ed9e83e51d8da4ad8b79dc61925"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#acb669ed9e83e51d8da4ad8b79dc61925">FOUNDATIONAL_LIB_PUTCHAR</a>&#160;&#160;&#160;putchar</td></tr>
 <tr class="separator:acb669ed9e83e51d8da4ad8b79dc61925"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:afcc1f22865e85f0ac2b38223339d4499"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#afcc1f22865e85f0ac2b38223339d4499">FOUNDATIONAL_LIB_FPUTC</a>&#160;&#160;&#160;putc</td></tr>
+<tr class="memitem:afcc1f22865e85f0ac2b38223339d4499"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#afcc1f22865e85f0ac2b38223339d4499">FOUNDATIONAL_LIB_FPUTC</a>&#160;&#160;&#160;fputc</td></tr>
 <tr class="separator:afcc1f22865e85f0ac2b38223339d4499"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0b22be3718a91a66c91c52c98156fc30"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a0b22be3718a91a66c91c52c98156fc30">FOUNDATIONAL_LIB_STRPBRK</a>&#160;&#160;&#160;strpbrk</td></tr>
 <tr class="separator:a0b22be3718a91a66c91c52c98156fc30"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -252,8 +252,8 @@ Macros</h2></td></tr>
 <tr class="separator:a278f178160fe9e8f669a409f0e69e412"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a48a2a16fc999ad87d74c7092895a419f"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a48a2a16fc999ad87d74c7092895a419f">FOUNDATIONAL_LIB_INITIAL_STRING_ARRAY_ALLOC_SIZE</a>&#160;&#160;&#160;(sizeof(char *) * 1)</td></tr>
 <tr class="separator:a48a2a16fc999ad87d74c7092895a419f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac909034d71737927c60e65083adfcad2"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#ac909034d71737927c60e65083adfcad2">FOUNDATIONAL_LIB_likely</a>(x)&#160;&#160;&#160;(x)</td></tr>
-<tr class="separator:ac909034d71737927c60e65083adfcad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a185a69e43b731c26d7c273df01c58110"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a185a69e43b731c26d7c273df01c58110">FOUNDATIONAL_LIB_LIKELY</a>(x)&#160;&#160;&#160;(x)</td></tr>
+<tr class="separator:a185a69e43b731c26d7c273df01c58110"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9466743f89a3f09697fe602e1cc9aed9"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a9466743f89a3f09697fe602e1cc9aed9">FOUNDATIONAL_LIB_UNLIKELY</a>(x)&#160;&#160;&#160;(x)</td></tr>
 <tr class="separator:a9466743f89a3f09697fe602e1cc9aed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a28236297cf69685a26540c7ab46d7fd1"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a28236297cf69685a26540c7ab46d7fd1">FOUNDATIONAL_LIB_ASSERT_ARGUMENT_CHECKING</a>&#160;&#160;&#160;0 /* Argument NULL checks. Disabled by default. */</td></tr>
@@ -345,9 +345,9 @@ Functions</h2></td></tr>
 <tr class="separator:a5f6423417e952f934be0a582d87b663a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5a11b59026f061e60d97fa8b3626e13f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a5a11b59026f061e60d97fa8b3626e13f">FOUNDATIONAL_LIB_STATIC_ASSERT_MSG</a> ((sizeof(size_t)&lt;=8 &amp;&amp;<a class="el" href="foundationallib_8h.html#aa6ac073fb7a2b9bcd12e39a02f7cbd2a">FOUNDATIONAL_LIB_SIZE_STRING_OF_NUMBER_SIZE_PLUS_ZERO_TERMINATOR</a> &gt;=21), &quot;Increase SIZE_STRING_OF_NUMBER_SIZE_PLUS_ZERO_TERMINATOR to more than 21&quot;)</td></tr>
 <tr class="separator:a5a11b59026f061e60d97fa8b3626e13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a757628ba53c2104b2eea206232ef47e6"><td class="memItemLeft" align="right" valign="top">static FOUNDATIONAL_LIB_CONST size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a757628ba53c2104b2eea206232ef47e6">FOUNDATIONAL_LIB_safe_mul</a> (size_t a, size_t b)</td></tr>
-<tr class="memdesc:a757628ba53c2104b2eea206232ef47e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safely multiply 2 numbers to avoid unsigned integer overflows and security and stability issues. We never, NEVER want any of those things. Ever.  <a href="foundationallib_8h.html#a757628ba53c2104b2eea206232ef47e6">More...</a><br /></td></tr>
-<tr class="separator:a757628ba53c2104b2eea206232ef47e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a786c21a755e3c5cdd37d1ad0a781a6dc"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a786c21a755e3c5cdd37d1ad0a781a6dc">FOUNDATIONAL_LIB_safe_mul</a> (size_t a, size_t b)</td></tr>
+<tr class="memdesc:a786c21a755e3c5cdd37d1ad0a781a6dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safely multiply 2 numbers to avoid unsigned integer overflows and security and stability issues. We never, NEVER want any of those things. Ever.  <a href="foundationallib_8h.html#a786c21a755e3c5cdd37d1ad0a781a6dc">More...</a><br /></td></tr>
+<tr class="separator:a786c21a755e3c5cdd37d1ad0a781a6dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6f61f67b477bb06d8ff0be499abef538"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="foundationallib_8h.html#a6f61f67b477bb06d8ff0be499abef538">FOUNDATIONAL_LIB_safe_mul_ptr</a> (size_t a, size_t b, size_t *ptr)</td></tr>
 <tr class="memdesc:a6f61f67b477bb06d8ff0be499abef538"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safely multiply 2 numbers to avoid unsigned integer overflows and security and stability issues. We never, NEVER want any of those things. Ever.  <a href="foundationallib_8h.html#a6f61f67b477bb06d8ff0be499abef538">More...</a><br /></td></tr>
 <tr class="separator:a6f61f67b477bb06d8ff0be499abef538"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -1555,7 +1555,7 @@ Variables</h2></td></tr>
 <div class="line">        FOUNDATIONAL_LIB_FPRINTF(stderr, <span class="stringliteral">&quot;Error: %s: %s.\n&quot;</span>, __func__, strerror(errno));                                                                                                                                                                                                                                                                                                                                                                                                                           \</div>
 <div class="line">        exit(EXIT_FAILURE); <span class="comment">/* Use default exit, only place in library this is used, adjust as needed. */</span>                                                                                                                                                                                                                                                                                                                                                                                                          \</div>
 <div class="line">    }</div>
-<div class="ttc" id="afoundationallib_8h_html_a46992f145825bae5ef5bbc5953652038"><div class="ttname"><a href="foundationallib_8h.html#a46992f145825bae5ef5bbc5953652038">FOUNDATIONAL_LIB_aggressive_die</a></div><div class="ttdeci">FOUNDATIONAL_LIB_AGGRESSIVE_DIE_TYPE FOUNDATIONAL_LIB_aggressive_die</div><div class="ttdoc">Global variable to control aggressive die behavior.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:847</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a46992f145825bae5ef5bbc5953652038"><div class="ttname"><a href="foundationallib_8h.html#a46992f145825bae5ef5bbc5953652038">FOUNDATIONAL_LIB_aggressive_die</a></div><div class="ttdeci">FOUNDATIONAL_LIB_AGGRESSIVE_DIE_TYPE FOUNDATIONAL_LIB_aggressive_die</div><div class="ttdoc">Global variable to control aggressive die behavior.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:854</div></div>
 <div class="ttc" id="afoundationallib_8h_html_a9466743f89a3f09697fe602e1cc9aed9"><div class="ttname"><a href="foundationallib_8h.html#a9466743f89a3f09697fe602e1cc9aed9">FOUNDATIONAL_LIB_UNLIKELY</a></div><div class="ttdeci">#define FOUNDATIONAL_LIB_UNLIKELY(x)</div><div class="ttdef"><b>Definition:</b> foundationallib.h:424</div></div>
 </div><!-- fragment -->
 <p>Macro to die aggressively if enabled. </p>
@@ -1640,7 +1640,7 @@ Variables</h2></td></tr>
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a> FOUNDATIONAL_LIB_FPUTC&#160;&#160;&#160;putc</td>
+          <td class="memname">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a> FOUNDATIONAL_LIB_FPUTC&#160;&#160;&#160;fputc</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -1939,14 +1939,14 @@ Variables</h2></td></tr>
 
 </div>
 </div>
-<a id="ac909034d71737927c60e65083adfcad2"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ac909034d71737927c60e65083adfcad2">&#9670;&nbsp;</a></span>FOUNDATIONAL_LIB_likely</h2>
+<a id="a185a69e43b731c26d7c273df01c58110"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a185a69e43b731c26d7c273df01c58110">&#9670;&nbsp;</a></span>FOUNDATIONAL_LIB_LIKELY</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a> FOUNDATIONAL_LIB_likely</td>
+          <td class="memname">#<a class="el" href="foundationallib_8h.html#a0ec3f1f76900803ac4f041eb90b84a34">define</a> FOUNDATIONAL_LIB_LIKELY</td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
           <td class="paramname">x</td><td>)</td>
@@ -2210,7 +2210,7 @@ Variables</h2></td></tr>
 </div><div class="memdoc">
 <b>Value:</b><div class="fragment"><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="foundationallib_8h.html#a9466743f89a3f09697fe602e1cc9aed9">FOUNDATIONAL_LIB_UNLIKELY</a>(<a class="code" href="foundationallib_8h.html#a61ed415504a0cad67a3de862310027a7">FOUNDATIONAL_LIB_safe_add_2_ptr</a>((variable), 1, &amp;(variable)) == 0))                                                                                                                                                                                                                                                                                                                                                                                                               \</div>
 <div class="line">        goto label_if_fails;</div>
-<div class="ttc" id="afoundationallib_8h_html_a61ed415504a0cad67a3de862310027a7"><div class="ttname"><a href="foundationallib_8h.html#a61ed415504a0cad67a3de862310027a7">FOUNDATIONAL_LIB_safe_add_2_ptr</a></div><div class="ttdeci">static size_t FOUNDATIONAL_LIB_safe_add_2_ptr(size_t a, size_t b, size_t *ptr)</div><div class="ttdoc">Safely add 2 numbers to avoid unsigned integer overflows and security and stability issues....</div><div class="ttdef"><b>Definition:</b> foundationallib.h:587</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a61ed415504a0cad67a3de862310027a7"><div class="ttname"><a href="foundationallib_8h.html#a61ed415504a0cad67a3de862310027a7">FOUNDATIONAL_LIB_safe_add_2_ptr</a></div><div class="ttdeci">static size_t FOUNDATIONAL_LIB_safe_add_2_ptr(size_t a, size_t b, size_t *ptr)</div><div class="ttdoc">Safely add 2 numbers to avoid unsigned integer overflows and security and stability issues....</div><div class="ttdef"><b>Definition:</b> foundationallib.h:595</div></div>
 </div><!-- fragment -->
 </div>
 </div>
@@ -5959,7 +5959,7 @@ The user-defined condition function should be provided as a pointer.</dd></dl>
 <div class="line">filtered_array, 5, is_even_condition);</div>
 <div class="line">  <span class="comment">// After the call, filtered_array will contain {2, 4}, and num_filtered</span></div>
 <div class="line">will be 2</div>
-<div class="ttc" id="afoundationallib_8h_html_a90a332847ce4ef4afe9eba245ea7488a"><div class="ttname"><a href="foundationallib_8h.html#a90a332847ce4ef4afe9eba245ea7488a">filter</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC size_t filter(void *source, size_t source_size, size_t elem_size, void *destination, size_t dest_size, int(*condition)(void *))</div><div class="ttdoc">Filters elements of an array (void* version) based on a specified condition.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8543</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a90a332847ce4ef4afe9eba245ea7488a"><div class="ttname"><a href="foundationallib_8h.html#a90a332847ce4ef4afe9eba245ea7488a">filter</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC size_t filter(void *source, size_t source_size, size_t elem_size, void *destination, size_t dest_size, int(*condition)(void *))</div><div class="ttdoc">Filters elements of an array (void* version) based on a specified condition.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8550</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -6067,7 +6067,7 @@ The user-defined condition function should be provided as a pointer.</dd></dl>
 <div class="line">filtered_array, is_even_condition);</div>
 <div class="line">  <span class="comment">// After the call, filtered_array will contain {2, 4}, and num_filtered</span></div>
 <div class="line">will be 2</div>
-<div class="ttc" id="afoundationallib_8h_html_a58f0ba6b56491d49884378882242460f"><div class="ttname"><a href="foundationallib_8h.html#a58f0ba6b56491d49884378882242460f">filter_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int filter_ints(int *source, size_t source_size, int *destination, int(*condition)(int))</div><div class="ttdoc">Filters elements of an integer array based on a specified condition.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8388</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a58f0ba6b56491d49884378882242460f"><div class="ttname"><a href="foundationallib_8h.html#a58f0ba6b56491d49884378882242460f">filter_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int filter_ints(int *source, size_t source_size, int *destination, int(*condition)(int))</div><div class="ttdoc">Filters elements of an integer array based on a specified condition.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8395</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -7495,8 +7495,8 @@ The user-defined condition function should be provided as a pointer.</dd></dl>
 
 </div>
 </div>
-<a id="a757628ba53c2104b2eea206232ef47e6"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a757628ba53c2104b2eea206232ef47e6">&#9670;&nbsp;</a></span>FOUNDATIONAL_LIB_safe_mul()</h2>
+<a id="a786c21a755e3c5cdd37d1ad0a781a6dc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a786c21a755e3c5cdd37d1ad0a781a6dc">&#9670;&nbsp;</a></span>FOUNDATIONAL_LIB_safe_mul()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -7505,7 +7505,7 @@ The user-defined condition function should be provided as a pointer.</dd></dl>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">static FOUNDATIONAL_LIB_CONST size_t FOUNDATIONAL_LIB_safe_mul </td>
+          <td class="memname">static size_t FOUNDATIONAL_LIB_safe_mul </td>
           <td>(</td>
           <td class="paramtype">size_t&#160;</td>
           <td class="paramname"><em>a</em>, </td>
@@ -8679,7 +8679,7 @@ If the array contains NULL pointers, they are treated as empty strings. </dd></d
 <div class="line">} <span class="keywordflow">else</span> {</div>
 <div class="line">    <span class="comment">// At least one string in the array contains non-digit characters.</span></div>
 <div class="line">}</div>
-<div class="ttc" id="afoundationallib_8h_html_a81f2928f46f019854c576313208da05f"><div class="ttname"><a href="foundationallib_8h.html#a81f2928f46f019854c576313208da05f">is_array_digit</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int is_array_digit(const char **array, size_t size)</div><div class="ttdoc">Check if a string array contains only digits.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9498</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a81f2928f46f019854c576313208da05f"><div class="ttname"><a href="foundationallib_8h.html#a81f2928f46f019854c576313208da05f">is_array_digit</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int is_array_digit(const char **array, size_t size)</div><div class="ttdoc">Check if a string array contains only digits.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9506</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -9239,7 +9239,7 @@ If the array contains NULL pointers, they are treated as empty strings. </dd></d
 <div class="line"><span class="keyword">sizeof</span>(<span class="keywordtype">size_t</span>), square_transform, odd_filter, &amp;result_size);</div>
 <div class="line"><span class="comment">// Use the result array</span></div>
 <div class="line">free(result);</div>
-<div class="ttc" id="afoundationallib_8h_html_a1dfe1a09610f544e443a1224e407868d"><div class="ttname"><a href="foundationallib_8h.html#a1dfe1a09610f544e443a1224e407868d">list_comprehension</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void * list_comprehension(const void *input_array, size_t array_size, size_t elem_size, void(*transform_func)(void *value), int(*filter_func)(void *value), size_t *result_size)</div><div class="ttdoc">Perform a list comprehension operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8659</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a1dfe1a09610f544e443a1224e407868d"><div class="ttname"><a href="foundationallib_8h.html#a1dfe1a09610f544e443a1224e407868d">list_comprehension</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void * list_comprehension(const void *input_array, size_t array_size, size_t elem_size, void(*transform_func)(void *value), int(*filter_func)(void *value), size_t *result_size)</div><div class="ttdoc">Perform a list comprehension operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8667</div></div>
 </div><!-- fragment --> <div class="fragment"><div class="line"><span class="comment">// Example Usage 2: Transform each string to uppercase and filter out those</span></div>
 <div class="line">starting with <span class="charliteral">&#39;a&#39;</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *words[] = {<span class="stringliteral">&quot;apple&quot;</span>, <span class="stringliteral">&quot;banana&quot;</span>, <span class="stringliteral">&quot;orange&quot;</span>,</div>
 <div class="line"><span class="stringliteral">&quot;grape&quot;</span>, <span class="stringliteral">&quot;kiwi&quot;</span>}; <span class="keywordtype">size_t</span> words_size = <span class="keyword">sizeof</span>(words) / <span class="keyword">sizeof</span>(words[0]);</div>
@@ -9528,7 +9528,7 @@ The user-defined transformation function should be provided as a pointer.</dd></
 <div class="line"><span class="keywordtype">int</span> my_array[] = {1, 2, 3, 4, 5};</div>
 <div class="line"><a class="code" href="foundationallib_8h.html#a3a41c1ddb97e0b1c02a6c6f13063b049">map</a>(my_array, 5, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), increment_transform);</div>
 <div class="line"><span class="comment">// After the call, my_array will be {2, 3, 4, 5, 6}</span></div>
-<div class="ttc" id="afoundationallib_8h_html_a3a41c1ddb97e0b1c02a6c6f13063b049"><div class="ttname"><a href="foundationallib_8h.html#a3a41c1ddb97e0b1c02a6c6f13063b049">map</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void map(void *array, size_t size, size_t elem_size, void(*transform)(void *))</div><div class="ttdoc">Applies a transformation to each element of an array (void* version).</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8435</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a3a41c1ddb97e0b1c02a6c6f13063b049"><div class="ttname"><a href="foundationallib_8h.html#a3a41c1ddb97e0b1c02a6c6f13063b049">map</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void map(void *array, size_t size, size_t elem_size, void(*transform)(void *))</div><div class="ttdoc">Applies a transformation to each element of an array (void* version).</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8442</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -9625,7 +9625,7 @@ The user-defined transformation function should be provided as a pointer.</dd></
 <div class="line"><span class="keywordtype">int</span> my_array[] = {1, 2, 3, 4, 5};</div>
 <div class="line"><a class="code" href="foundationallib_8h.html#ab0391ca61462e6ede19f4a26e99bc553">map_ints</a>(my_array, 5, square_transform);</div>
 <div class="line"><span class="comment">// After the call, my_array will be {1, 4, 9, 16, 25}</span></div>
-<div class="ttc" id="afoundationallib_8h_html_ab0391ca61462e6ede19f4a26e99bc553"><div class="ttname"><a href="foundationallib_8h.html#ab0391ca61462e6ede19f4a26e99bc553">map_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void map_ints(int *array, size_t size, int(*transform)(int))</div><div class="ttdoc">Applies a transformation to each element of an integer array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8295</div></div>
+<div class="ttc" id="afoundationallib_8h_html_ab0391ca61462e6ede19f4a26e99bc553"><div class="ttname"><a href="foundationallib_8h.html#ab0391ca61462e6ede19f4a26e99bc553">map_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void map_ints(int *array, size_t size, int(*transform)(int))</div><div class="ttdoc">Applies a transformation to each element of an integer array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8302</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -13137,7 +13137,7 @@ The user-defined binary operation function should be provided as a pointer.</dd>
 <div class="line">  <a class="code" href="foundationallib_8h.html#aab75e49752ea0c04ea4d042f4c01631d">reduce</a>(my_array, 5, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), &amp;result, sum_operation);</div>
 <div class="line">  <span class="comment">// After the call, result will be the sum of elements: 1 + 2 + 3 + 4 + 5 =</span></div>
 <div class="line">15</div>
-<div class="ttc" id="afoundationallib_8h_html_aab75e49752ea0c04ea4d042f4c01631d"><div class="ttname"><a href="foundationallib_8h.html#aab75e49752ea0c04ea4d042f4c01631d">reduce</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void reduce(void *array, size_t size, size_t elem_size, void *result, void(*operation)(void *, void *))</div><div class="ttdoc">Performs a reduction on an array (void* version) using a binary operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8481</div></div>
+<div class="ttc" id="afoundationallib_8h_html_aab75e49752ea0c04ea4d042f4c01631d"><div class="ttname"><a href="foundationallib_8h.html#aab75e49752ea0c04ea4d042f4c01631d">reduce</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC void reduce(void *array, size_t size, size_t elem_size, void *result, void(*operation)(void *, void *))</div><div class="ttdoc">Performs a reduction on an array (void* version) using a binary operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8488</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -13243,7 +13243,7 @@ The user-defined binary operation function should be provided as a pointer.</dd>
 <div class="line">  <span class="keywordtype">int</span> result = <a class="code" href="foundationallib_8h.html#aa52f8dd426cf4a7daca875bdd89909c3">reduce_ints</a>(my_array, 5, add_operation);</div>
 <div class="line">  <span class="comment">// After the call, result will be the sum of elements: 1 + 2 + 3 + 4 + 5 =</span></div>
 <div class="line">15</div>
-<div class="ttc" id="afoundationallib_8h_html_aa52f8dd426cf4a7daca875bdd89909c3"><div class="ttname"><a href="foundationallib_8h.html#aa52f8dd426cf4a7daca875bdd89909c3">reduce_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int reduce_ints(int *array, size_t size, int(*operation)(int, int))</div><div class="ttdoc">Performs a reduction on an integer array using a binary operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8337</div></div>
+<div class="ttc" id="afoundationallib_8h_html_aa52f8dd426cf4a7daca875bdd89909c3"><div class="ttname"><a href="foundationallib_8h.html#aa52f8dd426cf4a7daca875bdd89909c3">reduce_ints</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int reduce_ints(int *array, size_t size, int(*operation)(int, int))</div><div class="ttdoc">Performs a reduction on an integer array using a binary operation.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:8344</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -13746,7 +13746,7 @@ For efficiency, null terminated strings are not checked. As such, the blocks of
 </dl>
 <p>If should_free_after_use is non-zero, a new dynamically allocated array with the replacements made. If should_free_after_use is zero, output aliases source, and they refer to the same memory. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">should_free_after_use</td><td>A pointer to a int indicating whether </td></tr>
+    <tr><td class="paramname">should_free_after_use</td><td>A pointer to a int indicating whether one should free the memory after using the function. </td></tr>
     <tr><td class="paramname">num_matches</td><td>A pointer to a variable to store the number of replacements made. </td></tr>
     <tr><td class="paramname">matches_max</td><td>A pointer to the maximum number of replacements to make. If zero, there is no maximum.</td></tr>
   </table>
@@ -16780,7 +16780,7 @@ For efficiency, null terminated strings are not checked. As such, the blocks of
 <div class="line">} <span class="keywordflow">else</span> {</div>
 <div class="line">    <span class="comment">// Handle the error.</span></div>
 <div class="line">}</div>
-<div class="ttc" id="afoundationallib_8h_html_a887766be8a218af82614bec5e1a2df56"><div class="ttname"><a href="foundationallib_8h.html#a887766be8a218af82614bec5e1a2df56">string_array_uniq</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int string_array_uniq(const char **array, size_t size, char ***output, size_t *output_size)</div><div class="ttdoc">Remove duplicate strings from a string array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9614</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a887766be8a218af82614bec5e1a2df56"><div class="ttname"><a href="foundationallib_8h.html#a887766be8a218af82614bec5e1a2df56">string_array_uniq</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int string_array_uniq(const char **array, size_t size, char ***output, size_t *output_size)</div><div class="ttdoc">Remove duplicate strings from a string array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9622</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -16846,7 +16846,7 @@ For efficiency, null terminated strings are not checked. As such, the blocks of
 <div class="line">} <span class="keywordflow">else</span> {</div>
 <div class="line">    <span class="comment">// Handle the error.</span></div>
 <div class="line">}</div>
-<div class="ttc" id="afoundationallib_8h_html_a7c596e54c9b51906b4e53e5c74db23b6"><div class="ttname"><a href="foundationallib_8h.html#a7c596e54c9b51906b4e53e5c74db23b6">string_array_uniq_adjacent</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int string_array_uniq_adjacent(const char **first_array, size_t size, char ***new_array, size_t *new_size)</div><div class="ttdoc">Remove adjacent duplicate strings from a string array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9714</div></div>
+<div class="ttc" id="afoundationallib_8h_html_a7c596e54c9b51906b4e53e5c74db23b6"><div class="ttname"><a href="foundationallib_8h.html#a7c596e54c9b51906b4e53e5c74db23b6">string_array_uniq_adjacent</a></div><div class="ttdeci">FOUNDATIONAL_LIB_FUNC int string_array_uniq_adjacent(const char **first_array, size_t size, char ***new_array, size_t *new_size)</div><div class="ttdoc">Remove adjacent duplicate strings from a string array.</div><div class="ttdef"><b>Definition:</b> foundationallib.h:9722</div></div>
 </div><!-- fragment --> 
 </div>
 </div>

data/docs/html/html/foundationallib_8h.js

@@ -44,7 +44,7 @@ var foundationallib_8h =
     [ "FOUNDATIONAL_LIB_ISPRINT", "foundationallib_8h.html#a2cfaa2600de4be9c76bd1ad768ddb98d", null ],
     [ "FOUNDATIONAL_LIB_ISSPACE", "foundationallib_8h.html#aa6596acef91f412badb4324746f30dd8", null ],
     [ "FOUNDATIONAL_LIB_ISUPPER", "foundationallib_8h.html#a3a380549ad8322435d5e71e50e8ce3ab", null ],
-    [ "FOUNDATIONAL_LIB_likely", "foundationallib_8h.html#ac909034d71737927c60e65083adfcad2", null ],
+    [ "FOUNDATIONAL_LIB_LIKELY", "foundationallib_8h.html#a185a69e43b731c26d7c273df01c58110", null ],
     [ "FOUNDATIONAL_LIB_LOW_MEMORY_USAGE", "foundationallib_8h.html#aaed4a976ebb512f38e8810088009da91", null ],
     [ "FOUNDATIONAL_LIB_MEMCHR", "foundationallib_8h.html#acc6fd4b3361386dcfe655076d2575c16", null ],
     [ "FOUNDATIONAL_LIB_MEMCMP", "foundationallib_8h.html#a954ba73b0400368c815a0d27e67ea237", null ],
@@ -197,7 +197,7 @@ var foundationallib_8h =
     [ "FOUNDATIONAL_LIB_safe_add_2_ptr", "foundationallib_8h.html#a61ed415504a0cad67a3de862310027a7", null ],
     [ "FOUNDATIONAL_LIB_safe_add_3", "foundationallib_8h.html#a500c2f75e0f2363c30a89a78bf7b6826", null ],
     [ "FOUNDATIONAL_LIB_safe_add_3_ptr", "foundationallib_8h.html#aa2d9d0510d58fc28406e14cdbb6bcd6d", null ],
-    [ "FOUNDATIONAL_LIB_safe_mul", "foundationallib_8h.html#a757628ba53c2104b2eea206232ef47e6", null ],
+    [ "FOUNDATIONAL_LIB_safe_mul", "foundationallib_8h.html#a786c21a755e3c5cdd37d1ad0a781a6dc", null ],
     [ "FOUNDATIONAL_LIB_safe_mul_ptr", "foundationallib_8h.html#a6f61f67b477bb06d8ff0be499abef538", null ],
     [ "FOUNDATIONAL_LIB_STATIC_ASSERT_MSG", "foundationallib_8h.html#a5a11b59026f061e60d97fa8b3626e13f", null ],
     [ "free_array", "foundationallib_8h.html#a7d48c3cdcc509a538faba6b7426eea52", null ],