File: fundamental_chunking.h

package info (click to toggle)
seqan2 2.5.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 228,748 kB
  • sloc: cpp: 257,602; ansic: 91,967; python: 8,326; sh: 1,056; xml: 570; makefile: 229; awk: 51; javascript: 21
file content (148 lines) | stat: -rw-r--r-- 5,336 bytes parent folder | download
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
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2026, 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>
// ==========================================================================

#ifndef SEQAN_INCLUDE_SEQAN_BASIC_BASIC_CHUNKING_H_
#define SEQAN_INCLUDE_SEQAN_BASIC_BASIC_CHUNKING_H_

namespace seqan2 {

// ============================================================================
// Tags
// ============================================================================

// --------------------------------------------------------------------------
// Direction Tags
// --------------------------------------------------------------------------

/*!
 * @defgroup DirectionTags Direction Tags
 * @brief Tags for selecting a direction.
 */

/*!
 * @tag DirectionTags#Input
 * @headerfile <seqan/basic.h>
 * @brief Tag for selecting the input direction.
 *
 * @signature typedef Tag<Input_> Input;
 */

struct Input_;
typedef Tag<Input_> Input;

/*!
 * @tag DirectionTags#Output
 * @headerfile <seqan/basic.h>
 * @brief Tag for selecting the output direction.
 *
 * @signature typedef Tag<Output_> Output;
 */

struct Output_;
typedef Tag<Output_> Output;

/*!
 * @tag DirectionTags#Bidirectional
 * @headerfile <seqan/basic.h>
 * @brief Tag for allowing both input and output.
 *
 * @signature typedef Tag<Bidirectional_> Bidirectional;
 */

struct Bidirectional_;
typedef Tag<Bidirectional_> Bidirectional;

// ============================================================================
// Metafunctions
// ============================================================================

// --------------------------------------------------------------------------
// Metafunction Chunk
// --------------------------------------------------------------------------

/*!
 * @mfn Chunk
 * @headerfile <seqan/basic.h>
 * @brief Return the chunk type for an object.
 *
 * @signature Chunk<TObject>::Type;
 *
 * @tparam TObject The object to query for its chunk type.
 * @return Type    The chunk type of <tt>TObject</tt>.
 *
 * The default result type (if not overloaded) is @link Nothing @endlink.
 */

// Chunking is only supported for selected objects
template <typename TObject>
struct Chunk
{
    typedef Nothing Type;   // disabled by default
};

// ============================================================================
// Functions
// ============================================================================

// ----------------------------------------------------------------------------
// Function reserveChunk()
// ----------------------------------------------------------------------------

template <typename TIterator, typename TSize, typename TDirection>
inline void reserveChunk(TIterator &, TSize, TDirection)
{}

// ----------------------------------------------------------------------------
// Function getChunk()
// ----------------------------------------------------------------------------

template <typename TChunk, typename TIterator, typename TDirection>
inline Nothing getChunk(TChunk &, TIterator &, TDirection)
{
    return Nothing();
}

// ----------------------------------------------------------------------------
// Function advanceChunk()
// ----------------------------------------------------------------------------

template <typename TIterator, typename TSize>
inline void advanceChunk(TIterator &iter, TSize size)
{
    iter += size;
}

}  // namespace seqan2

#endif  // #ifndef SEQAN_INCLUDE_SEQAN_BASIC_BASIC_CHUNKING_H_