rand_gather.h

/**************************************************************************
 * Copyright (c) 2001-2011 T. M. Murali                                   *
 * Copyright (c) 2011 Phillip Whisenhunt                                  *
 * Copyright (c) 2011 David Badger                                        *
 * Copyright (c) 2010 Jacqueline Addesa                                   *
 *                                                                        *
 * 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 RAND_GATHER_H
#define RAND_GATHER_H

// Purpose:     Interfaces for rand_gather and rand_aggregate, classes to collect
// gain annotation data over multiple runs of the algorithm

#include <iostream>
#include <string>
#include <map>
#include "gain.h"

using namespace std;

//map from protein name to number of times it was predicted as annotated
typedef map<string, int> annotation_counts_type;

class rand_gather
{
        public:

                //constructor: takes the total number of runs and the output stream for printing the annotation counts
                rand_gather(int p_total_runs);

                //copy constructor
                rand_gather(const rand_gather& copy);

                //update the annotation counts using provided state data
                void UpdateCounts(MyNodeStatesType& states);

        private:
                //current random run number and total number of (expected) runs
                int current_run, total_runs;

                //map of protein names to their annotation counts
                annotation_counts_type annotation_counts;
};

//map from function GO ID to a rand_gather object
typedef map<string, rand_gather> function_aggregate_type;

class rand_aggregate
{
        public:
                //constructor: empty so far
                rand_aggregate();
};

#endif