1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
// ==========================================================================
// SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2018, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Knut Reinert or the FU Berlin nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: David Weese <david.weese@fu-berlin.de>
// ==========================================================================
// Bit-packed pair specialization.
// ==========================================================================
#ifndef SEQAN_INCLUDE_SEQAN_BASIC_PAIR_BIT_PACKED_H_
#define SEQAN_INCLUDE_SEQAN_BASIC_PAIR_BIT_PACKED_H_
namespace seqan {
// ============================================================================
// Forwards
// ============================================================================
// ============================================================================
// Tags, Classes, Enums
// ============================================================================
/*!
* @class BitPackedPair
* @extends Pair
* @headerfile <seqan/basic.h>
* @brief Stores two arbitrary objects. Saves memory by packing bits with bit fields.
*
* @signature template <typename T1, typename T2, unsigned BITSIZE1, unsigned BITSIZE2>
* class Pass;
*
* @tparam T1 Type of first entry.
* @tparam T2 Type of second entry.
* @tparam BITSIZE1 Number of bits to store for <tt>T1</tt>.
* @tparam BITSIZE2 Number of bits to store for <tt>T2</tt>.
*
* Useful for external storage.
*
* @section Remarks
*
* Memory access could be slower. Direct access to members by pointers is not allowed.
*
* Functions <tt>value()</tt> is not implemented yet since there it would require using a proxy. Use
* <tt>getValue()</tt>, <tt>assignValue()</tt>, <tt>moveValue()</tt>, <tt>setValue()</tt> instead.
*/
#pragma pack(push,1)
template <typename T1, typename T2, unsigned BITSIZE1, unsigned BITSIZE2>
struct Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> >
{
// ------------------------------------------------------------------------
// Members
// ------------------------------------------------------------------------
T1 i1:BITSIZE1;
T2 i2:BITSIZE2;
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
// bitfield member cannot have an in-class initializer, thus
// `inline Pair() = default;` is not possible
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=65132
inline Pair() : i1(T1{}), i2(T2{}) {};
inline Pair(Pair const &) = default;
inline Pair(Pair &&) = default;
inline Pair & operator=(Pair const &) = default;
inline Pair & operator=(Pair &&) = default;
inline ~Pair() = default;
inline Pair(T1 const & _i1, T2 const & _i2) : i1(_i1), i2(_i2) {}
template <typename T1_, typename T2_, typename TSpec__>
// TODO(holtgrew): explicit?
inline Pair(Pair<T1_, T2_, TSpec__> const &_p) :
i1(getValueI1(_p)), i2(getValueI2(_p))
{}
};
#pragma pack(pop)
// ============================================================================
// Metafunctions
// ============================================================================
// ============================================================================
// Functions
// ============================================================================
// ----------------------------------------------------------------------------
// Function set().
// ----------------------------------------------------------------------------
// References to members to packed structs do not work. Always copy.
template <typename T1, typename T2, unsigned BITSIZE1, unsigned BITSIZE2>
inline void
set(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & p1, Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & p2)
{
p1 = p2;
}
// ----------------------------------------------------------------------------
// Function move().
// ----------------------------------------------------------------------------
// References to members to packed structs do not work. Always copy.
template <typename T1, typename T2, unsigned BITSIZE1, unsigned BITSIZE2>
inline void
move(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & p1, Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & p2)
{
p1 = p2;
}
// -----------------------------------------------------------------------
// Function setValueIX()
// -----------------------------------------------------------------------
// Cannot be setValue with index since T1 can be != T2.
template <typename T1, typename T2, typename T, unsigned BITSIZE1, unsigned BITSIZE2>
inline void setValueI1(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & pair, T const & _i)
{
pair.i1 = _i;
}
template <typename T1, typename T2, typename T, unsigned BITSIZE1, unsigned BITSIZE2>
inline void setValueI2(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & pair, T const & _i)
{
pair.i2 = _i;
}
// -----------------------------------------------------------------------
// Function moveValueIX()
// -----------------------------------------------------------------------
// Cannot be moveValue with index since T1 can be != T2.
template <typename T1, typename T2, typename T, unsigned BITSIZE1, unsigned BITSIZE2>
inline void moveValueI1(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & pair, T & _i)
{
pair.i1 = _i;
}
template <typename T1, typename T2, typename T, unsigned BITSIZE1, unsigned BITSIZE2>
inline void moveValueI2(Pair<T1, T2, BitPacked<BITSIZE1, BITSIZE2> > & pair, T & _i)
{
pair.i2 = _i;
}
} // namespace seqan
#endif // #ifndef SEQAN_INCLUDE_SEQAN_BASIC_PAIR_BIT_PACKED_H_
|
