PosLattice.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 POSLATTICE_H
#define POSLATTICE_H

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

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

class PosLattice: public Lattice
{
    protected:
        // We need this to associate with each itemset
        struct assoc
        {
            unsigned int count;
            //unsigned int lowerBound;
            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 the truth matrix
        BinaryMatrix* bm;

        // This is the evaluation buffer
        vector<Itemset*> cBuffer;

        // 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 rotor for generating candidates
        vector<unsigned int> candidateRotor;

        // The next candidate
        Itemset* nextCandidate;

        // The position in the buffer
        unsigned int cBufferPos;

        // 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;

        // Helper methods

        // Candidiate stuff
        virtual void generateCandidatesNonzero();
        virtual void generateCandidatesZero();
        virtual void candidateRotate();
        virtual void candidateRotateZero();
        virtual void candidateRotorStart(unsigned int pos);
        virtual void candidateRotorStartZero(unsigned int pos);
        virtual bool testCandidateRotor(unsigned int pos);
        virtual bool testCandidateRotorZero(unsigned int pos);
        virtual void createCandidate();
        virtual void candidateTick(unsigned int pos);
        virtual bool badCandidateRotor(unsigned int pos) const;
        virtual bool createCandidateRotate(vector<unsigned int>& rotorPool,
            vector<unsigned int>& isRotor);
        virtual bool testCreateCandidateRotor(vector<unsigned int>& isRotor,
            vector<unsigned int>& rotorPool, unsigned int pos, bool& success);
        virtual bool createCandidateRotorStart(vector<unsigned int>& isRotor,
            vector<unsigned int>& rotorPool, unsigned int pos);

        // Evaluation stuff
        virtual void countSubsets(Itemset* is);
        virtual void flushCountBuffer();
        virtual void countSets(const vector<Itemset*>& sets, unsigned int size);
        virtual void getRowSetCounts(const Itemset* is,
            vector<unsigned int>& counts) /*const*/;
        virtual void makeNotPositiveSubsets(const Itemset* is);
        virtual int generateSupport(const Itemset& pos, const Itemset& neg,
            unsigned int start) /*const*/;
        virtual void generateSupports(const Itemset& is, const Itemset& pos,
            const Itemset& neg, vector<unsigned int>& counts) /*const*/;

    public:
        PosLattice(BinaryMatrix* bm = NULL, unsigned int bufferSize = 1000,
            Evaluator* evaluator = NULL, bool order = false);
        PosLattice(const PosLattice& src);
        virtual ~PosLattice();
        virtual PosLattice& operator =(const PosLattice& 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;
};

#endif