verilator/src/V3GraphAlg.h

// -*- C++ -*-
//*************************************************************************
// DESCRIPTION: Verilator: Graph algorithm base class
//
// Code available from: http://www.veripool.org/verilator
//
// AUTHORS: Wilson Snyder with Paul Wasson, Duane Gabli
//
//*************************************************************************
//
// Copyright 2003-2010 by Wilson Snyder.  This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0.
//
// Verilator 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.
//
//*************************************************************************

#ifndef _V3GRAPHALG_H_
#define _V3GRAPHALG_H_ 1
#include "config_build.h"
#include "verilatedos.h"

#include "V3Global.h"
#include "V3Graph.h"

//=============================================================================
// Algorithms - common class
// For internal use, most graph algorithms use this as a base class

class GraphAlg {
protected:
    V3Graph*	m_graphp;		// Graph we're operating upon
    V3EdgeFuncP	m_edgeFuncp;		// Function that says we follow this edge

    inline bool followEdge(V3GraphEdge* edgep) {
	return (edgep->weight() && (m_edgeFuncp)(edgep));
    }
    GraphAlg(V3Graph* graphp, V3EdgeFuncP edgeFuncp)
	: m_graphp(graphp), m_edgeFuncp(edgeFuncp) {}
    ~GraphAlg() {}
};

//============================================================================

#endif // Guard