docs/html/index.html

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Projet C: Main Page</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="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>
<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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Projet C
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Projet C Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#autotoc_md0">My C-lang project documentation</a><ul><li class="level2"><a href="#autotoc_md1">Introduction</a></li>
<li class="level2"><a href="#autotoc_md2">Method 1</a></li>
<li class="level2"><a href="#autotoc_md3">Method 2</a></li>
<li class="level2"><a href="#autotoc_md4">Results</a></li>
</ul>
</li>
<li class="level1"><a href="#autotoc_md5">Installation</a><ul><li class="level2"><a href="#autotoc_md6">Step 1 : Download the archive</a></li>
<li class="level2"><a href="#autotoc_md7">Step 2 : Open the archive in a folder</a></li>
<li class="level2"><a href="#autotoc_md8">Step 3 : Open a terminal</a></li>
<li class="level2"><a href="#autotoc_md9">Step 4 : Launch the app</a></li>
<li class="level2"><a href="#autotoc_md10">Step 5 : Enjoy</a></li>
</ul>
</li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="autotoc_md0"></a>
My C-lang project documentation</h1>
<h2><a class="anchor" id="autotoc_md1"></a>
Introduction</h2>
<p>The C project consists in loading data into a list using two methods.</p>
<h2><a class="anchor" id="autotoc_md2"></a>
Method 1</h2>
<p>It is a simple list. We compare the cells made from lines and then insert the cell in the right place.</p>
<h2><a class="anchor" id="autotoc_md3"></a>
Method 2</h2>
<p>It is an optimized list using an index. We compare the cells made from lines with an index and then insert the cell in the right index_list.</p>
<h2><a class="anchor" id="autotoc_md4"></a>
Results</h2>
<p>We compare the execution time of both methods using small, medium and large files.</p>
<p>The results are that method 2 is quicker than method 1.</p>
<h1><a class="anchor" id="autotoc_md5"></a>
Installation</h1>
<p>How to install and use the program.</p>
<h2><a class="anchor" id="autotoc_md6"></a>
Step 1 : Download the archive</h2>
<p>Firstly, download the archive containing every source files.</p>
<h2><a class="anchor" id="autotoc_md7"></a>
Step 2 : Open the archive in a folder</h2>
<p>Then, open the archive in a given folder on your computer.</p>
<h2><a class="anchor" id="autotoc_md8"></a>
Step 3 : Open a terminal</h2>
<p>Use the terminal (under Linux or any OS) and go to the folder containing the source code.</p>
<p>For example, you can be in <code>~/projetc $</code></p>
<h2><a class="anchor" id="autotoc_md9"></a>
Step 4 : Launch the app</h2>
<p>From here, you can launch the app by using <code>./bin/annuaire</code> If you don't add any arguments, like the file, it will tell you how to use the program.</p>
<p>Examples of usage :</p>
<div class="fragment"><div class="line">./bin/annuaire data/small.txt</div>
<div class="line">./bin/annuaire data/small.txt --display</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md10"></a>
Step 5 : Enjoy</h2>
<p>Enjoy the program and compare the execution time of methods.</p>
<p>Please consider using <code>./bin/annuaire</code> without any arguments to see complete usage and possible options. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>