OpenSoure_Repos/TheAlgorithms-C
1
0
Fork 0
mirror of https://github.moeyy.xyz/https://github.com/TheAlgorithms/C.git synced 2023-10-11 15:56:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
3bff347285
TheAlgorithms-C/d1/dc7/run__length__encoding_8c.html
github-actions 478bb303a5 Documentation for 2b885108b8
2023-04-27 19:43:13 +00:00

298 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C: misc/run_length_encoding.c File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d1/dc7/run__length__encoding_8c.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">run_length_encoding.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Encode a null terminated string using <a href="https://en.wikipedia.org/wiki/Run-length_encoding" target="_blank">Run-length encoding</a>
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for run_length_encoding.c:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../dc/dcb/run__length__encoding_8c__incl.svg" width="339" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac3cc4a63cf2a14a08e05c5537ecf59c2"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/run__length__encoding_8c.html#ac3cc4a63cf2a14a08e05c5537ecf59c2">run_length_encode</a> (char *str)</td></tr>
<tr class="memdesc:ac3cc4a63cf2a14a08e05c5537ecf59c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">for IO operations <br /></td></tr>
<tr class="separator:ac3cc4a63cf2a14a08e05c5537ecf59c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/run__length__encoding_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encode a null terminated string using <a href="https://en.wikipedia.org/wiki/Run-length_encoding" target="_blank">Run-length encoding</a> </p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/serturx/" target="_blank">serturx</a></dd></dl>
<p>Run-length encoding is a lossless compression algorithm. It works by counting the consecutive occurences symbols and encodes that series of consecutive symbols into the counted symbol and a number denoting the number of consecutive occorences.</p>
<p>For example the string "AAAABBCCD" gets encoded into "4A2B2C1D" </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 88</span> {</div>
<div class="line"><span class="lineno"> 89</span> <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><span class="lineno"> 90</span> printf(<span class="stringliteral">&quot;All tests have passed!\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 91</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 92</span>}</div>
<div class="ttc" id="arun__length__encoding_8c_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition:</b> run_length_encoding.c:71</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d1/dc7/run__length__encoding_8c_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="330" height="60"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ac3cc4a63cf2a14a08e05c5537ecf59c2" name="ac3cc4a63cf2a14a08e05c5537ecf59c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3cc4a63cf2a14a08e05c5537ecf59c2">&#9670;&#160;</a></span>run_length_encode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * run_length_encode </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>for IO operations </p>
<p>for string functions for malloc/free for assert</p>
<p>Encodes a null-terminated string using run-length encoding </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>String to encode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>char* Encoded string </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 27</span> {</div>
<div class="line"><span class="lineno"> 28</span> <span class="keywordtype">int</span> str_length = strlen(str);</div>
<div class="line"><span class="lineno"> 29</span> <span class="keywordtype">int</span> encoded_index = 0;</div>
<div class="line"><span class="lineno"> 30</span> </div>
<div class="line"><span class="lineno"> 31</span> <span class="comment">//allocate space for worst-case scenario</span></div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordtype">char</span>* encoded = <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a725f50ecaf1959d96de79b36b4788fee">malloc</a>(2 * strlen(str));</div>
<div class="line"><span class="lineno"> 33</span> </div>
<div class="line"><span class="lineno"> 34</span> <span class="comment">//temp space for int to str conversion</span></div>
<div class="line"><span class="lineno"> 35</span> <span class="keywordtype">char</span> int_str[20];</div>
<div class="line"><span class="lineno"> 36</span> </div>
<div class="line"><span class="lineno"> 37</span> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i &lt; str_length; ++i) {</div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordtype">int</span> count = 0;</div>
<div class="line"><span class="lineno"> 39</span> <span class="keywordtype">char</span> current = str[i];</div>
<div class="line"><span class="lineno"> 40</span> </div>
<div class="line"><span class="lineno"> 41</span> <span class="comment">//count occurences</span></div>
<div class="line"><span class="lineno"> 42</span> <span class="keywordflow">while</span>(current == str[i + count]) count++;</div>
<div class="line"><span class="lineno"> 43</span> </div>
<div class="line"><span class="lineno"> 44</span> i += count - 1;</div>
<div class="line"><span class="lineno"> 45</span> </div>
<div class="line"><span class="lineno"> 46</span> <span class="comment">//convert occurrence amount to string and write to encoded string</span></div>
<div class="line"><span class="lineno"> 47</span> sprintf(int_str, <span class="stringliteral">&quot;%d&quot;</span>, count);</div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordtype">int</span> int_str_length = strlen(int_str);</div>
<div class="line"><span class="lineno"> 49</span> strncpy(&amp;encoded[encoded_index], int_str, strlen(int_str));</div>
<div class="line"><span class="lineno"> 50</span> </div>
<div class="line"><span class="lineno"> 51</span> <span class="comment">//write current char to encoded string</span></div>
<div class="line"><span class="lineno"> 52</span> encoded_index += strlen(int_str);</div>
<div class="line"><span class="lineno"> 53</span> encoded[encoded_index] = current;</div>
<div class="line"><span class="lineno"> 54</span> ++encoded_index;</div>
<div class="line"><span class="lineno"> 55</span> }</div>
<div class="line"><span class="lineno"> 56</span> </div>
<div class="line"><span class="lineno"> 57</span> <span class="comment">//null terminate string and move encoded string to compacted memory space </span></div>
<div class="line"><span class="lineno"> 58</span> encoded[encoded_index] = <span class="charliteral">&#39;\0&#39;</span>;</div>
<div class="line"><span class="lineno"> 59</span> <span class="keywordtype">char</span>* compacted_string = <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a725f50ecaf1959d96de79b36b4788fee">malloc</a>(strlen(encoded) + 1);</div>
<div class="line"><span class="lineno"> 60</span> strcpy(compacted_string, encoded);</div>
<div class="line"><span class="lineno"> 61</span> </div>
<div class="line"><span class="lineno"> 62</span> <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a9cc854374299a1dd933bf62029761768">free</a>(encoded);</div>
<div class="line"><span class="lineno"> 63</span> </div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">return</span> compacted_string;</div>
<div class="line"><span class="lineno"> 65</span>}</div>
<div class="ttc" id="amalloc__dbg_8h_html_a725f50ecaf1959d96de79b36b4788fee"><div class="ttname"><a href="../../d2/ddd/malloc__dbg_8h.html#a725f50ecaf1959d96de79b36b4788fee">malloc</a></div><div class="ttdeci">#define malloc(bytes)</div><div class="ttdoc">This macro replace the standard malloc function with malloc_dbg.</div><div class="ttdef"><b>Definition:</b> malloc_dbg.h:18</div></div>
<div class="ttc" id="amalloc__dbg_8h_html_a9cc854374299a1dd933bf62029761768"><div class="ttname"><a href="../../d2/ddd/malloc__dbg_8h.html#a9cc854374299a1dd933bf62029761768">free</a></div><div class="ttdeci">#define free(ptr)</div><div class="ttdoc">This macro replace the standard free function with free_dbg.</div><div class="ttdef"><b>Definition:</b> malloc_dbg.h:26</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&#160;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Self-test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 71</span> {</div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>;</div>
<div class="line"><span class="lineno"> 73</span> <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a> = <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#ac3cc4a63cf2a14a08e05c5537ecf59c2">run_length_encode</a>(<span class="stringliteral">&quot;aaaaaaabbbaaccccdefaadr&quot;</span>);</div>
<div class="line"><span class="lineno"> 74</span> assert(!strcmp(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>, <span class="stringliteral">&quot;7a3b2a4c1d1e1f2a1d1r&quot;</span>));</div>
<div class="line"><span class="lineno"> 75</span> <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a9cc854374299a1dd933bf62029761768">free</a>(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>);</div>
<div class="line"><span class="lineno"> 76</span> <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a> = <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#ac3cc4a63cf2a14a08e05c5537ecf59c2">run_length_encode</a>(<span class="stringliteral">&quot;lidjhvipdurevbeirbgipeahapoeuhwaipefupwieofb&quot;</span>);</div>
<div class="line"><span class="lineno"> 77</span> assert(!strcmp(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>, <span class="stringliteral">&quot;1l1i1d1j1h1v1i1p1d1u1r1e1v1b1e1i1r1b1g1i1p1e1a1h1a1p1o1e1u1h1w1a1i1p1e1f1u1p1w1i1e1o1f1bq&quot;</span>));</div>
<div class="line"><span class="lineno"> 78</span> <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a9cc854374299a1dd933bf62029761768">free</a>(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>);</div>
<div class="line"><span class="lineno"> 79</span> <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a> = <a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#ac3cc4a63cf2a14a08e05c5537ecf59c2">run_length_encode</a>(<span class="stringliteral">&quot;htuuuurwuquququuuaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaahghghrw&quot;</span>);</div>
<div class="line"><span class="lineno"> 80</span> assert(!strcmp(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>, <span class="stringliteral">&quot;1h1t4u1r1w1u1q1u1q1u1q3u76a1h1g1h1g1h1r1w&quot;</span>));</div>
<div class="line"><span class="lineno"> 81</span> <a class="code hl_define" href="../../d2/ddd/malloc__dbg_8h.html#a9cc854374299a1dd933bf62029761768">free</a>(<a class="code hl_function" href="../../d1/dc7/run__length__encoding_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>);</div>
<div class="line"><span class="lineno"> 82</span>}</div>
<div class="ttc" id="arun__length__encoding_8c_html_ac3cc4a63cf2a14a08e05c5537ecf59c2"><div class="ttname"><a href="../../d1/dc7/run__length__encoding_8c.html#ac3cc4a63cf2a14a08e05c5537ecf59c2">run_length_encode</a></div><div class="ttdeci">char * run_length_encode(char *str)</div><div class="ttdoc">for IO operations</div><div class="ttdef"><b>Definition:</b> run_length_encoding.c:27</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d1/dc7/run__length__encoding_8c_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="236" height="60"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_a52f4d3d586a58b02f3a4ddf0a992157.html">misc</a></li><li class="navelem"><a class="el" href="../../d1/dc7/run__length__encoding_8c.html">run_length_encoding.c</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink