NCBI C++ ToolKit
Classes | Typedefs | Functions
blast_hspstream_mt_utils.h File Reference

Private interfaces to support the multi-threaded traceback in conjunction with the BlastHSPStream. More...

#include <algo/blast/core/blast_hspstream.h>
+ Include dependency graph for blast_hspstream_mt_utils.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

struct  BlastHSPStreamResultsBatchArray
 Structure to extract the contents of the BlastHSPStream for MT traceback processing. More...
 

Typedefs

typedef struct BlastHSPStreamResultsBatchArray BlastHSPStreamResultsBatchArray
 Structure to extract the contents of the BlastHSPStream for MT traceback processing. More...
 

Functions

int BlastHSPStreamToHSPStreamResultsBatch (BlastHSPStream *hsp_stream, BlastHSPStreamResultsBatchArray **batches)
 Extracts all data from the BlastHSPStream into its output parameters. More...
 
BlastHSPStreamResultsBatchArrayBlastHSPStreamResultsBatchNew (void)
 Creates a BlastHSPStreamResultsBatchArray with a single element. More...
 
BlastHSPStreamResultsBatchArrayBlastHSPStreamResultsBatchArrayFree (BlastHSPStreamResultsBatchArray *batches)
 Releases memory acquired in BlastHSPStreamToHSPStreamResultsBatch. More...
 

Detailed Description

Private interfaces to support the multi-threaded traceback in conjunction with the BlastHSPStream.

Definition in file blast_hspstream_mt_utils.h.

Typedef Documentation

◆ BlastHSPStreamResultsBatchArray

Structure to extract the contents of the BlastHSPStream for MT traceback processing.

Function Documentation

◆ BlastHSPStreamResultsBatchArrayFree()

BlastHSPStreamResultsBatchArray* BlastHSPStreamResultsBatchArrayFree ( BlastHSPStreamResultsBatchArray batches)

◆ BlastHSPStreamResultsBatchNew()

BlastHSPStreamResultsBatchArray* BlastHSPStreamResultsBatchNew ( void  )

Creates a BlastHSPStreamResultsBatchArray with a single element.

Used to mimic BlastHSPStreamToHSPStreamResultsBatch when there is no hsp_stream.

Definition at line 93 of file blast_hspstream_mt_utils.c.

References s_BlastHSPStreamResultsBatchArrayNew().

◆ BlastHSPStreamToHSPStreamResultsBatch()

int BlastHSPStreamToHSPStreamResultsBatch ( BlastHSPStream hsp_stream,
BlastHSPStreamResultsBatchArray **  batches 
)

Extracts all data from the BlastHSPStream into its output parameters.

Parameters
hsp_streamThe BlastHSPStream object [in]
batchesEach batch contains the results for a single OID [in|out] kBlastHSPStream_Success on successful conversion, otherwise an error code which explains the problem.

Definition at line 145 of file blast_hspstream_mt_utils.c.

References Blast_HSPStreamResultBatchFree(), Blast_HSPStreamResultBatchInit(), BLASTERR_INVALIDPARAM, BLASTERR_MEMORY, BlastHSPStreamBatchRead(), BlastHSPStreamResultsBatchArrayFree(), kBlastHSPStream_Eof, kBlastHSPStream_Success, NULL, BlastHSPResults::num_queries, BlastHSPStream::results, s_BlastHSPStreamCountNumOids(), s_BlastHSPStreamResultsBatchArrayAppend(), s_BlastHSPStreamResultsBatchArrayNew(), and s_BlastHSPStreamResultsBatchArrayReset().

Referenced by BLAST_ComputeTraceback_MT().

Modified on Mon Apr 22 04:07:30 2024 by modify_doxy.py rev. 669887