An object that holds more complete path information for routing and tracing. More...

#include <RouteTreeNode.hpp>

Inheritance diagram for torc::router::RouteTreeNode:

Collaboration diagram for torc::router::RouteTreeNode:

Public Member Functions
	RouteTreeNode ()
	Null Constructor. More...

	RouteTreeNode (Tilewire inSource, Tilewire inSink, boost::int32_t inCost, RouteTreeNode *inParent)
	Public Constructor. More...

	RouteTreeNode (Arc inArc, boost::int32_t inCost, RouteTreeNode *inParent)
	Public Constructor. More...

	~RouteTreeNode ()
	Destructor. More...

void	addChildren (const std::vector< RouteTreeNode * > &newChildren)
	Add children to the node. More...

void	makeParent (const Tilewire &inSource, const Tilewire &inSink)
	Allocate a new node and make it the parent of this node. More...

boost::uint16_t	getNumChildren ()
	Get the number of children. More...

RouteTreeNode *	getChild (unsigned int index)
	Get a child by index, returns 0 for invalid index. More...

void	normalizeDepth ()
	Normalize depth of nodes. More...

const Arc &	getArc () const
	Get the associated Arc. More...

const Tilewire &	getSourceTilewire () const
	Get the source Tilewire. More...

const Tilewire &	getSinkTilewire () const
	Get the sink Tilewire. More...

const boost::int32_t	getCost () const
	Get the heuristic node cost. More...

void	setCost (boost::int32_t inHeuristicCost)
	Set the heuristic node cost. More...

const boost::int32_t	getPathCost () const
	Get the path cost. More...

void	setPathCost (boost::int32_t inPathCost)
	Set the path cost. More...

const boost::int32_t	getDepth () const
	Get the node depth. More...

void	setDepth (boost::int32_t inDepth)
	Set the node depth. More...

RouteNode *	getParent () const
	Get the node's parent. More...

RouteNode *	getTop ()
	Return the top node by tracing parent pointers. More...

bool	operator< (const RouteNode *rhs) const

Protected Types
typedef architecture::Tilewire	Tilewire
	Imported type name. More...

typedef architecture::Arc	Arc
	Imported type name. More...

Protected Member Functions
void	adjustDepth (int adjustment)
	Recursively adjust node depths. More...

Protected Attributes
RouteTreeNode *	mOnlyChild
	Pointer to a child node that is the only one. More...

std::vector< RouteTreeNode * > *	mChildren
	Pointer to a vector of child nodes that is dynamically allocated. More...

architecture::Arc	mArc
	Arc that this node describes. More...

boost::int32_t	mCost
	Cost associated with this arc. More...

boost::int32_t	mPathCost
	Path cost for this arc. More...

boost::int32_t	mDepth
	Depth of node from the source. More...

RouteNode *	mParent
	Pointer to parent node. More...

Private Types
typedef std::vector < RouteTreeNode * >::iterator	RouteTreeNodeIterator

Detailed Description

An object that holds more complete path information for routing and tracing.

Todo:: Have to justify the packing decision, and its impact on memory footprint versus performance.

A RouteTreeNode contains children pointers to allow tracing of arcs through a device to recover complete nets from the device usage information.

Definition at line 37 of file RouteTreeNode.hpp.

Member Typedef Documentation

typedef architecture::Arc torc::router::RouteNode::Arc

protectedinherited

Imported type name.

Definition at line 46 of file RouteNode.hpp.

typedef std::vector<RouteTreeNode*>::iterator torc::router::RouteTreeNode::RouteTreeNodeIterator

private

Definition at line 39 of file RouteTreeNode.hpp.

typedef architecture::Tilewire torc::router::RouteNode::Tilewire

protectedinherited

Imported type name.

Definition at line 44 of file RouteNode.hpp.

Constructor & Destructor Documentation

torc::router::RouteTreeNode::RouteTreeNode ( )

inline

Null Constructor.

