multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
multireglimit.hh
Go to the documentation of this file.
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 MULTOVL_MULTIREGLIMIT_HEADER
36 #define MULTOVL_MULTIREGLIMIT_HEADER
37 
38 // == Header multireglimit.hh ==
39 
44 
45 // -- System headers --
46 
47 // -- Boost headers --
48 
49 #include "boost/serialization/set.hpp"
50 
51 // -- Own headers --
52 
53 #include "reglimit.hh"
54 
55 // == Classes ==
56 
57 namespace multovl {
58 
65 {
66 public:
67 
68  typedef std::multiset<RegLimit> reglim_t;
69 
70  // -- methods --
71 
73  MultiRegLimit(): _reglim() {}
74 
76  MultiRegLimit(const Region& region, unsigned int trackid):
77  _reglim()
78  {
79  add(region, trackid);
80  }
81 
85  MultiRegLimit(const MultiRegLimit& other);
86 
90 
91  virtual ~MultiRegLimit() {}
92 
97  void add(const Region& region, unsigned int trackid);
98 
100  const reglim_t& reglim() const { return _reglim; }
101 
106 
107 protected:
108 
110  reglim_t& nonconst_reglim() { return _reglim; }
111 
112 private:
113 
114  static
115  void deep_copy(const reglim_t& source, reglim_t& target);
116 
117  // data
118  reglim_t _reglim;
119 
120  // serialization
121  friend class boost::serialization::access;
122  template <class Archive>
123  void serialize(Archive& ar, const unsigned int version)
124  {
125  ar & _reglim;
126  }
127 
128 };
129 
130 } // namespace multovl
131 
132 #endif // MULTOVL_MULTIREGLIMIT_HEADER
reglim_t & nonconst_reglim()
Definition: multireglimit.hh:110
MultiRegLimit(const Region &region, unsigned int trackid)
Init to contain a region and trackid.
Definition: multireglimit.hh:76
const reglim_t & reglim() const
Definition: multireglimit.hh:100
MultiRegLimit()
Init to empty.
Definition: multireglimit.hh:73
void add(const Region &region, unsigned int trackid)
MultiRegLimit & operator=(const MultiRegLimit &rhs)
Definition: multireglimit.hh:64
Instances of the Region class represent regions on a sequence. They have first and last coordinates...
Definition: region.hh:65
MultiRegLimit & operator+=(const MultiRegLimit &rhs)
Helper class to keep track of the limits (first, last position) of regions to be overlapped.