Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
parham-k committed Feb 13, 2023
1 parent 6170353 commit 6f92218
Show file tree
Hide file tree
Showing 15 changed files with 484 additions and 69 deletions.
13 changes: 7 additions & 6 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,13 @@
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1MIBloomFilter.html" target="_self">MIBloomFilter</a></td><td class="desc"></td></tr>
<tr id="row_0_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1NtHash.html" target="_self">NtHash</a></td><td class="desc"></td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1ProcessPipeline.html" target="_self">ProcessPipeline</a></td><td class="desc"></td></tr>
<tr id="row_0_9_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeedBloomFilter.html" target="_self">SeedBloomFilter</a></td><td class="desc"></td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeedNtHash.html" target="_self">SeedNtHash</a></td><td class="desc"></td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_11_" class="arrow" onclick="toggleFolder('0_11_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeqReader.html" target="_self">SeqReader</a></td><td class="desc"></td></tr>
<tr id="row_0_11_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html" target="_self">Flag</a></td><td class="desc"></td></tr>
<tr id="row_0_11_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbtllib_1_1SeqReader_1_1Record.html" target="_self">Record</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeqWriter.html" target="_self">SeqWriter</a></td><td class="desc"></td></tr>
<tr id="row_0_9_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html" target="_self">RandomSequenceGenerator</a></td><td class="desc"></td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeedBloomFilter.html" target="_self">SeedBloomFilter</a></td><td class="desc"></td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeedNtHash.html" target="_self">SeedNtHash</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_12_" class="arrow" onclick="toggleFolder('0_12_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeqReader.html" target="_self">SeqReader</a></td><td class="desc"></td></tr>
<tr id="row_0_12_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html" target="_self">Flag</a></td><td class="desc"></td></tr>
<tr id="row_0_12_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbtllib_1_1SeqReader_1_1Record.html" target="_self">Record</a></td><td class="desc"></td></tr>
<tr id="row_0_13_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classbtllib_1_1SeqWriter.html" target="_self">SeqWriter</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
98 changes: 98 additions & 0 deletions docs/classbtllib_1_1RandomSequenceGenerator-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<!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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>btllib: Member List</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">btllib
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacebtllib.html">btllib</a></li><li class="navelem"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">RandomSequenceGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">btllib::RandomSequenceGenerator Member List</div></div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>DNA</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html#a38515aaa3da32b71c866dfc58a3eac4b">generate</a>(size_t length)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>HARD</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Masking</b> enum name (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>NONE</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>PROTEIN</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html#a9dd080136218569ca55fd471b166c500">RandomSequenceGenerator</a>(SequenceType type, Masking masking=NONE)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>RNA</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>SequenceType</b> enum name (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>SOFT</b> enum value (defined in <a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a>)</td><td class="entry"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">btllib::RandomSequenceGenerator</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
176 changes: 176 additions & 0 deletions docs/classbtllib_1_1RandomSequenceGenerator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>btllib: btllib::RandomSequenceGenerator Class 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">btllib
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacebtllib.html">btllib</a></li><li class="navelem"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html">RandomSequenceGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classbtllib_1_1RandomSequenceGenerator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">btllib::RandomSequenceGenerator Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a805a573a8cd5ae8a689d54cff804ff3e"><td class="memItemLeft" align="right" valign="top"><a id="a805a573a8cd5ae8a689d54cff804ff3e" name="a805a573a8cd5ae8a689d54cff804ff3e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>SequenceType</b> { <b>DNA</b>
, <b>RNA</b>
, <b>PROTEIN</b>
}</td></tr>
<tr class="separator:a805a573a8cd5ae8a689d54cff804ff3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9ea7d83f3f21f64ff79020dfc38538"><td class="memItemLeft" align="right" valign="top"><a id="a6d9ea7d83f3f21f64ff79020dfc38538" name="a6d9ea7d83f3f21f64ff79020dfc38538"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Masking</b> { <b>NONE</b>
, <b>SOFT</b>
, <b>HARD</b>
}</td></tr>
<tr class="separator:a6d9ea7d83f3f21f64ff79020dfc38538"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9dd080136218569ca55fd471b166c500"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html#a9dd080136218569ca55fd471b166c500">RandomSequenceGenerator</a> (SequenceType type, Masking masking=NONE)</td></tr>
<tr class="separator:a9dd080136218569ca55fd471b166c500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38515aaa3da32b71c866dfc58a3eac4b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbtllib_1_1RandomSequenceGenerator.html#a38515aaa3da32b71c866dfc58a3eac4b">generate</a> (size_t length)</td></tr>
<tr class="separator:a38515aaa3da32b71c866dfc58a3eac4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9dd080136218569ca55fd471b166c500" name="a9dd080136218569ca55fd471b166c500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd080136218569ca55fd471b166c500">&#9670;&#160;</a></span>RandomSequenceGenerator()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">btllib::RandomSequenceGenerator::RandomSequenceGenerator </td>
<td>(</td>
<td class="paramtype">SequenceType&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Masking&#160;</td>
<td class="paramname"><em>masking</em> = <code>NONE</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Construct a random sequence generator object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Sequence type (DNA, RNA, or protein) </td></tr>
<tr><td class="paramname">masking</td><td>If set to SOFT, lower-case values will also be generated. If HARD, the sequences will include N/X positions. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a38515aaa3da32b71c866dfc58a3eac4b" name="a38515aaa3da32b71c866dfc58a3eac4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38515aaa3da32b71c866dfc58a3eac4b">&#9670;&#160;</a></span>generate()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string btllib::RandomSequenceGenerator::generate </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Generate a new random sequence.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>Sequence length </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/btllib/<a class="el" href="random__seq__generator_8hpp_source.html">random_seq_generator.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
Loading

0 comments on commit 6f92218

Please sign in to comment.