libpbdata-dev 0~20151014+gitbe5d1bf-2 / usr / include / pbdata / reads / RegionAnnotation.hpp

// Copyright (c) 2014-2015, Pacific Biosciences of California, Inc.  //
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted (subject to the limitations in the
// disclaimer below) 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 Pacific Biosciences nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
// GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY PACIFIC
// BIOSCIENCES AND ITS 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 PACIFIC BIOSCIENCES OR ITS
// CONTRIBUTORS 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: Mark Chaisson

#ifndef _BLASR_REGION_ANNOTATION_HPP_
#define _BLASR_REGION_ANNOTATION_HPP_

#include <cassert>
#include <cstring>
#include <string>
#include <iostream>
#include <vector>
#include <map>
#include <ostream>
#include "Types.h"
#include "Enumerations.h"
#include "PacBioDefs.h"
#include "RegionTypeMap.hpp"


class HDFRegionTableReader;
class HDFRegionTableWriter;
class HDFRegionsWriter;


class RegionAnnotation {
friend class HDFRegionTableReader;
friend class HDFRegionTableWriter;
friend class HDFRegionsWriter;

public:
    static const int HOLENUMBERCOL = 0;
    static const int REGIONTYPEINDEXCOL = 1;
    static const int REGIONSTARTCOL = 2;
    static const int REGIONENDCOL = 3;
    static const int REGIONSCORECOL = 4;
    static const int NCOLS=5;

    int row[NCOLS];

public:
    // FIXME: use regionType as a member varaible instead of regionTypeIndex
    inline RegionAnnotation(UInt holeNumber = 0,
                            int typeIndex = 0,
                            int start = 0, int end = 0,
                            int score = -1);

    inline bool operator<(const RegionAnnotation &rhs) const;

    inline bool operator<(int holeNumber) const;

    inline RegionAnnotation& operator=(const RegionAnnotation &rhs);

    inline bool operator==(const RegionAnnotation &rhs) const;

    inline int GetHoleNumber(void) const;

    inline RegionAnnotation & SetHoleNumber(int holeNumber);

    inline int GetTypeIndex(void) const;

    inline std::string GetTypeString(const std::vector<RegionType> & types) const;

    inline RegionAnnotation & SetTypeIndex(int typeIndex);

    inline int GetStart(void) const;

    inline RegionAnnotation & SetStart(int start);

    inline int GetEnd(void) const;

    inline RegionAnnotation & SetEnd(int end);

    inline int GetScore(void) const;

    inline RegionAnnotation & SetScore(int score);

public:
    friend std::ostream & operator << (std::ostream & os, const RegionAnnotation& ra);
};

inline
bool compare_region_annotation_by_type(const RegionAnnotation & lhs,
                                       const RegionAnnotation & rhs);

inline
RegionAnnotation::RegionAnnotation(UInt holeNumber,
        int typeIndex, int start, int end, int score) {
    SetHoleNumber(static_cast<int>(holeNumber));
    SetTypeIndex(typeIndex);
    SetStart(start);
    SetEnd(end);
    SetScore(score);
}

inline
bool RegionAnnotation::operator<(const RegionAnnotation &rhs) const
{
    if (GetHoleNumber() == rhs.GetHoleNumber())
        if (GetStart() == rhs.GetStart()) {
            if (GetEnd() == rhs.GetEnd())
                return GetScore() < rhs.GetScore();
            else
                return GetEnd() > rhs.GetEnd();
        } else {
            return GetStart() < rhs.GetStart();
        }
    else
        return GetHoleNumber() < rhs.GetHoleNumber();
}

inline
bool RegionAnnotation::operator<(int holeNumber) const
{ return GetHoleNumber() < holeNumber; }


inline
RegionAnnotation& RegionAnnotation::operator=(const RegionAnnotation &rhs) {
    memcpy(row, rhs.row, sizeof(int)*NCOLS);
    return *this;
}

inline
bool RegionAnnotation::operator==(const RegionAnnotation &rhs) const {
    return (GetHoleNumber() == rhs.GetHoleNumber() and
            GetTypeIndex() == rhs.GetTypeIndex() and
            GetStart() == rhs.GetStart() and
            GetEnd()   == rhs.GetEnd()   and
            GetScore() == rhs.GetScore());
}

inline
int RegionAnnotation::GetHoleNumber(void) const {
    return row[HOLENUMBERCOL];
}

inline
RegionAnnotation & RegionAnnotation::SetHoleNumber(int holeNumber) {
    row[HOLENUMBERCOL] = holeNumber;
    return *this;
}

inline
int RegionAnnotation::GetTypeIndex(void) const {
    return row[REGIONTYPEINDEXCOL];
}

inline std::string RegionAnnotation::GetTypeString(const std::vector<RegionType> & typesTable) const {
    assert(GetTypeIndex() >= 0 and GetTypeIndex() < static_cast<int>(typesTable.size()));
    return RegionTypeMap::ToString(typesTable[GetTypeIndex()]);
}

inline
RegionAnnotation & RegionAnnotation::SetTypeIndex(int regionTypeIndex) {
    row[REGIONTYPEINDEXCOL] = regionTypeIndex;
    return *this;
}

inline
int RegionAnnotation::GetStart(void) const {
    return row[REGIONSTARTCOL];
}

inline
RegionAnnotation & RegionAnnotation::SetStart(int start) {
    row[REGIONSTARTCOL] = start;
    return *this;
}

inline
int RegionAnnotation::GetEnd(void) const {
    return row[REGIONENDCOL];
}

inline
RegionAnnotation & RegionAnnotation::SetEnd(int end) {
    row[REGIONENDCOL] = end;
    return *this;
}

inline
int RegionAnnotation::GetScore(void) const {
    return row[REGIONSCORECOL];
}

inline
RegionAnnotation & RegionAnnotation::SetScore(int score) {
    row[REGIONSCORECOL] = score;
    return *this;
}

inline
bool compare_region_annotation_by_type(const RegionAnnotation & lhs,
                                       const RegionAnnotation & rhs)
{
    if (lhs.GetHoleNumber() == rhs.GetHoleNumber()) {
        if (lhs.GetTypeIndex() == rhs.GetTypeIndex()) {
            if (lhs.GetStart() == rhs.GetStart()) {
                 if (lhs.GetEnd() == rhs.GetEnd())
                     return lhs.GetScore() < rhs.GetScore();
                 else return lhs.GetEnd() > rhs.GetEnd();
            } else return lhs.GetStart() < rhs.GetStart();
        } else return lhs.GetTypeIndex() < rhs.GetTypeIndex();
    } else {
        return lhs.GetHoleNumber() < rhs.GetHoleNumber();
    }
}

#endif // _BLASR_REGION_ANNOTATION_HPP_