AtchleyCorrelation.h

/*  This file is part of Victor.

    Victor 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 3 of the License, or
    (at your option) any later version.

    Victor 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 Victor.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef __AtchleyCorrelation_H__
#define __AtchleyCorrelation_H__

#include <Profile.h>
#include <ScoringFunction.h>
#include <iostream>

namespace Victor { namespace Align2{

    class AtchleyCorrelation : public ScoringFunction {
    public:

        // CONSTRUCTORS:

        AtchleyCorrelation(Profile *pro1, Profile *pro2);

        AtchleyCorrelation(Profile *pro1, Profile *pro2, double offset);

        AtchleyCorrelation(const AtchleyCorrelation &orig);

        virtual ~AtchleyCorrelation();


        // OPERATORS:

        AtchleyCorrelation& operator =(const AtchleyCorrelation &orig);


        // PREDICATES:

        virtual double scoringSeq(int i, int j);

        virtual double getOffset();


        // MODIFIERS:

        virtual void copy(const AtchleyCorrelation &orig);

        virtual AtchleyCorrelation* newCopy();

        virtual void setOffset(double off);


        // HELPERS:

        virtual void pLoadFactor();


    protected:


    private:

        // ATTRIBUTES:

        Profile *pro1; 
        Profile *pro2; 
        double offset; 
        double factor[20][5]; 

    };

    // -----------------------------------------------------------------------------
    //                              AtchleyCorrelation
    // -----------------------------------------------------------------------------

    // PREDICATES:

    inline double
    AtchleyCorrelation::getOffset() {
        return offset;
    }


    // MODIFIERS:

    inline void
    AtchleyCorrelation::setOffset(double off) {
        offset = off;
    }

}} // namespace

#endif