NCBI C++ ToolKit
Public Attributes | List of all members
BlastSeqSrcIterator Struct Reference

Search Toolkit Book for BlastSeqSrcIterator

Complete type definition of Blast Sequence Source Iterator. More...

#include <algo/blast/core/blast_seqsrc_impl.h>

Public Attributes

BlastSeqSrcItrType itr_type
 Indicates which member to access: oid_list or oid_range. More...
 
intoid_list
 Array of ordinal ids used when itr_type is eOidList. More...
 
int oid_range [2]
 This is a half-closed interval [a,b) More...
 
unsigned int current_pos
 Keep track of this iterator's current position, implementations use UINT4_MAX to indicate this is uninitialized/invalid. More...
 
unsigned int chunk_sz
 Size of the chunks to advance over the BlastSeqSrc, also size of oid_list member, this is provided to reduce mutex contention when implementing MT-safe iteration. More...
 

Detailed Description

Complete type definition of Blast Sequence Source Iterator.

Definition at line 170 of file blast_seqsrc_impl.h.

Member Data Documentation

◆ chunk_sz

unsigned int BlastSeqSrcIterator::chunk_sz

Size of the chunks to advance over the BlastSeqSrc, also size of oid_list member, this is provided to reduce mutex contention when implementing MT-safe iteration.

Definition at line 185 of file blast_seqsrc_impl.h.

Referenced by BlastSeqSrcIteratorNewEx(), CBlastSeqSrcIterator::DebugDump(), s_SeqDbGetNextChunk(), and s_SeqDbIteratorNext().

◆ current_pos

unsigned int BlastSeqSrcIterator::current_pos

Keep track of this iterator's current position, implementations use UINT4_MAX to indicate this is uninitialized/invalid.

Definition at line 181 of file blast_seqsrc_impl.h.

Referenced by BlastSeqSrcIteratorNewEx(), CBlastSeqSrcIterator::DebugDump(), s_MultiSeqGetNextChunk(), s_MultiSeqIteratorNext(), s_QueryFactoryGetNextChunk(), s_QueryFactoryIteratorNext(), s_SeqDbGetNextChunk(), s_SeqDbIteratorNext(), and s_VDBSRC_IteratorNext().

◆ itr_type

BlastSeqSrcItrType BlastSeqSrcIterator::itr_type

Indicates which member to access: oid_list or oid_range.

Definition at line 172 of file blast_seqsrc_impl.h.

Referenced by CBlastSeqSrcIterator::DebugDump(), s_SeqDbGetNextChunk(), and s_SeqDbIteratorNext().

◆ oid_list

int* BlastSeqSrcIterator::oid_list

Array of ordinal ids used when itr_type is eOidList.

Definition at line 175 of file blast_seqsrc_impl.h.

Referenced by BlastSeqSrcIteratorFree(), BlastSeqSrcIteratorNewEx(), s_SeqDbGetNextChunk(), and s_SeqDbIteratorNext().

◆ oid_range

int BlastSeqSrcIterator::oid_range[2]

This is a half-closed interval [a,b)

Definition at line 177 of file blast_seqsrc_impl.h.

Referenced by s_SeqDbGetNextChunk(), and s_SeqDbIteratorNext().


The documentation for this struct was generated from the following file:
Modified on Tue May 21 10:55:40 2024 by modify_doxy.py rev. 669887