File: pipe_namer.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 (149 lines) | stat: -rw-r--r-- 5,150 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
149
// ==========================================================================
//                 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_HEADER_PIPE_NAMER_H
#define SEQAN_HEADER_PIPE_NAMER_H

namespace seqan2
{

//namespace seqan2_NAMESPACE_PIPELINING
//{

    template < typename TCompare >
    struct Namer;

    template < typename TInput, typename TCompare >
    struct Value< Pipe< TInput, Namer<TCompare> > >
    {
        typedef Pair<
            typename Value<typename Value<TInput>::Type, 1>::Type,
            typename Size<TInput>::Type,
            Pack
        > Type;
    };

/*!
 * @class Namer
 * @extends Pipe
 * @headerfile <seqan/pipe.h>
 *
 * @brief Extends the input stream by a second field which names the elements.
 *
 * @signature template <typename TInput, typename TCompare>
 *            class Pipe<TInput, Namer<TCompare> >;
 *
 * @tparam TInput   The type of the pipeline module this module reads from.
 * @tparam TCompare A function (see STL's <tt>function</tt>) with result type <tt>int</tt>.  Should
 *                  return <tt>0</tt> if and only if two elements are equal.
 *
 * The output type is a Pair of input type and size type (i.e. <tt>Pair&lt;Value&lt;TInput&gt;::Type, Size&lt;TInput&gt;::Type&gt;</tt>).
 *
 * The first output field is the original input stream.
 *
 * The second output field is the name. This field begins with 0 and increases by 1 for every distinct element. Two
 * elements gets the same name, if and only if they are equal.
 */

    //////////////////////////////////////////////////////////////////////////////
    // namer class
    template < typename TInput, typename TCompare >
    struct Pipe< TInput, Namer<TCompare> >
    {
        TInput                          &in;
        TCompare                        C;
        typename Value<Pipe>::Type      tmp;
        typename Value<TInput>::Type    last;

/*!
 * @fn Namer::Pipe
 * @brief Constructor
 *
 * @signature Pipe::Pipe(in[, comp]);
 *
 * @param[in] in   Reference to an input pipe.
 * @param[in] comp A <tt>TCompare</tt> object (copied).
 */

        Pipe(TInput& _in):
            in(_in) {}

        Pipe(TInput& _in, const TCompare& tmpC) :
            in(_in),
            C(tmpC) {}

        inline typename Value<Pipe>::Type const & operator*()
        {
            tmp.i1 = getValueI1(*in);
            return tmp;
        }

        inline Pipe& operator++()
        {
            ++in;
            if (!eof(in) && C(last, *in) != 0) {
                SEQAN_ASSERT_LT(C(last, *in), 0);
                last = *in;
                ++tmp.i2;
            }
            return *this;
        }

        bool unique() const
        {
            return tmp.i2 == (length(in) - 1);
        }
    };


    //////////////////////////////////////////////////////////////////////////////
    // global pipe functions
    template < typename TInput, typename TCompare >
    inline bool control(Pipe< TInput, Namer<TCompare> > &me, ControlBeginRead const &command)
    {
        if (!control(me.in, command)) return false;
        if (!eof(me.in))
        {
            me.last = *me.in;
            me.tmp.i1 = me.last.i1;
        }
        me.tmp.i2 = 0;
        return true;
    }

//}

}

#endif