NCBI C Toolkit Cross Reference

C/algo/blast/api/dust_filter.h

  1 /* $Id: dust_filter.h,v 1.1 2005/07/19 14:16:54 madden 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 official 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: Tom Madden
 27 *
 28 */
 29 
 30 /** @file dust_filter.h
 31 * Dust filtering API for the C version of rewritten BLAST engine.
 32 */
 33 
 34 #ifndef _DUST_FILTER_ 
 35 #define _DUST_FILTER_ 
 36 
 37 #ifdef __cplusplus
 38 extern "C" {
 39 #endif
 40 
 41 #include <objloc.h>
 42 #include <algo/blast/api/blast_options_api.h>
 43 
 44 /** @addtogroup CToolkitAlgoBlast
 45  *
 46  * @{
 47  */
 48 
 49 /** Finds dust filtering locations.
 50  * Does nothing if dust filtering is not required.
 51  * @param query_seqloc List of query locations [in]
 52  * @param options object containing dust filter options [in]
 53  * @param mask_loc List of dust mask locations [out]
 54  * @return Status.
 55  */
 56 Int2
 57 Blast_FindDustSeqLoc(SeqLoc* query_seqloc,
 58                              const SBlastOptions* options,
 59                              SeqLoc* *mask_loc);
 60 
 61 /* @} */
 62 
 63 #ifdef __cplusplus
 64 }
 65 #endif
 66 
 67 #endif
 68
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
This page was automatically generated by the LXR engine.
Visit the LXR main site for more information.