File: RollingKthVisitor.hpp

package info (click to toggle)
bedops 2.4.41%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 21,148 kB
  • sloc: ansic: 28,562; cpp: 15,359; sh: 2,704; makefile: 2,687; xml: 1,669; python: 1,582; csh: 823; perl: 365; java: 172
file content (154 lines) | stat: -rw-r--r-- 4,757 bytes parent folder | download | duplicates (2)
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
/*
  Author: Shane Neph & Scott Kuehn
  Date:   Mon Aug 20 14:22:38 PDT 2007
*/
//
//    BEDOPS
//    Copyright (C) 2011-2022 Shane Neph, Scott Kuehn and Alex Reynolds
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License along
//    with this program; if not, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//

#ifndef ROLLING_KTH_VISITOR_HPP
#define ROLLING_KTH_VISITOR_HPP

#include <cmath>
#include <cstdlib>
#include <set>
#include <string>

#include "data/measurement/NaN.hpp"
#include "data/measurement/SelectMeasureType.hpp"
#include "utility/Assertion.hpp"
#include "utility/Exception.hpp"
#include "utility/OrderCompare.hpp"

namespace Visitors {

  template <
            typename Process,
            typename BaseVisitor,
            typename ExceptionType = Ext::ArgumentError
           >
  struct RollingKth : BaseVisitor {

    typedef BaseVisitor BaseClass;
    typedef Process ProcessType;
    typedef typename BaseClass::RefType RefType;
    typedef typename BaseClass::MapType MapType;
    typedef MapType* PtrType;

    //==============
    // Construction
    //==============
    explicit RollingKth(double kth = 0.8, const ProcessType& pt = ProcessType())
        : kthValue_(kth), currentAtPos_(0), pt_(pt) {
      currentMarker_ = scoresBuf_.end();
      Ext::Assert<ExceptionType>(kth >= 0 && kth <= 1, "Expect 0 <= kth <= 1");
    }

    //======================================
    // Windowing Phase : Add() and Delete()
    //======================================
    inline void Add(PtrType ptr) {
      static Comp comp;
      scoresBuf_.insert(ptr);
      if ( currentMarker_ == scoresBuf_.end() ) {
        currentMarker_ = scoresBuf_.begin();
        currentAtPos_ = 0;
      }
      else if ( comp(ptr, *currentMarker_) ) // ptr < currentMarker_
        ++currentAtPos_;
    }

    inline void Delete(PtrType toRemove) {
      // keep in mind that you cannot be here if there is <= 1 element
      //  in the scoresBuf_ containers.
      static Comp comp;
      if ( comp(toRemove, *currentMarker_) ) // toRemove < currentMarker_
        --currentAtPos_;
      else if ( toRemove == *currentMarker_ ) { // removing currentMarker_
        if ( currentMarker_ != scoresBuf_.begin() ) {
          --currentMarker_;
          --currentAtPos_;
        }
        else {
          ++currentMarker_;
            // currentAtPos_ remains the same
        }
      }
      scoresBuf_.erase(toRemove);
    }

    //====================================
    // Repositioning and Reporting Phases
    //====================================
    inline void DoneReference() {
      // guaranteed: 0 < kthValue <= 1
      typedef typename Signal::SelectMeasure<MapType>::MeasureType MT;
      std::size_t size = scoresBuf_.size();
      std::size_t kthPos = static_cast<std::size_t>(iround(kthValue_ * size));
      if ( kthPos > 0 ) // make zero based
        --kthPos;

      while ( kthPos > currentAtPos_ ) { // need to increment currentMarker_
        ++currentMarker_;
        ++currentAtPos_;
      } // while incrementing

      while ( kthPos < currentAtPos_ ) { // need to decrement currentMarker_
        currentMarker_--;
        --currentAtPos_;
      } // while decrementing

      if ( size )
        pt_.operator()(static_cast<MT>(**currentMarker_));
      else {
        static const Signal::NaN nan = Signal::NaN();
        pt_.operator()(nan);
      }
    }

    //===========
    // Cleanup()
    //===========
    virtual ~RollingKth()
      { /* */ }

  protected:
    typedef Ordering::CompValueThenAddressLesser<MapType, MapType> Comp;
    typedef std::set<PtrType, Comp> ScoreTypeContainer;

  protected:
    const double kthValue_;
    std::size_t currentAtPos_;
    ProcessType pt_;
    ScoreTypeContainer scoresBuf_;
    typename ScoreTypeContainer::iterator currentMarker_;

  protected:
    inline double iround(double d) {
      double d1 = std::ceil(d);
      return( (d >= 0) ?
              ((d1-d > 0.5) ? std::floor(d) : d1)
                       :
              ((d1-d >= 0.5) ? std::floor(d) : d1)
            );
    }
  };

} // namespace Visitors

#endif // ROLLING_KTH_VISITOR_HPP