OperationDAG.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file OperationDAG.hh
 *
 * Declaration of operation directed acyclic graph class
 *
 * @author Mikael Lepistö 2007 (mikael.lepisto-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_OPERATION_DAG_HH
#define TTA_OPERATION_DAG_HH
 
#include "BoostGraph.hh"
 
#include "OperationDAGNode.hh"
#include "OperationDAGEdge.hh"
 
class TerminalNode;
 
class OperationDAG : 
    public BoostGraph<OperationDAGNode, OperationDAGEdge> {
 
public:   
    static OperationDAG null;
    bool isNull() const { return this == &null; }
 
    OperationDAG();
    OperationDAG(const class OperationPimpl& op);
    OperationDAG(const OperationDAG& other);
    virtual ~OperationDAG();    
    bool isTrivial() const;
 
    int stepsToRoot(const OperationDAGNode& node) const;
    const OperationDAG::NodeSet& endNodes() const;
 
    const class OperationPimpl& operation() const { assert(op_ != nullptr); return *op_; }
    void setOperation(const class OperationPimpl& op) { op_ = &op; }
private:    
    const class OperationPimpl* op_;
 
    /// Map of known step counts, if dag is changed this must be cleared.
    mutable std::map<const OperationDAGNode*, int, 
                     OperationDAGNode::Comparator> stepMap_;    
    /// Set of root nodes of DAG, must be cleared if dag is changed.
    mutable OperationDAG::NodeSet endNodes_;
        
};
 
#endif