multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
parprobopts.hh
1 /* <LICENSE>
2 License for the MULTOVL multiple genomic overlap tools
3 
4 Copyright (c) 2007-2012, Dr Andras Aszodi,
5 Campus Science Support Facilities GmbH (CSF),
6 Dr-Bohr-Gasse 3, A-1030 Vienna, Austria, Europe.
7 All rights reserved.
8 
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are
11 met:
12 
13  * Redistributions of source code must retain the above copyright notice,
14  this list of conditions and the following disclaimer.
15  * Redistributions in binary form must reproduce the above copyright notice,
16  this list of conditions and the following disclaimer in the documentation
17  and/or other materials provided with the distribution.
18  * Neither the name of the Campus Science Support Facilities GmbH
19  nor the names of its contributors may be used to endorse
20  or promote products derived from this software without specific prior
21  written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
24 AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
25 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
26 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27 THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
30 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
31 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 </LICENSE> */
35 #ifndef PARPROBOPTS_HEADER
36 #define PARPROBOPTS_HEADER
37 
38 // == HEADER parprobopts.hh ==
39 
47 // -- Base class header --
48 
49 #include "probopts.hh"
50 
51 // == Classes ==
52 
53 namespace multovl {
54 namespace prob {
55 
57 class ParProbOpts : public ProbOpts
58 {
59 public:
60 
62  ParProbOpts();
63 
65  unsigned int threads() const { return _threads; }
66 
67  virtual
68  std::string param_str() const;
69 
70  virtual
71  std::ostream& print_help(std::ostream& out) const;
72 
73 protected:
74 
75  virtual
76  bool check_variables();
77 
78 private:
79 
80  static
81  unsigned int core_count();
82  static const unsigned int DEFAULT_THREADS;
83  unsigned int _threads;
84 };
85 
86 } // namespace prob
87 } // namespace multovl
88 
89 #endif // PROBOPTS_HEADER
90 
virtual bool check_variables()
unsigned int threads() const
Definition: parprobopts.hh:65
Option handling for the file-based multovl tools.
Definition: probopts.hh:57
virtual std::ostream & print_help(std::ostream &out) const
Option handling for the file-based parallel overlap probability tool.
Definition: parprobopts.hh:57