GenericLattice.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 GENERICLATTICE_H
#define GENERICLATTICE_H

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

#include "Evaluator.h"
#include "ItemsetLevel.h"
#include "Lattice.h"
#include "BinaryMatrix.h"
#include "Rotor.h"

class GenericLattice: public Lattice
{
    protected:
        // We need this to associate with each itemset
        struct assoc
        {
            unsigned int upperBound;

            // This is if we could *potentially* be on the positive border
            bool positiveBorder;
        };

        // This is the ordered vector of the sets
        vector<ItemsetLevel<struct assoc> > levels;

        // This is a level representing the itemsets that we do not need to
        // evaluate--the bool is arbitrary.  We don't use anything
        ItemsetLevel<bool> dnevals;

        // This is the truth matrix
        BinaryMatrix* bm;

        // The evaluator
        Evaluator* evaluator;

        // Whether or not we have to worry about things coming in order
        bool order;

        // The target level for generating candidates
        unsigned int targetCandidate;

        // The lower level for generating candidates
        unsigned int lowerCandidate;

        // The target level
        unsigned int kCandidate;

        // The level above that has been completed
        unsigned int upperDneval;

        // The rotor for generating candidates
        Rotor candidateRotor;

        // The next candidate
        Itemset* nextCandidate;

        // The itemsets in the buffer that need to be evaluated in addition
        // to being counted
        vector<Itemset*> eBuffer;

        // The possition in the ebuffer
        unsigned int eBufferPos;

        // The position on the positive border
        unsigned int borderPos;

        // The level at which we are getting positive borders
        unsigned int borderLevel;

        // The number of successful itemsets at each level
        vector<unsigned int> successful;

        // The maximum level we could attain during a certain analysis
        unsigned int maxlev;

        // The iterator
        ItemsetLevel<bool>::iterator dnevaliter;

        // Whether or not we should keep the failures
        bool keepFs;

        // Helper methods

        // Candidiate stuff
        virtual void createCandidate();
        virtual void candidateTick();
        virtual void makeNotPositiveSubsets(const Itemset* is);
        virtual void fillDnevals(Itemset* is);

    public:
        GenericLattice(BinaryMatrix* bm = NULL, unsigned int bufferSize = 1000,
            Evaluator* evaluator = NULL, bool order = false,
            bool keepFailures = false);
        GenericLattice(const GenericLattice& src);
        virtual ~GenericLattice();
        virtual GenericLattice& operator =(const GenericLattice& rhs);
        virtual void setBinaryMatrix(BinaryMatrix* bm);
        virtual void generateCandidates(unsigned int level);
        virtual void generateCandidates(unsigned int level, unsigned int k);
        virtual bool hasNextCandidate() const;
        virtual Itemset* getNextCandidate();
        virtual void evaluateItemset(Itemset* is);
        virtual void flushEvaluationBuffer();
        virtual unsigned int getUpperBound() const;
        virtual void setEvaluator(Evaluator* evaluator);
        virtual void setBufferSize(unsigned int bufferSize);
        virtual unsigned int analyzeLevel(unsigned int level);
        virtual unsigned int analyzeLevel(unsigned int level, double& status);
        virtual unsigned int analyzeLevel(unsigned int level, unsigned int k);
        virtual unsigned int analyzeLevel(unsigned int level, unsigned int k,
            double& status);
        virtual bool isEmpty(unsigned int level) const;
        virtual unsigned int getSize() const;
        virtual unsigned int getSize(unsigned int level) const;
        virtual unsigned int getSuccessful(unsigned int level) const;
        virtual const Itemset* getItemset(unsigned int level,
            unsigned int index) const;
        virtual const Itemset* getItemset(unsigned int level,
            unsigned int index, unsigned int& upperBound) const;
        virtual void generatePositiveBorder(unsigned int level);
        virtual bool hasNextPositiveBorder() const;
        virtual const Itemset* getNextPositiveBorder();
        virtual void destroy();
        virtual unsigned int getWidth() const;
        void dontKeepFailures();
        void keepFailures();
};

#endif