source: branches/help/CORE/pos_range.h

// =============================================================== //
//                                                                 //
//   File      : pos_range.h                                       //
//   Purpose   : range of positions (e.g. part of seq)             //
//                                                                 //
//   Coded by Ralf Westram (coder@reallysoft.de) in October 2011   //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#ifndef POS_RANGE_H
#define POS_RANGE_H

#ifndef ARB_ASSERT_H
#include <arb_assert.h>
#endif
#ifndef ATTRIBUTES_H
#include <attributes.h>
#endif
#ifndef _GLIBCXX_ALGORITHM
#include <algorithm>
#endif
#ifndef ARBTOOLS_H
#include <arbtools.h>
#endif

class PosRange { // this is a value-class (i.e. all methods apart from ctors have to be const)
    int start_pos;
    int end_pos;

public:
    PosRange() : start_pos(-1), end_pos(-2) {} // default is empty range
    PosRange(int From, int to)
        : start_pos(From<0 ? 0 : From)
    {
        if (to<0) end_pos = -2;
        else {
            if (start_pos>to) { // empty range
                start_pos = -1;
                end_pos = -2;
            }
            else {
                end_pos = to;
                arb_assert(start_pos <= end_pos);
            }
        }
    }

    // factory functions
    static PosRange empty() { return PosRange(); }
    static PosRange whole() { return from(0); }

    static PosRange from(int pos) { return PosRange(pos, -1); } static PosRange after(int pos) { return from(pos+1); }
    static PosRange till(int pos) { return PosRange(0, pos); }  static PosRange prior(int pos) { return till(pos-1); }

    int start() const {
        arb_assert(!is_empty());
        return start_pos;
    }
    int end() const {
        arb_assert(has_end());
        return end_pos;
    }

    int size() const { return end_pos-start_pos+1; }

    bool is_whole() const { return start_pos == 0 && end_pos<0; }
    bool is_empty() const { return size() == 0; }
    bool is_part() const { return !(is_empty() || is_whole()); }

    bool has_end() const { return size() > 0; }

    bool is_limited() const { return is_empty() || has_end(); }
    bool is_unlimited() const { return !is_limited(); }

    bool operator == (const PosRange& other) const { return start_pos == other.start_pos && end_pos == other.end_pos; }
    bool operator != (const PosRange& other) const { return !(*this == other); }

    void copy_corresponding_part(char *dest, const char *source, size_t source_len) const;
    char *dup_corresponding_part(const char *source, size_t source_len) const;

    bool contains(int pos) const {
        return !is_empty() && pos >= start_pos && (pos <= end_pos || is_unlimited());
    }
    bool contains(const PosRange& other) const;

    PosRange after() const { return has_end() ? after(end()) : empty(); }
    PosRange prior() const { return !is_empty() && start() ? prior(start()) : empty(); }

#if defined(DEBUG)
    void dump(FILE *out) const {
        fprintf(out, "[%i..%i]", start_pos, end_pos);
    }
#endif
};

inline PosRange intersection(PosRange r1, PosRange r2) {
    if (r1.is_empty()) return r1;
    if (r2.is_empty()) return r2;

    int start = std::max(r1.start(), r2.start());
    if (r1.is_limited()) {
        if (r2.is_limited()) return PosRange(start, std::min(r1.end(), r2.end()));
        return PosRange(start, r1.end());
    }
    if (r2.is_limited()) return PosRange(start, r2.end());
    return PosRange::from(start);
}

inline bool PosRange::contains(const PosRange& other) const {
    return !other.is_empty() && intersection(*this, other) == other;
}


class ExplicitRange : public PosRange {

    // this ctor is private to avoid making ranges repeatedly explicit (if REALLY needed, convert range to PosRange before)
    ExplicitRange(const ExplicitRange& range, int maxlen);

    bool is_limited() const { // always true -> private to avoid usage
        arb_assert(PosRange::is_limited());
        return true;
    }

public:
    ExplicitRange(const ExplicitRange& limRange) : PosRange(limRange) {}
    explicit ExplicitRange(const PosRange& limRange) : PosRange(limRange) { arb_assert(is_limited()); }

    ExplicitRange(const PosRange& range, int maxlen)
        : PosRange(range.is_empty() || maxlen <= 0
                   ? PosRange::empty()
                   : PosRange(range.start(), range.is_limited() ? std::min(range.end(), maxlen-1) : maxlen-1))
    { arb_assert(is_limited()); }

    ExplicitRange(int start_, int end_)
        : PosRange(start_, end_)
    { arb_assert(is_limited()); }

    explicit ExplicitRange(int len)
        : PosRange(0, len-1)
    { arb_assert(is_limited()); }

    DECLARE_ASSIGNMENT_OPERATOR(ExplicitRange);
};

inline ExplicitRange intersection(ExplicitRange r1, ExplicitRange r2) {
    if (r1.is_empty()) return r1;
    if (r2.is_empty()) return r2;

    return ExplicitRange(std::max(r1.start(), r2.start()),
                         std::min(r1.end(), r2.end()));
}

inline ExplicitRange intersection(ExplicitRange e1, PosRange r2) {
    return intersection(e1, ExplicitRange(r2, e1.end()+1));
}
inline ExplicitRange intersection(PosRange r1, ExplicitRange e2) {
    return intersection(ExplicitRange(r1, e2.end()+1), e2);
}

#else
#error pos_range.h included twice
#endif // POS_RANGE_H