Definition at line 50 of file RouteTreeNode.hpp.

50 : RouteNode(), mOnlyChild(0), mChildren(0) {}

torc::router::RouteTreeNode::mChildren

std::vector< RouteTreeNode * > * mChildren

Pointer to a vector of child nodes that is dynamically allocated.

Definition: RouteTreeNode.hpp:45

torc::router::RouteTreeNode::mOnlyChild

RouteTreeNode * mOnlyChild

Pointer to a child node that is the only one.

Definition: RouteTreeNode.hpp:43

torc::router::RouteNode::RouteNode

RouteNode()

Null Constructor.

Definition: RouteNode.hpp:62

Here is the caller graph for this function:

torc::router::RouteTreeNode::RouteTreeNode	(	Tilewire	inSource,
		Tilewire	inSink,
		boost::int32_t	inCost,
		RouteTreeNode *	inParent
	)

inline

Public Constructor.

Definition at line 52 of file RouteTreeNode.hpp.

             : RouteNode(inSource, inSink, inCost, inCost, 0, inParent), mOnlyChild(0), 
             mChildren(0) {
             if (inParent != 0) {
                 mDepth = inParent->getDepth() + 1;
             } else {
                 mDepth = 0;
             }
         }

Here is the call graph for this function:

torc::router::RouteTreeNode::RouteTreeNode	(	Arc	inArc,
		boost::int32_t	inCost,
		RouteTreeNode *	inParent
	)

inline

Public Constructor.

Definition at line 63 of file RouteTreeNode.hpp.

             : RouteNode(inArc, inCost, inCost, 0, inParent), mOnlyChild(0), mChildren(0) {
             if (inParent != 0) {
                 mDepth = inParent->getDepth() + 1;
             } else {
                 mDepth = 0;
             }
         }

Here is the call graph for this function:

torc::router::RouteTreeNode::~RouteTreeNode ( )

inline

Destructor.

Definition at line 72 of file RouteTreeNode.hpp.

                          {
             if (mOnlyChild != 0) { delete mOnlyChild; mOnlyChild = 0; }
             if (mChildren != 0) {
                 RouteTreeNodeIterator p = mChildren->begin();
                 RouteTreeNodeIterator e = mChildren->end();
                 while (p < e) { delete *p, p++; }
                 delete mChildren; mChildren = 0;
             }
         }

Member Function Documentation

void torc::router::RouteTreeNode::addChildren ( const std::vector< RouteTreeNode * > & newChildren )

inline

Add children to the node.

Definition at line 85 of file RouteTreeNode.hpp.

                                                                        {
             boost::uint32_t size = newChildren.size();
             if (size == 0) { return; }
             
             // no child or 1 child
             if (mChildren == 0) {
                 // adding 1 child to a node with 0
                 if (mOnlyChild == 0 && size == 1) {
                     mOnlyChild = newChildren[0];
                     return;
                 }
                 // node will have more than 1 child, create vector
                 mChildren = new std::vector<RouteTreeNode*>();
                 // if the node had 1 child, move it to the vector
                 if (mOnlyChild != 0) {
                     mChildren->reserve(size+1);
                     mChildren->push_back(mOnlyChild);
                     mOnlyChild = 0;
                 // node had 0 children, reserve space for the new children
                 } else {
                     mChildren->reserve(size);
                 }
             // already 2 or more children
             } else {
                 mChildren->reserve(mChildren->size() + size);
             }
             // insert children into the node
             mChildren->insert(mChildren->end(), newChildren.begin(), newChildren.end());
         }

Here is the caller graph for this function:

void torc::router::RouteTreeNode::adjustDepth ( int adjustment )

inlineprotected

Recursively adjust node depths.

