TopKMiner.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 TOPKMINER_H
#define TOPKMINER_H

#define MODE_TOPK_NULL   0
#define MODE_TOPK_NORMAL 1

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

#include "BSEvaluator.h"
#include "LatticeMiner.h"

class TopKMiner: public LatticeMiner
{
    protected:
        // The evaluator
        BSEvaluator* bse;

        // The target level
        unsigned int k;

        // How many we are trying to show at the top
        unsigned int size;

        // The mode
        int mode;

        // Helper methods
        virtual void analyzeHelper();
        virtual unsigned int analyzeLevel(unsigned int level);
        virtual void handlePrinting(unsigned int level);
        virtual void analyzeTopKNull();
        virtual void analyzeTopKNormal();

    public:
        TopKMiner(float balance = 0.5, float support = 1.0, unsigned int k = 1,
            unsigned int size = 100, unsigned int buffer_size = 1000,
            bool positive = false, BinaryMatrix* tm = NULL,
            int mode = MODE_TOPK_NULL);
        TopKMiner(const TopKMiner& src);
        virtual ~TopKMiner();
        virtual TopKMiner& operator =(const TopKMiner& rhs);
};

#endif