/usr/share/doc/libbamtools-dev/html/struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html is in libbamtools-doc 2.4.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BamTools: BamTools::Algorithms::Sort::ByTag< T > Struct Template 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BamTools
 <span id="projectnumber">2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespace_bam_tools.html">BamTools</a></li><li class="navelem"><a class="el" href="namespace_bam_tools_1_1_algorithms.html">Algorithms</a></li><li class="navelem"><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html">Sort</a></li><li class="navelem"><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html">ByTag</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BamTools::Algorithms::Sort::ByTag< T > Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Function object for comparing alignments by tag value.
<a href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_sort_8h_source.html">Sort.h</a>></code></p>
<p>Inherits AlignmentSortBase.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaca046c10c1fb4cf52dbbca81872ec94"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html#aaca046c10c1fb4cf52dbbca81872ec94">ByTag</a> (const std::string &tag, const <a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61">Sort::Order</a> &order=<a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61aad318af311e94e010e964ee73968f8b0">Sort::AscendingOrder</a>)</td></tr>
<tr class="separator:aaca046c10c1fb4cf52dbbca81872ec94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6359624c1749b75615a098d2fc8f1c4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html#af6359624c1749b75615a098d2fc8f1c4">operator()</a> (const <a class="el" href="class_bam_tools_1_1_bam_alignment.html">BamTools::BamAlignment</a> &lhs, const <a class="el" href="class_bam_tools_1_1_bam_alignment.html">BamTools::BamAlignment</a> &rhs)</td></tr>
<tr class="separator:af6359624c1749b75615a098d2fc8f1c4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br />
struct BamTools::Algorithms::Sort::ByTag< T ></h3>
<p>Function object for comparing alignments by tag value. </p>
<p>Default sort order is <a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61aad318af311e94e010e964ee73968f8b0">Sort::AscendingOrder</a>.</p>
<div class="fragment"><div class="line">std::vector<BamAlignment> a;</div><div class="line"></div><div class="line"><span class="comment">// sort by edit distance, in ascending order (the following two lines are equivalent):</span></div><div class="line">std::sort( a.begin(), a.end(), Sort::ByTag<int>(<span class="stringliteral">"NM"</span>) );</div><div class="line">std::sort( a.begin(), a.end(), Sort::ByTag<int>(<span class="stringliteral">"NM"</span>, <a class="code" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61aad318af311e94e010e964ee73968f8b0">Sort::AscendingOrder</a>) );</div><div class="line"></div><div class="line"><span class="comment">// OR sort in descending order</span></div><div class="line">std::sort( a.begin(), a.end(), Sort::ByTag<int>(<span class="stringliteral">"NM"</span>, <a class="code" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61a551ab4e6dbb5a38344515ca0823b8ddd">Sort::DescendingOrder</a>) );</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aaca046c10c1fb4cf52dbbca81872ec94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaca046c10c1fb4cf52dbbca81872ec94">◆ </a></span>ByTag()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html">BamTools::Algorithms::Sort::ByTag</a>< T >::<a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html">ByTag</a> </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61">Sort::Order</a> & </td>
<td class="paramname"><em>order</em> = <code><a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort.html#ab00bd07c176b33933717ca362b716f61aad318af311e94e010e964ee73968f8b0">Sort::AscendingOrder</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af6359624c1749b75615a098d2fc8f1c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6359624c1749b75615a098d2fc8f1c4">◆ </a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="struct_bam_tools_1_1_algorithms_1_1_sort_1_1_by_tag.html">BamTools::Algorithms::Sort::ByTag</a>< T >::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_bam_tools_1_1_bam_alignment.html">BamTools::BamAlignment</a> & </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_bam_tools_1_1_bam_alignment.html">BamTools::BamAlignment</a> & </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_sort_8h_source.html">Sort.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|