Evaluator.h

/**************************************************************************
 * Copyright (c) 2007 Clifford Conley Owens III                           *
 *                                                                        *
 * This file is part of Biorithm.                                         *
 *                                                                        *
 * Biorithm 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.                                    *
 *                                                                        *
 * Biorithm 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 Biorithm.  If not, see <http://www.gnu.org/licenses/>.      *
 *                                                                        *
 **************************************************************************/

#ifndef EVALUATOR_H
#define EVALUATOR_H

// ---------------------------- Internal Headers ---------------------------- //

#include "BinaryMatrix.h"

class Evaluator
{
    protected:
        // The truth matrix
        BinaryMatrix* bm;

    public:
        // The constructor                                                    //
        //                                                                    //
        // --------------------------- Parameters --------------------------- //
        // BinaryMatrix* bm                                                    //
        //     The truth matrix                                               //
        Evaluator(BinaryMatrix* bm = NULL)
        {
            setBinaryMatrix(bm);
        }

        // The destructor                                                     //
        virtual ~Evaluator()
        {

        }

        // The = operator                                                     //
        //                                                                    //
        // --------------------------- Parameters --------------------------- //
        // const Evaluator& rhs                                               //
        //     The right hand side                                            //
        //                                                                    //
        // ----------------------------- Return ----------------------------- //
        // A copy of the Evaluator                                            //
        virtual Evaluator& operator =(const Evaluator& rhs)
        {
            bm = rhs.bm;
            return *this;
        }

        // Sets the binary matrix                                             //
        //                                                                    //
        // --------------------------- Parameters --------------------------- //
        // BinaryMatrix* bm                                                   //
        //     The binary matrix                                              //
        virtual void setBinaryMatrix(BinaryMatrix* bm)
        {
            this->bm = bm;
        }

        virtual unsigned int getUpperBound(const vector<unsigned int>& counts)
            const = 0;
        virtual unsigned int getUpperBound() const = 0;
};

#endif