diff options
Added documentation
1 files changed, 180 insertions, 0 deletions
| -rw-r--r-- | docs/html/List_8hpp.html | 180 |
diff --git a/docs/html/List_8hpp.html b/docs/html/List_8hpp.html new file mode 100644 index 0000000..ef7295e --- /dev/null +++ b/docs/html/List_8hpp.html @@ -0,0 +1,180 @@ +<!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=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>FMI Table: src/Generic/List/List.hpp 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="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 id="projectrow"> + <td id="projectalign"> + <div id="projectname">FMI Table + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.3 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'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&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> +<!-- 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b37d33ceb7f5c107fb027d4db224bc89.html">Generic</a></li><li class="navelem"><a class="el" href="dir_bba1b217f5afc342a21d50631c0a2103.html">List</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"><div class="title">List.hpp File Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Stores declaration and definition of templated class <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a>. +<a href="#details">More...</a></p> +<div class="textblock"><code>#include <istream></code><br /> +<code>#include <ostream></code><br /> +</div> +<p><a href="List_8hpp_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classList.html">List< T ></a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Templated class that stores an array of elements in dynamic memory. <a href="classList.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:a7469c3479753bfbada761697c539aa07"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:a7469c3479753bfbada761697c539aa07"><td class="memTemplItemLeft" align="right" valign="top">std::istream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="List_8hpp.html#a7469c3479753bfbada761697c539aa07">operator>></a> (std::istream &istr, <a class="el" href="classList.html">List</a>< T > &obj)</td></tr> +<tr class="memdesc:a7469c3479753bfbada761697c539aa07"><td class="mdescLeft"> </td><td class="mdescRight">Reads <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a> from stream with >> operator. <a href="List_8hpp.html#a7469c3479753bfbada761697c539aa07">More...</a><br /></td></tr> +<tr class="separator:a7469c3479753bfbada761697c539aa07"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac8590f4d4ba6c820c34afe14df54f2c2"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:ac8590f4d4ba6c820c34afe14df54f2c2"><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="List_8hpp.html#ac8590f4d4ba6c820c34afe14df54f2c2">operator<<</a> (std::ostream &ostr, const <a class="el" href="classList.html">List</a>< T > &obj)</td></tr> +<tr class="memdesc:ac8590f4d4ba6c820c34afe14df54f2c2"><td class="mdescLeft"> </td><td class="mdescRight">Writes <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a> to stream with << operator. <a href="List_8hpp.html#ac8590f4d4ba6c820c34afe14df54f2c2">More...</a><br /></td></tr> +<tr class="separator:ac8590f4d4ba6c820c34afe14df54f2c2"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p >Stores declaration and definition of templated class <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a>. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="ac8590f4d4ba6c820c34afe14df54f2c2" name="ac8590f4d4ba6c820c34afe14df54f2c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac8590f4d4ba6c820c34afe14df54f2c2">◆ </a></span>operator<<()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> + <table class="memname"> + <tr> + <td class="memname">std::ostream & operator<< </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classList.html">List</a>< T > & </td> + <td class="paramname"><em>obj</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Writes <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a> to stream with << operator. </p> +<p >Uses the stream's << operator to write the count and then all objects.</p> +<dl class="section warning"><dt>Warning</dt><dd>The function depends on the type having the operator << defined, which takes an std::ostream& and writes it's data to it. Return type doesn't matter. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cout or text std::ofstream </dd></dl> + +</div> +</div> +<a id="a7469c3479753bfbada761697c539aa07" name="a7469c3479753bfbada761697c539aa07"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7469c3479753bfbada761697c539aa07">◆ </a></span>operator>>()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> + <table class="memname"> + <tr> + <td class="memname">std::istream & operator>> </td> + <td>(</td> + <td class="paramtype">std::istream & </td> + <td class="paramname"><em>istr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classList.html">List</a>< T > & </td> + <td class="paramname"><em>obj</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads <a class="el" href="classList.html" title="Templated class that stores an array of elements in dynamic memory.">List</a> from stream with >> operator. </p> +<p >Uses the stream's >> operator to read and parse the elements. The first item in the stream should be the count.</p> +<dl class="section warning"><dt>Warning</dt><dd>The function depends on the type having the operator >> defined, which takes an std::istream& and writes it's data to it. Return type doesn't matter. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cin or text std::ifstream </dd></dl> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +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.3 +</small></address> +</body> +</html> |