开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
blast_setup.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：10k
源码类别：

生物技术

开发平台：

C/C++

blast_setup.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_setup.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:05:55  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.21
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: blast_setup.hpp,v 1000.2 2004/06/01 18:05:55 gouriano Exp $
  11.  * ===========================================================================
  12.  *
  13.  *                            PUBLIC DOMAIN NOTICE
  14.  *               National Center for Biotechnology Information
  15.  *
  16.  *  This software/database is a "United States Government Work" under the
  17.  *  terms of the United States Copyright Act.  It was written as part of
  18.  *  the author's official duties as a United States Government employee and
  19.  *  thus cannot be copyrighted.  This software/database is freely available
  20.  *  to the public for use. The National Library of Medicine and the U.S.
  21.  *  Government have not placed any restriction on its use or reproduction.
  22.  *
  23.  *  Although all reasonable efforts have been taken to ensure the accuracy
  24.  *  and reliability of the software and data, the NLM and the U.S.
  25.  *  Government do not and cannot warrant the performance or results that
  26.  *  may be obtained by using this software or data. The NLM and the U.S.
  27.  *  Government disclaim all warranties, express or implied, including
  28.  *  warranties of performance, merchantability or fitness for any particular
  29.  *  purpose.
  30.  *
  31.  *  Please cite the author in any work or product based on this material.
  32.  *
  33.  * ===========================================================================
  34.  *
  35.  * Author:  Christiam Camacho
  36.  *
  37.  */
  39. /** @file blast_setup.hpp
  40.  * Auxiliary setup functions for Blast objects interface
  41.  */
  43. #ifndef ALGO_BLAST_API___BLAST_SETUP__HPP
  44. #define ALGO_BLAST_API___BLAST_SETUP__HPP
  46. #include <algo/blast/api/blast_types.hpp>
  47. #include <algo/blast/api/blast_aux.hpp>
  48. #include <algo/blast/core/blast_options.h>
  49. #include <algo/blast/api/blast_exception.hpp>
  51. BEGIN_NCBI_SCOPE
  53. BEGIN_SCOPE(objects)
  54.     class CSeq_loc;
  55.     class CScope;
  56. END_SCOPE(objects)
  58. BEGIN_SCOPE(blast)
  59. class CBlastOptions;
  61. void
  62. SetupQueryInfo(const TSeqLocVector& queries, const CBlastOptions& options, 
  63.                BlastQueryInfo** qinfo); // out
  65. void
  66. SetupQueries(const TSeqLocVector& queries, const CBlastOptions& options,
  67.              const CBlastQueryInfo& qinfo, BLAST_SequenceBlk** seqblk);
  69. void
  70. SetupSubjects(const TSeqLocVector& subjects, 
  71.               EProgram program,
  72.               vector<BLAST_SequenceBlk*>* seqblk_vec, 
  73.               unsigned int* max_subjlen);
  75. /// Allows specification of whether sentinel bytes should be used or not
  76. enum ESentinelType {
  77.     eSentinels,
  78.     eNoSentinels
  79. };
  81. /** Retrieves a sequence using the object manager
  82.  * @param sl seqloc of the sequence to obtain [in]
  83.  * @param encoding encoding for the sequence retrieved.
  84.  *        Supported encodings include: NCBI2NA_ENCODING, NCBI4NA_ENCODING,
  85.  *        BLASTNA_ENCODING, and BLASTP_ENCODING. [in]
  86.  * @param scope Scope from which the sequences are retrieved [in]
  87.  * @param strand strand to retrieve (applies to nucleotide only).
  88.  *        N.B.: When requesting the NCBI2NA_ENCODING, only the plus strand
  89.  *        is retrieved, because BLAST only requires one strand on the subject
  90.  *        sequences (as in BLAST databases). [in]
  91.  * @param sentinel Use eSentinels to guard nucleotide sequence with sentinel 
  92.  *        bytes (ignored for protein sequences, which always have sentinels) 
  93.  *        When using NCBI2NA_ENCODING, this argument should be set to
  94.  *        eNoSentinels as a sentinel byte cannot be represented in this 
  95.  *        encoding. [in]
  96.  * @return pair containing the buffer and its length. 
  97.  */
  98. pair<AutoPtr<Uint1, CDeleter<Uint1> >, TSeqPos>
  99. GetSequence(const objects::CSeq_loc& sl, Uint1 encoding, 
  100.             objects::CScope* scope,
  101.             objects::ENa_strand strand = objects::eNa_strand_plus, 
  102.             ESentinelType sentinel = eSentinels)
  103.             THROWS((CBlastException, CException));
  105. /** Calculates the length of the buffer to allocate given the desired encoding,
  106.  * strand (if applicable) and use of sentinel bytes around sequence
  107.  * @param sequence_length Length of the sequence [in]
  108.  * @param encoding Desired encoding for calculation (supported encodings are
  109.  *        listed in GetSequence()) [in]
  110.  * @param strand Which strand to use for calculation [in]
  111.  * @param sentinel Whether to include or not sentinels in calculation. Same
  112.  *        criteria as GetSequence() applies [in]
  113.  * @return Length of the buffer to allocate to contain original sequence of
  114.  *        length sequence_length for given encoding and parameter constraints
  115.  */
  116. TSeqPos
  117. CalculateSeqBufferLength(TSeqPos sequence_length, Uint1 encoding,
  118.                          objects::ENa_strand strand =
  119.                          objects::eNa_strand_unknown,
  120.                          ESentinelType sentinel = eSentinels)
  121.                          THROWS((CBlastException));
  123. /** Convenience function to centralize the knowledge of which sentinel bytes we
  124.  * use for supported encodings. Note that only BLASTP_ENCODING,
  125.  * BLASTNA_ENCODING, and NCBI4NA_ENCODING support sentinel bytes, any other
  126.  * values for encoding will cause an exception to be thrown.
  127.  * @param encoding Encoding for which a sentinel byte is needed [in]
  128.  * @return sentinel byte
  129.  */
  130. Uint1 GetSentinelByte(Uint1 encoding) THROWS((CBlastException));
  132. #if 0
  133. // not used right now
  134. /** Translates nucleotide query sequences to protein in the requested frame
  135.  * @param nucl_seq forward (plus) strand of the nucleotide sequence [in]
  136.  * @param nucl_seq_rev reverse (minus) strand of the nucleotide sequence [in]
  137.  * @param nucl_length length of a single strand of the nucleotide sequence [in]
  138.  * @param frame frame to translate, allowed values: 1,2,3,-1,-2,-3 [in]
  139.  * @param translation buffer to hold the translation, should be allocated
  140.  * outside this function [out]
  141.  */
  142. void
  143. BLASTGetTranslation(const Uint1* nucl_seq, const Uint1* nucl_seq_rev, 
  144.                     const int nucl_length, const short frame, Uint1* translation);
  145. #endif
  147. /** Retrieves the requested genetic code in Ncbistdaa format. 
  148.  * @param genetic_code numeric identifier for genetic code requested [in]
  149.  */
  150. AutoPtr<Uint1, ArrayDeleter<Uint1> >
  151. FindGeneticCode(int genetic_code);
  153. /** Returns the path (including a trailing path separator) to the location
  154.  * where the matrix can be found.
  155.  * @param matrix_name matrix to search for
  156.  * @param is_prot true if this is a protein matrix
  157.  */
  158. string
  159. FindMatrixPath(const char* matrix_name, bool is_prot);
  161. /** Returns the path (including a trailing path separator) to the location
  162.  * where the BLAST database can be found.
  163.  * @param dbname Database to search for
  164.  * @param is_prot true if this is a protein matrix
  165.  */
  166. string
  167. FindBlastDbPath(const char* dbname, bool is_prot);
  169. /** Returns the number of frames for a given BLAST program
  170.  * @param p program 
  171.  */
  172. unsigned int 
  173. GetNumberOfFrames(EProgram p);
  175. END_SCOPE(blast)
  176. END_NCBI_SCOPE
  178. /*
  179. * ===========================================================================
  180. *
  181. * $Log: blast_setup.hpp,v $
  182. * Revision 1000.2  2004/06/01 18:05:55  gouriano
  183. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.21
  184. *
  185. * Revision 1.21  2004/05/19 14:52:01  camacho
  186. * 1. Added doxygen tags to enable doxygen processing of algo/blast/core
  187. * 2. Standardized copyright, CVS $Id string, $Log and rcsid formatting and i
  188. *    location
  189. * 3. Added use of @todo doxygen keyword
  190. *
  191. * Revision 1.20  2004/04/06 20:45:28  dondosha
  192. * Added function FindBlastDbPath: should be moved to seqdb library
  193. *
  194. * Revision 1.19  2004/03/15 19:57:52  dondosha
  195. * SetupSubjects takes just program argument instead of CBlastOptions*
  196. *
  197. * Revision 1.18  2004/03/06 00:39:47  camacho
  198. * Some refactorings, changed boolen parameter to enum in GetSequence
  199. *
  200. * Revision 1.17  2003/12/29 17:03:47  camacho
  201. * Added documentation to GetSequence
  202. *
  203. * Revision 1.16  2003/10/29 04:45:58  camacho
  204. * Use fixed AutoPtr for GetSequence return value
  205. *
  206. * Revision 1.15  2003/09/12 17:52:42  camacho
  207. * Stop using pair<> as return value from GetSequence
  208. *
  209. * Revision 1.14  2003/09/11 20:55:01  camacho
  210. * Temporary fix for AutoPtr return value
  211. *
  212. * Revision 1.13  2003/09/11 17:45:03  camacho
  213. * Changed CBlastOption -> CBlastOptions
  214. *
  215. * Revision 1.12  2003/09/10 04:25:28  camacho
  216. * Minor change to return type of GetSequence
  217. *
  218. * Revision 1.11  2003/09/09 15:57:23  camacho
  219. * Fix indentation
  220. *
  221. * Revision 1.10  2003/09/09 12:57:15  camacho
  222. * + internal setup functions, use smart pointers to handle memory mgmt
  223. *
  224. * Revision 1.9  2003/08/28 22:43:02  camacho
  225. * Change BLASTGetSequence signature
  226. *
  227. * Revision 1.8  2003/08/19 13:45:21  dicuccio
  228. * Removed 'USING_SCOPE(objects)'.  Changed #include guards to be standards
  229. * compliant.  Added 'objects::' where necessary.
  230. *
  231. * Revision 1.7  2003/08/18 20:58:56  camacho
  232. * Added blast namespace, removed *__.hpp includes
  233. *
  234. * Revision 1.6  2003/08/11 19:55:04  camacho
  235. * Early commit to support query concatenation and the use of multiple scopes.
  236. * Compiles, but still needs work.
  237. *
  238. * Revision 1.5  2003/08/11 13:58:51  dicuccio
  239. * Added export specifiers.  Fixed problem with unimplemented private copy ctor
  240. * (truly make unimplemented)
  241. *
  242. * Revision 1.4  2003/08/01 22:35:02  camacho
  243. * Added function to get matrix path (fixme)
  244. *
  245. * Revision 1.3  2003/07/30 15:00:01  camacho
  246. * Do not use Malloc/MemNew/MemFree
  247. *
  248. * Revision 1.2  2003/07/23 21:29:06  camacho
  249. * Update BLASTFindGeneticCode to get genetic code string with C++ toolkit
  250. *
  251. * Revision 1.1  2003/07/10 18:34:19  camacho
  252. * Initial revision
  253. *
  254. *
  255. * ===========================================================================
  256. */
  258. #endif  /* ALGO_BLAST_API___BLAST_SETUP__HPP */