NCBI C++ ToolKit
blastkmeroptions.cpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id: blastkmeroptions.cpp 77917 2017-05-15 16:07:54Z madden $
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  * File Description:
29  * Options for BLAST-kmer searches
30  *
31  */
32 
33 #include <ncbi_pch.hpp>
35 
37 
39  : m_Thresh(0.10),
40  m_MinHits(1),
41  m_NumTargetSeqs(500)
42 {
43 }
44 
45 bool
47 {
48  if (m_Thresh <= 0.0 || m_Thresh > 1.0)
49  return false;
50 
51  if (m_MinHits < 0)
52  return false;
53 
54  if (m_NumTargetSeqs < 0)
55  return false;
56 
57  return true;
58 }
59 
61 
int m_NumTargetSeqs
Number of matches to return.
CBlastKmerOptions()
Constructor.
bool Validate() const
Checks that options are valid.
int m_MinHits
Value of number of LSH hits to initiate the calculation of the Jaccard distance.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Modified on Thu May 23 12:35:23 2024 by modify_doxy.py rev. 669887