gain-traverse.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/>.      *
 *                                                                        *
 **************************************************************************/

// Purpose: visitors that traverse MyGainGraphs.


#ifndef _GAIN_TRAVERSE_H
#define _GAIN_TRAVERSE_H

#include "bfs.h"
#include "dfs.h"
#include "gain.h"

class  MyGainReduce2DFSVisitor: public MyDefaultDFSVisitor
{
private:
  MyGainGraph component;
  const map< MyNodeId, MyGainTriStateType > *nodeStateTypes;
  set< MyGainTriStateType > stateTypesSeen;
  MyNodeIdSet nodesInHypotheticalStateSeen;
  
public:

  virtual ~MyGainReduce2DFSVisitor()
    {}

  // don't define this method without arguments.
//  virtual void initialise();
  
  virtual void initialise(const map< MyNodeId, MyGainTriStateType > *states)
    {
      component.clear();
      nodeStateTypes = states;
      stateTypesSeen.clear();
      nodesInHypotheticalStateSeen.clear();
    }   

  virtual MyGainGraph &getComponent()
    {
      return(component);
    }

  virtual set< MyGainTriStateType > getStateTypesSeen() const
    {
      return(stateTypesSeen);
    }

  virtual void addNodesInHypotheticalStateSeen(MyNodeIdSet &nodes) const
    {
      nodes.insert(nodesInHypotheticalStateSeen.begin(), nodesInHypotheticalStateSeen.end());
    }
  
};

// traverse a connected subgraph of the graph starting at a node (it
// should be a node predicted to have a function) until i reach a
// clamped node. also compute the connected component as i go. add the
// clamped nodes to the component. this component should be the
// propagation graph for the node.
class  MyOneVersusAllGainAlgoPropagationBFSVisitor: public MyDefaultBFSVisitor
{
private:
  MyGainGraph component;
  const map< MyNodeId, MyGainTriStateInfo > *nodeStates;

public:
    
  virtual ~MyOneVersusAllGainAlgoPropagationBFSVisitor()
    {}

  // don't define this method without arguments.
//  virtual void initialise();
  
  virtual void initialise(const map< MyNodeId, MyGainTriStateInfo > *states)
    {
      component.clear();
      nodeStates = states;
    }

  virtual MyGainGraph &getComponent()
    {
      return(component);
    }
  
};


#endif // _GAIN_TRAVERSE_H