Lattice.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 LATTICE_H
#define LATTICE_H

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

#include "Evaluator.h"
#include "BinaryMatrix.h"

class Lattice
{
    public:
        // The destructor                                                     //
        virtual ~Lattice()
        {

        }

        virtual void setBinaryMatrix(BinaryMatrix* bm) = 0;
        virtual void generateCandidates(unsigned int level) = 0;
        virtual void generateCandidates(unsigned int level, unsigned int k) = 0;
        virtual bool hasNextCandidate() const = 0;
        virtual Itemset* getNextCandidate() = 0;
        virtual void evaluateItemset(Itemset* is) = 0;
        virtual void flushEvaluationBuffer() = 0;
        virtual unsigned int getUpperBound() const = 0;
        virtual void setEvaluator(Evaluator* evaluator) = 0;
        virtual void setBufferSize(unsigned int bufferSize) = 0;
        virtual unsigned int analyzeLevel(unsigned int level) = 0;
        virtual unsigned int analyzeLevel(unsigned int level, double& status) =
            0;
        virtual unsigned int analyzeLevel(unsigned int level, unsigned int k) =
            0;
        virtual unsigned int analyzeLevel(unsigned int level, unsigned int k,
            double& status) = 0;
        virtual bool isEmpty(unsigned int level) const = 0;
        virtual unsigned int getSize() const = 0;
        virtual unsigned int getSize(unsigned int level) const = 0;
        virtual unsigned int getSuccessful(unsigned int level) const = 0;
        virtual const Itemset* getItemset(unsigned int level,
            unsigned int index) const = 0;
        virtual const Itemset* getItemset(unsigned int level,
            unsigned int index, unsigned int& upperBound) const = 0;
        virtual void generatePositiveBorder(unsigned int level) = 0;
        virtual bool hasNextPositiveBorder() const = 0;
        virtual const Itemset* getNextPositiveBorder() = 0;
        virtual void destroy() = 0;
        virtual unsigned int getWidth() const = 0;
};

#endif