MafiaMiner.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 MAFIAMINER_H
#define MAFIAMINER_H

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

#include "ItemSetMap.h"
#include "Miner.h"

class MafiaMiner: public Miner
{
    protected:
        // The fraction of the rows that must comprise each bitpattern
        float balance;

        // The required number of occurances for each bitpattern
        unsigned int bpreq;

        // This is twice the required number of occurances for each bitpattern
        // it may seems redundant, but it is nice to not have to compute this
        // value, as it is useful in early termination
        unsigned int bpreq2;

        // The fraction of bitpatterns that must succeed
        float support;

        // The previously mined item sets
        ItemSetMap<bool> map;

        // the size of the buffer
        unsigned int buffer_size;

        // These three are used for updating the status
        double denominator;

        virtual void analyzeHelper();
        virtual void createDerivatives(const ItemSet* is,
            vector<ItemSet*>& sets);
        virtual void analyzeItemSets(vector<ItemSet*>& sets,
            unsigned int level);
        virtual void analyzeItemSet(ItemSet* is,
            const vector<unsigned int>& tallies, unsigned int height,
            vector<ItemSet*>& dsets);
        virtual void genstatus(const ItemSet* is);

    public:
        MafiaMiner(float balance = 0.5, float support = 1.0,
            unsigned int buffer_size = 1000);
        MafiaMiner(const MafiaMiner& src);
        virtual ~MafiaMiner();
        virtual MafiaMiner& operator =(const MafiaMiner& rhs);
};

#endif