torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PathFinderHeuristic.hpp
Go to the documentation of this file.
1 // Torc - Copyright 2011-2013 University of Southern California. All Rights Reserved.
2 // $HeadURL$
3 // $Id$
4 
5 // This program is free software: you can redistribute it and/or modify it under the terms of the
6 // GNU General Public License as published by the Free Software Foundation, either version 3 of the
7 // License, or (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
10 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
11 // the GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License along with this program. If
14 // not, see <http://www.gnu.org/licenses/>.
15 
16 /// \file
17 /// \brief Header for the PathfinderHeuristic class.
18 
19 #ifndef TORC_ROUTER_PATHFINDERHEURISTIC_HPP
20 #define TORC_ROUTER_PATHFINDERHEURISTICHPP
21 
24 #include "torc/router/RouteNet.hpp"
25 #include <boost/unordered_map.hpp>
26 #include <boost/any.hpp>
27 
28 namespace torc {
29 namespace router {
30 
31  /// \brief Provides net routing based on the Nillson graphsearch algorithm.
32  /// \details The router can either return a vector of nodes or directly populate DDB usage.
34  // types
35  /// \brief Imported type names
38 
39  typedef boost::unordered_map<boost::uint32_t, boost::any> ParameterMap;
40 
41  protected:
42  // members
43 
44  public:
45  // constructor
46  /// \brief Public Constructor
48  /// \brief Destructor.
49  virtual ~PathFinderHeuristic() {}
50 
51  /// \brief Prioritize nets for routing.
52  virtual void prioritizeNets(RouteNetVector& inNets) {}
53  /// \brief Heuristically update parameters related to the associated NetVector router.
54  virtual void updateParameters(ParameterMap& inParameters) {}
55 
56  }; // class PathFinderHeuristic
57 
58 
59 } // namespace router
60 } // namespace torc
61 
62 #endif // TORC_ROUTER_PATHFINDERHEURISTIC_HPP
std::vector< Tilewire > TilewireVector
Vector of Tilewire objects.
Definition: Tilewire.hpp:101
boost::unordered_map< boost::uint32_t, boost::any > ParameterMap
Device database, including complete wiring and logic support.
Definition: DDB.hpp:42
std::vector< RouteNet > RouteNetVector
Vector of RouteNet objects.
Definition: RouteNet.hpp:205
Header for the NetVectorRouterHeuristicBase class.
Provides net routing based on the Nillson graphsearch algorithm.
Provides net routing based on the Nillson graphsearch algorithm.
boost::unordered_map< boost::uint32_t, boost::any > ParameterMap
virtual ~PathFinderHeuristic()
Destructor.
architecture::TilewireVector TilewireVector
virtual void updateParameters(ParameterMap &inParameters)
Heuristically update parameters related to the associated NetVector router.
Header for the DDB class.
PathFinderHeuristic(DDB &inDB)
Public Constructor.
Header for the Net class.
virtual void prioritizeNets(RouteNetVector &inNets)
Prioritize nets for routing.
architecture::DDB DDB
Imported type names.