← Back to branch summary

~ubuntu-branches/ubuntu/edgy/ncbi-tools6/edgy

« back to all changes in this revision

Viewing changes to tools/readdb.h

  • Committer: Bazaar Package Importer
  • Author(s): Barry deFreese
  • Date: 2006-07-19 23:28:07 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20060719232807-et3cdmcjgmnyleyx
Tags: 6.1.20060507-3ubuntu1
Re-merge with Debian

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/readdb.h
41
41
*
42
42
* Version Creation Date:   3/21/95
43
43
*
44
 
* $Revision: 6.164 $
 
44
* $Revision: 6.169 $
45
45
*
46
46
* File Description: 
47
47
*       Functions to rapidly read databases from files produced by formatdb.
56
56
*
57
57
* RCS Modification History:
58
58
* $Log: readdb.h,v $
 
59
* Revision 6.169  2006/04/24 15:50:19  camacho
 
60
* + is_REFSEQ_RNA
 
61
*
 
62
* Revision 6.168  2006/03/16 14:14:24  camacho
 
63
* Fix parsing of locations for fastacmd command line argument (rt # 15151399)
 
64
*
 
65
* Revision 6.167  2006/03/09 21:56:02  camacho
 
66
* Refactored sequence hash function
 
67
*
 
68
* Revision 6.166  2006/03/08 19:06:14  camacho
 
69
* Added definition for maximum number of volumes, fixes rt ticket 15147600
 
70
*
 
71
* Revision 6.165  2006/02/15 21:07:29  camacho
 
72
* Add validation to fastacmd to reject mixed protein/nucleotide databases
 
73
*
59
74
* Revision 6.164  2005/10/04 20:40:50  madden
60
75
* Make PrintDbInformationBasicEx public
61
76
*
1410
1425
*/
1411
1426
Boolean LIBCALL readdb_get_filebits PROTO((ReadDBFILEPtr rdfp, Int4 ordinal_id, Uint2Ptr filebit, Uint2Ptr aliasfilebit));
1412
1427
 
 
1428
/* Possible return values for readdb_validate */
 
1429
 
 
1430
#define READDB_VALID 0
 
1431
#define READDB_INVALID_NULL_ARG -1
 
1432
#define READDB_INVALID_MIXED_DBS -2
 
1433
 
 
1434
/* Validate the linked list of rdfp structures passed as an argument to this
 
1435
 * function.
 
1436
 * Return 
 
1437
 * list or if the argument is NULL, otherwise returns TRUE
 
1438
 */
 
1439
Int4 LIBCALL readdb_validate PROTO((ReadDBFILEPtr rdfp));
 
1440
 
 
1441
/** Calculate a hash value for a given sequence data 
 
1442
 * @param sequence containing sequence data (must not be NULL) [in]
 
1443
 * @param sequence_length length of the buffer above populated with data [in]
 
1444
 */
 
1445
Uint4 readdb_sequence_hash(const char* sequence, int sequence_length);
 
1446
 
1413
1447
/* For the BioseqFetch functions. */
1414
1448
 
1415
1449
Boolean LIBCALL ReadDBBioseqFetchEnable PROTO((CharPtr program, CharPtr dbname, Boolean is_na, Boolean now));
1587
1621
   EFDBCleanOpt clean_opt;      /* clean up option */
1588
1622
 
1589
1623
} FDB_options, PNTR FDB_optionsPtr;
 
1624
 
 
1625
/** Maximum number of volumes constructed by formatdb */
 
1626
extern const Uint4 kFDBMaxNumVolumes;
1590
1627
    
1591
1628
typedef struct formatdb 
1592
1629
{
1802
1839
Boolean is_MONTH(VoidPtr di_record);
1803
1840
Boolean is_PDB(VoidPtr di_record);
1804
1841
Boolean is_REFSEQ(VoidPtr di_record);
 
1842
Boolean is_REFSEQ_RNA(VoidPtr di_record);
1805
1843
Boolean is_CONTIG(VoidPtr di_record);
1806
1844
 
1807
1845
/************************************************************************/
1845
1883
    CharPtr seqlocstr, Uint1 strand, Boolean taxonomy_info_only, 
1846
1884
    Boolean dbinfo_only, Int4 pig);
1847
1885
 
 
1886
/** Parses the string passed as its first argument, which should contain a pair
 
1887
 * of positive integers separated by ' ', ',', or ';' and returns the integers
 
1888
 * in the second argument. This function is non-static so that unit tests can
 
1889
 * be written for it.
 
1890
 */
 
1891
void Fastacmd_ParseLocations(const char* str, Int4 locations[2]);
 
1892
 
1848
1893
/**
1849
1894
 * @param rdfp Blast database handle [in]
1850
1895
 * @param fp output FILE pointer [in]