publicdata/nih-gov
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nih-gov/www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/structBlastSeqSrcIterator.html

196 lines
14 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">
<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.9.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NCBI C++ ToolKit: BlastSeqSrcIterator Struct 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="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
jQuery.getScript("/core/alerts/alerts.js", function () {
galert(['div.nav_and_browser', 'div.header', '#universal_header',
'body > *:nth-child(1)'])
});
</script>
</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">NCBI C++ ToolKit
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<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,true,'/toolkit/','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structBlastSeqSrcIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BlastSeqSrcIterator Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>
<a class="el" href = "https://www.ncbi.nlm.nih.gov/toolkitbookgh/?term=BlastSeqSrcIterator">Search Toolkit Book for <i>BlastSeqSrcIterator</i></a>
</p>
<p>Complete type definition of Blast <a class="el" href="classSequence.html">Sequence</a> Source Iterator.
<a href="structBlastSeqSrcIterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="blast__seqsrc__impl_8h_source.html">algo/blast/core/blast_seqsrc_impl.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3dd1c54cc709aa570b3d683fa2b8c67e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="blast__seqsrc__impl_8h.html#ad127bb4fed6121a2debcf897a905da52">BlastSeqSrcItrType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlastSeqSrcIterator.html#a3dd1c54cc709aa570b3d683fa2b8c67e">itr_type</a></td></tr>
<tr class="memdesc:a3dd1c54cc709aa570b3d683fa2b8c67e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates which member to access: oid_list or oid_range. <a href="structBlastSeqSrcIterator.html#a3dd1c54cc709aa570b3d683fa2b8c67e">More...</a><br /></td></tr>
<tr class="separator:a3dd1c54cc709aa570b3d683fa2b8c67e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88eb8cdfbec8af0e3356d56053d01037"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlastSeqSrcIterator.html#a88eb8cdfbec8af0e3356d56053d01037">oid_list</a></td></tr>
<tr class="memdesc:a88eb8cdfbec8af0e3356d56053d01037"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of ordinal ids used when itr_type is eOidList. <a href="structBlastSeqSrcIterator.html#a88eb8cdfbec8af0e3356d56053d01037">More...</a><br /></td></tr>
<tr class="separator:a88eb8cdfbec8af0e3356d56053d01037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84598bccb0ba26ebdee49d5d5f33adb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlastSeqSrcIterator.html#a84598bccb0ba26ebdee49d5d5f33adb5">oid_range</a> [2]</td></tr>
<tr class="memdesc:a84598bccb0ba26ebdee49d5d5f33adb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is a half-closed interval [a,b) <a href="structBlastSeqSrcIterator.html#a84598bccb0ba26ebdee49d5d5f33adb5">More...</a><br /></td></tr>
<tr class="separator:a84598bccb0ba26ebdee49d5d5f33adb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba2dd45e2bb9af17aad2b989900d58d"><td class="memItemLeft" align="right" valign="top">unsigned <a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlastSeqSrcIterator.html#aaba2dd45e2bb9af17aad2b989900d58d">current_pos</a></td></tr>
<tr class="memdesc:aaba2dd45e2bb9af17aad2b989900d58d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Keep track of this iterator's current position, implementations use UINT4_MAX to indicate this is uninitialized/invalid. <a href="structBlastSeqSrcIterator.html#aaba2dd45e2bb9af17aad2b989900d58d">More...</a><br /></td></tr>
<tr class="separator:aaba2dd45e2bb9af17aad2b989900d58d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10e9a67029437177b26839d2e02c607a"><td class="memItemLeft" align="right" valign="top">unsigned <a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlastSeqSrcIterator.html#a10e9a67029437177b26839d2e02c607a">chunk_sz</a></td></tr>
<tr class="memdesc:a10e9a67029437177b26839d2e02c607a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the chunks to advance over the <a class="el" href="structBlastSeqSrc.html" title="Complete type definition of Blast Sequence Source ADT.">BlastSeqSrc</a>, also size of oid_list member, this is provided to reduce mutex contention when implementing MT-safe iteration. <a href="structBlastSeqSrcIterator.html#a10e9a67029437177b26839d2e02c607a">More...</a><br /></td></tr>
<tr class="separator:a10e9a67029437177b26839d2e02c607a"><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>Complete type definition of Blast <a class="el" href="classSequence.html">Sequence</a> Source Iterator. </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00170">170</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a10e9a67029437177b26839d2e02c607a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10e9a67029437177b26839d2e02c607a">&#9670;&nbsp;</a></span>chunk_sz</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a> BlastSeqSrcIterator::chunk_sz</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the chunks to advance over the <a class="el" href="structBlastSeqSrc.html" title="Complete type definition of Blast Sequence Source ADT.">BlastSeqSrc</a>, also size of oid_list member, this is provided to reduce mutex contention when implementing MT-safe iteration. </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00185">185</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blast__seqsrc_8c_source.html#l00387">BlastSeqSrcIteratorNewEx()</a>, <a class="el" href="blast__aux_8cpp_source.html#l00451">CBlastSeqSrcIterator::DebugDump()</a>, <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00465">s_SeqDbGetNextChunk()</a>, and <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00511">s_SeqDbIteratorNext()</a>.</p>
</div>
</div>
<a id="aaba2dd45e2bb9af17aad2b989900d58d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba2dd45e2bb9af17aad2b989900d58d">&#9670;&nbsp;</a></span>current_pos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a> BlastSeqSrcIterator::current_pos</td>
</tr>
</table>
</div><div class="memdoc">
<p>Keep track of this iterator's current position, implementations use UINT4_MAX to indicate this is uninitialized/invalid. </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00181">181</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blast__seqsrc_8c_source.html#l00387">BlastSeqSrcIteratorNewEx()</a>, <a class="el" href="blast__aux_8cpp_source.html#l00451">CBlastSeqSrcIterator::DebugDump()</a>, <a class="el" href="seqsrc__multiseq_8cpp_source.html#l00412">s_MultiSeqGetNextChunk()</a>, <a class="el" href="seqsrc__multiseq_8cpp_source.html#l00444">s_MultiSeqIteratorNext()</a>, <a class="el" href="seqsrc__query__factory_8cpp_source.html#l00391">s_QueryFactoryGetNextChunk()</a>, <a class="el" href="seqsrc__query__factory_8cpp_source.html#l00421">s_QueryFactoryIteratorNext()</a>, <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00465">s_SeqDbGetNextChunk()</a>, <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00511">s_SeqDbIteratorNext()</a>, and <a class="el" href="seqsrc__vdb_8c_source.html#l00297">s_VDBSRC_IteratorNext()</a>.</p>
</div>
</div>
<a id="a3dd1c54cc709aa570b3d683fa2b8c67e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dd1c54cc709aa570b3d683fa2b8c67e">&#9670;&nbsp;</a></span>itr_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="blast__seqsrc__impl_8h.html#ad127bb4fed6121a2debcf897a905da52">BlastSeqSrcItrType</a> BlastSeqSrcIterator::itr_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates which member to access: oid_list or oid_range. </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00172">172</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blast__aux_8cpp_source.html#l00451">CBlastSeqSrcIterator::DebugDump()</a>, <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00465">s_SeqDbGetNextChunk()</a>, and <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00511">s_SeqDbIteratorNext()</a>.</p>
</div>
</div>
<a id="a88eb8cdfbec8af0e3356d56053d01037"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88eb8cdfbec8af0e3356d56053d01037">&#9670;&nbsp;</a></span>oid_list</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a>* BlastSeqSrcIterator::oid_list</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of ordinal ids used when itr_type is eOidList. </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00175">175</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="blast__seqsrc_8c_source.html#l00412">BlastSeqSrcIteratorFree()</a>, <a class="el" href="blast__seqsrc_8c_source.html#l00387">BlastSeqSrcIteratorNewEx()</a>, <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00465">s_SeqDbGetNextChunk()</a>, and <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00511">s_SeqDbIteratorNext()</a>.</p>
</div>
</div>
<a id="a84598bccb0ba26ebdee49d5d5f33adb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84598bccb0ba26ebdee49d5d5f33adb5">&#9670;&nbsp;</a></span>oid_range</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__mdb__copy.html#ga10cfb7d4996b006d5675b53b9c7f0fb5">int</a> BlastSeqSrcIterator::oid_range[2]</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is a half-closed interval [a,b) </p>
<p class="definition">Definition at line <a class="el" href="blast__seqsrc__impl_8h_source.html#l00177">177</a> of file <a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00465">s_SeqDbGetNextChunk()</a>, and <a class="el" href="seqsrc__seqdb_8cpp_source.html#l00511">s_SeqDbIteratorNext()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/algo/blast/core/<a class="el" href="blast__seqsrc__impl_8h_source.html">blast_seqsrc_impl.h</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.0
</small></address>
<address style="align: right;"><small>Modified on Fri Sep 20 14:57:20 2024 by modify_doxy.py rev. 669887</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink