~ubuntu-branches/ubuntu/precise/ncbi-tools6/precise

« back to all changes in this revision

Viewing changes to algo/blast/api/blast_tback.h

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2005-03-27 12:00:15 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050327120015-embhesp32nj73p9r
Tags: 6.1.20041020-3
* Fix FTBFS under GCC 4.0 caused by inconsistent use of "static" on
  functions.  (Closes: #295110.)
* Add a watch file, now that we can.  (Upstream's layout needs version=3.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* $Id: blast_tback.h,v 1.1 2004/10/06 19:03:15 dondosha Exp $
 
2
 * ===========================================================================
 
3
 *
 
4
 *                            PUBLIC DOMAIN NOTICE
 
5
 *               National Center for Biotechnology Information
 
6
 *
 
7
 *  This software/database is a "United States Government Work" under the
 
8
 *  terms of the United States Copyright Act.  It was written as part of
 
9
 *  the author's offical duties as a United States Government employee and
 
10
 *  thus cannot be copyrighted.  This software/database is freely available
 
11
 *  to the public for use. The National Library of Medicine and the U.S.
 
12
 *  Government have not placed any restriction on its use or reproduction.
 
13
 *
 
14
 *  Although all reasonable efforts have been taken to ensure the accuracy
 
15
 *  and reliability of the software and data, the NLM and the U.S.
 
16
 *  Government do not and cannot warrant the performance or results that
 
17
 *  may be obtained by using this software or data. The NLM and the U.S.
 
18
 *  Government disclaim all warranties, express or implied, including
 
19
 *  warranties of performance, merchantability or fitness for any particular
 
20
 *  purpose.
 
21
 *
 
22
 *  Please cite the author in any work or product based on this material.
 
23
 *
 
24
 * ===========================================================================
 
25
 *
 
26
 * Author: Ilya Dondoshansky
 
27
 *
 
28
 */
 
29
 
 
30
/** @file blast_tback.h
 
31
 * API level functions to do perform traceback stage of the BLAST algorithm
 
32
 */
 
33
 
 
34
#ifndef __BLAST_TBACK__
 
35
#define __BLAST_TBACK__
 
36
 
 
37
#include <algo/blast/core/blast_seqsrc.h>
 
38
#include <algo/blast/core/blast_options.h>
 
39
#include <algo/blast/core/blast_hits.h>
 
40
#include <algo/blast/core/blast_hspstream.h>
 
41
 
 
42
#ifdef __cplusplus
 
43
extern "C" {
 
44
#endif
 
45
 
 
46
/** Perform traceback stage of the BLAST search, given the source of HSP lists,
 
47
 * obtained from the preliminary stage. The parameters internal to the engine
 
48
 * are calculated here independently of the similar calculation in the
 
49
 * preliminary stage, effectively making the two stages independent of each 
 
50
 * other.
 
51
 * @param program BLAST program type [in]
 
52
 * @param query Query sequence(s) structure [in]
 
53
 * @param query_info Additional query information [in]
 
54
 * @param seq_src Source of subject sequences [in]
 
55
 * @param score_options Scoring options [in]
 
56
 * @param ext_options Word extension options, needed for cutoff scores 
 
57
 *                    calculation only [in]
 
58
 * @param hit_options Hit saving options [in]
 
59
 * @param eff_len_options Options for calculating effective lengths [in]
 
60
 * @param db_options Database options (database genetic code) [in]
 
61
 * @param psi_options PSI BLAST options [in]
 
62
 * @param sbp Scoring block with statistical parameters and matrix [in]
 
63
 * @param hsp_stream Source of HSP lists. [in]
 
64
 * @param results Where to save the results after traceback. [out]
 
65
 */
 
66
Int2 
 
67
Blast_RunTracebackSearch(EBlastProgramType program, 
 
68
   BLAST_SequenceBlk* query, BlastQueryInfo* query_info, 
 
69
   const BlastSeqSrc* seq_src, const BlastScoringOptions* score_options,
 
70
   const BlastExtensionOptions* ext_options,
 
71
   const BlastHitSavingOptions* hit_options,
 
72
   const BlastEffectiveLengthsOptions* eff_len_options,
 
73
   const BlastDatabaseOptions* db_options, 
 
74
   const PSIBlastOptions* psi_options, BlastScoreBlk* sbp,
 
75
   BlastHSPStream* hsp_stream, BlastHSPResults** results);
 
76
 
 
77
#ifdef __cplusplus
 
78
}
 
79
#endif
 
80
#endif /* !__BLAST_TBACK__ */