summaryrefslogtreecommitdiff
path: root/algo/blast/core/blast_program.c
blob: 009a5fb2207360f6270acf8100cbce1b2c2520fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#ifndef SKIP_DOXYGEN_PROCESSING
static char const rcsid[] =
    "$Id: blast_program.c,v 1.3 2005/11/16 14:27:03 madden Exp $";
#endif /* SKIP_DOXYGEN_PROCESSING */
/* ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Christiam Camacho / Ilya Dondoshansky
 *
 */

/** @file blast_program.c
 * Implementation auxiliary functions to determine traits of the various BLAST
 * programs supported by core BLAST
 */
    
#include <algo/blast/core/blast_program.h>

#define SAFE_CAST_INT_TO_BOOLEAN(p) (((p) != 0) ? TRUE : FALSE)

/* Classify query sequence */
Boolean Blast_QueryIsProtein(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PROTEIN_QUERY_MASK); }

Boolean Blast_QueryIsNucleotide(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & NUCLEOTIDE_QUERY_MASK); }

Boolean Blast_QueryIsPssm(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PSSM_QUERY_MASK); }

/* Classify subject sequence */
Boolean Blast_SubjectIsProtein(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PROTEIN_SUBJECT_MASK); }

Boolean Blast_SubjectIsNucleotide(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & NUCLEOTIDE_SUBJECT_MASK); }

Boolean Blast_SubjectIsPssm(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PSSM_SUBJECT_MASK); }

/* Handle translated searches */
Boolean Blast_QueryIsTranslated(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & TRANSLATED_QUERY_MASK); }

Boolean Blast_SubjectIsTranslated(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & TRANSLATED_SUBJECT_MASK); }

/* Handle special programs */
Boolean Blast_ProgramIsPsiBlast(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PSSM_QUERY_MASK); }

Boolean Blast_ProgramIsPhiBlast(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PATTERN_QUERY_MASK); }

Boolean Blast_ProgramIsRpsBlast(EBlastProgramType p)
{ return SAFE_CAST_INT_TO_BOOLEAN(p & PSSM_SUBJECT_MASK); }