Definition at line 143 of file RouteTreeNode.hpp.

                                          {
             mDepth += adjustment;
             if (mOnlyChild != 0) mOnlyChild->adjustDepth(adjustment);
             else if (mChildren != 0) {
                 RouteTreeNodeIterator p = mChildren->begin();
                 RouteTreeNodeIterator e = mChildren->end();
                 while (p < e) {
                     (*p)->adjustDepth(adjustment);
                     p++;
                 }
             }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

const Arc& torc::router::RouteNode::getArc ( ) const

inlineinherited

Get the associated Arc.

Definition at line 80 of file RouteNode.hpp.

80 { return mArc; }

torc::router::RouteNode::mArc

architecture::Arc mArc

Arc that this node describes.

Definition: RouteNode.hpp:50

Here is the caller graph for this function:

RouteTreeNode* torc::router::RouteTreeNode::getChild ( unsigned int index )

inline

Get a child by index, returns 0 for invalid index.

Definition at line 129 of file RouteTreeNode.hpp.

                                                     {
             if (mOnlyChild != 0 && index == 0) return mOnlyChild;
             if (mChildren != 0 && index < mChildren->size()) return (*mChildren)[index];
             return 0;
         }

Here is the caller graph for this function:

const boost::int32_t torc::router::RouteNode::getCost ( ) const

inlineinherited

Get the heuristic node cost.

Definition at line 86 of file RouteNode.hpp.

86 { return mCost; }

torc::router::RouteNode::mCost

boost::int32_t mCost

Cost associated with this arc.

Definition: RouteNode.hpp:52

Here is the caller graph for this function:

const boost::int32_t torc::router::RouteNode::getDepth ( ) const

inlineinherited

Get the node depth.

Definition at line 94 of file RouteNode.hpp.

94 { return mDepth; }

torc::router::RouteNode::mDepth

boost::int32_t mDepth

Depth of node from the source.

Definition: RouteNode.hpp:56

Here is the caller graph for this function:

boost::uint16_t torc::router::RouteTreeNode::getNumChildren ( )

inline

Get the number of children.

Definition at line 123 of file RouteTreeNode.hpp.

                                        {
             if (mOnlyChild != 0) return 1;
             else if (mChildren == 0) return 0;
             return mChildren->size();
         }

Here is the caller graph for this function:

RouteNode* torc::router::RouteNode::getParent ( ) const

inlineinherited

Get the node's parent.

Definition at line 98 of file RouteNode.hpp.

98 { return mParent; }

torc::router::RouteNode::mParent

RouteNode * mParent

Pointer to parent node.

Definition: RouteNode.hpp:58

Here is the caller graph for this function:

const boost::int32_t torc::router::RouteNode::getPathCost ( ) const

inlineinherited

Get the path cost.

Definition at line 90 of file RouteNode.hpp.

90 { return mPathCost; }

torc::router::RouteNode::mPathCost

boost::int32_t mPathCost

Path cost for this arc.

Definition: RouteNode.hpp:54

Here is the caller graph for this function:

const Tilewire& torc::router::RouteNode::getSinkTilewire ( void ) const

inlineinherited

Get the sink Tilewire.

Definition at line 84 of file RouteNode.hpp.

84 { return mArc.getSinkTilewire(); }

torc::architecture::Arc::getSinkTilewire

const Tilewire & getSinkTilewire(void) const

Returns the sink tilewire.

Definition: Arc.hpp:47

torc::router::RouteNode::mArc

architecture::Arc mArc

Arc that this node describes.

Definition: RouteNode.hpp:50

Here is the call graph for this function:

Here is the caller graph for this function:

const Tilewire& torc::router::RouteNode::getSourceTilewire ( ) const

inlineinherited

Get the source Tilewire.

Definition at line 82 of file RouteNode.hpp.

82 { return mArc.getSourceTilewire(); }

torc::architecture::Arc::getSourceTilewire

const Tilewire & getSourceTilewire(void) const

Returns the source tilewire.

Definition: Arc.hpp:45

torc::router::RouteNode::mArc

architecture::Arc mArc

Arc that this node describes.

Definition: RouteNode.hpp:50

Here is the call graph for this function:

Here is the caller graph for this function:

RouteNode* torc::router::RouteNode::getTop ( )

inlineinherited

Return the top node by tracing parent pointers.

Definition at line 100 of file RouteNode.hpp.

                             {
             RouteNode* top = this;
             while (top->mParent != 0) top = top->mParent;
             return top;
         }

Here is the caller graph for this function:

void torc::router::RouteTreeNode::makeParent	(	const Tilewire &	inSource,
		const Tilewire &	inSink
	)

inline

Allocate a new node and make it the parent of this node.

Definition at line 115 of file RouteTreeNode.hpp.

                                                                           {
             //mArc = Arc(inSource, inSink); // DON'T WANT TO DO THIS
             //mParent = new RouteTreeNode(mArc.getSourceTilewire(), Tilewire::sInvalid, 0, 0);
             mParent = new RouteTreeNode(inSource, inSink, 0, 0);
             ((RouteTreeNode*)mParent)->mOnlyChild = this;
             ((RouteTreeNode*)mParent)->mDepth = mDepth - 1;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::router::RouteTreeNode::normalizeDepth ( )

inline

Normalize depth of nodes.

Definition at line 135 of file RouteTreeNode.hpp.

                               {
             RouteTreeNode* top = (RouteTreeNode*) getTop();
             int topDepth = top->mDepth;
             if (topDepth == 0) return;
             top->adjustDepth(-topDepth);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

bool torc::router::RouteNode::operator< ( const RouteNode * rhs ) const

inlineinherited

Definition at line 105 of file RouteNode.hpp.

                                                     {
             return (mCost < rhs->mCost);
         }

void torc::router::RouteNode::setCost ( boost::int32_t inHeuristicCost )

inlineinherited

Set the heuristic node cost.

Definition at line 88 of file RouteNode.hpp.

88 { mCost = inHeuristicCost; }

torc::router::RouteNode::mCost

boost::int32_t mCost

Cost associated with this arc.

Definition: RouteNode.hpp:52

Here is the caller graph for this function:

void torc::router::RouteNode::setDepth ( boost::int32_t inDepth )

inlineinherited

Set the node depth.

Definition at line 96 of file RouteNode.hpp.

96 { mDepth = inDepth; }

torc::router::RouteNode::mDepth

boost::int32_t mDepth

Depth of node from the source.

Definition: RouteNode.hpp:56

void torc::router::RouteNode::setPathCost ( boost::int32_t inPathCost )

inlineinherited

Set the path cost.

Definition at line 92 of file RouteNode.hpp.

92 { mPathCost = inPathCost; }

torc::router::RouteNode::mPathCost

boost::int32_t mPathCost

Path cost for this arc.

Definition: RouteNode.hpp:54

Field Documentation

architecture::Arc torc::router::RouteNode::mArc

protectedinherited

Arc that this node describes.

Definition at line 50 of file RouteNode.hpp.

std::vector<RouteTreeNode*>* torc::router::RouteTreeNode::mChildren

protected

Pointer to a vector of child nodes that is dynamically allocated.

Definition at line 45 of file RouteTreeNode.hpp.

boost::int32_t torc::router::RouteNode::mCost

protectedinherited

Cost associated with this arc.

Definition at line 52 of file RouteNode.hpp.

boost::int32_t torc::router::RouteNode::mDepth

protectedinherited

Depth of node from the source.

Definition at line 56 of file RouteNode.hpp.

RouteTreeNode* torc::router::RouteTreeNode::mOnlyChild

protected

Pointer to a child node that is the only one.

Definition at line 43 of file RouteTreeNode.hpp.

RouteNode* torc::router::RouteNode::mParent

protectedinherited

Pointer to parent node.

Definition at line 58 of file RouteNode.hpp.

boost::int32_t torc::router::RouteNode::mPathCost

protectedinherited

Path cost for this arc.

Definition at line 54 of file RouteNode.hpp.

The documentation for this class was generated from the following file:

RouteTreeNode.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation