NCBI C++ ToolKit
seqsrc_multiseq.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef ALGO_BLAST_API___SEQSRC_MULTISEQ__HPP
2 #define ALGO_BLAST_API___SEQSRC_MULTISEQ__HPP
3 
4 /* $Id: seqsrc_multiseq.hpp 68855 2015-09-10 12:56:25Z madden $
5 * ===========================================================================
6 *
7 * PUBLIC DOMAIN NOTICE
8 * National Center for Biotechnology Information
9 *
10 * This software/database is a "United States Government Work" under the
11 * terms of the United States Copyright Act. It was written as part of
12 * the author's official duties as a United States Government employee and
13 * thus cannot be copyrighted. This software/database is freely available
14 * to the public for use. The National Library of Medicine and the U.S.
15 * Government have not placed any restriction on its use or reproduction.
16 *
17 * Although all reasonable efforts have been taken to ensure the accuracy
18 * and reliability of the software and data, the NLM and the U.S.
19 * Government do not and cannot warrant the performance or results that
20 * may be obtained by using this software or data. The NLM and the U.S.
21 * Government disclaim all warranties, express or implied, including
22 * warranties of performance, merchantability or fitness for any particular
23 * purpose.
24 *
25 * Please cite the author in any work or product based on this material.
26 *
27 * ===========================================================================
28 *
29 * Author: Ilya Dondoshansky
30 *
31 */
32 
33 /// @file seqsrc_multiseq.hpp
34 /// Implementation of the BlastSeqSrc interface for a vector of sequence
35 /// locations.
36 
37 
41 
42 /** @addtogroup AlgoBlast
43  *
44  * @{
45  */
46 
48 BEGIN_SCOPE(blast)
49 
50 /** Initialize the sequence source structure.
51  * @param seq_vector Vector of sequence locations [in]
52  * @param program Type of BLAST to be performed [in]
53  * @param dbscanmode Database search mode (not pairwise) [in]
54  */
57  EBlastProgramType program,
58  bool dbscan_mode=false);
59 
60 END_SCOPE(blast)
62 
63 /* @} */
64 
65 #endif /* ALGO_BLAST_API___SEQSRC_MULTISEQ__HPP */
Definitions used throughout BLAST.
#define NCBI_XBLAST_EXPORT
NULL operations for other cases.
Definition: blast_export.h:65
EBlastProgramType
Defines the engine's notion of the different applications of the BLAST algorithm.
Definition: blast_program.h:72
Declaration of ADT to retrieve sequences for the BLAST engine.
BlastSeqSrc * MultiSeqBlastSeqSrcInit(TSeqLocVector &seq_vector, EBlastProgramType program, bool dbscan_mode=false)
Initialize the sequence source structure.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define END_SCOPE(ns)
End the previously defined scope.
Definition: ncbistl.hpp:75
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define BEGIN_SCOPE(ns)
Define a new scope.
Definition: ncbistl.hpp:72
Definition of SSeqLoc structure.
vector< SSeqLoc > TSeqLocVector
Vector of sequence locations.
Definition: sseqloc.hpp:129
Complete type definition of Blast Sequence Source ADT.
Definition: blast_seqsrc.c:43
Modified on Thu Apr 25 08:17:07 2024 by modify_doxy.py rev. 669887