RouteNode

Object
- com.xilinx.rapidwright.rwroute.RouteNode

All Implemented Interfaces:

Comparable<RouteNode>
```
public abstract class RouteNode
extends Object
implements Comparable<RouteNode>
```
A RouteNode Object corresponds to a vertex of the routing resource graph. Each RouteNode instance is associated with a Node instance. It is denoted as "rnode". The routing resource graph is built "lazily", i.e., RouteNode Objects (rnodes) are created when needed.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`capacity` Each RouteNode Object can be legally used by one net only
`static RouteNode[]`	`EMPTY_ARRAY` Memoized static array for use by Collection.toArray() or similar
`static int`	`initialHistoricalCongestionCost`
`static int`	`initialPresentCongestionCost`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearPrev()` Clears the parent RouteNode instance.
`int`	`compareTo(RouteNode that)`
`int`	`countConnectionsOfUser(NetWrapper user)` Counts the connections of a user that are using a rnode.
`void`	`decrementDriver(RouteNode parent)` Decrements the driver count of a RouteNode instance.
`void`	`decrementUser(NetWrapper user)` Decrements the connection count of a user that is represented by a `NetWrapper` instance corresponding to a `Net` instance.
`boolean`	`equals(Object obj)`
`boolean`	`everExpanded()` Checks if a RouteNode instance has ever been expanded, as determined by whether its children member is null.
`float`	`getBaseCost()` Gets the base cost of a RouteNode Object.
`short`	`getBeginTileXCoordinate()`
`short`	`getBeginTileYCoordinate()`
`RouteNode[]`	`getChildren()` Gets the children of a RouteNode Object.
`float`	`getDelay()` Gets the delay of a RouteNode Object.
`short`	`getEndTileXCoordinate()` Gets the x coordinate of the INT `Tile` instance that the associated `Node` instance stops at.
`short`	`getEndTileYCoordinate()` Gets the Y coordinate of the INT `Tile` instance that the associated `Node` instance stops at.
`boolean`	`getFlag(int index)`
`float`	`getHistoricalCongestionCost()` Gets the historical congestion cost of a RouteNode Object.
`short`	`getLength()` Gets the wirelength.
`static short`	`getLength(Node node)`
`float`	`getLowerBoundTotalPathCost()` Gets the lower bound total path cost.
`Node`	`getNode()` Gets the associated Node of a RouteNode Object.
`int`	`getOccupancy()` Gets the number of users.
`float`	`getPresentCongestionCost()` Gets the present congestion cost of a RouteNode Object.
`RouteNode`	`getPrev()` Gets the parent RouteNode instance for routing a connection.
`abstract int`	`getSLRIndex()`
`RouteNodeType`	`getType()` Gets the type of a RouteNode Object.
`float`	`getUpstreamPathCost()` Gets the upstream path cost.
`Map<NetWrapper,Integer>`	`getUsersConnectionCounts()` Gets a map that records users of a `RouteNode` instance based on all routed connections.
`int`	`hashCode()`
`boolean`	`hasMultiDrivers()` Checks if a RouteNode Object are illegally driven by multiple drivers.
`void`	`incrementDriver(RouteNode parent)` Adds a driver to the driver map.
`void`	`incrementUser(NetWrapper user)` Adds an user `NetWrapper` instance to the user map, of which a key is a `NetWrapper` instance and the value is the number of connections that are using a rnode.
`abstract boolean`	`isExcluded(Node parent, Node child)` Checks if a routing arc has been excluded thus cannot be used.
`static boolean`	`isExitNode(Node node)` Checks if a node is an exit node of a NodeGroup
`boolean`	`isInConnectionBoundingBox(Connection connection)` Checks if coordinates of a RouteNode Object is within the connection's bounding box.
`boolean`	`isOverUsed()` Checks if a RouteNode Object has been used by more than one users.
`abstract boolean`	`isPreserved(Node node)` Checks if a node has been preserved and thus cannot be used.
`boolean`	`isTarget()` Checks if a RouteNode Object is the current routing target.
`boolean`	`isUsed()` Checks if a RouteNode Object has been used.
`boolean`	`isVisited(int id)` Checks if a RouteNode instance has been visited by a specific integer identifier.
`abstract boolean`	`mustInclude(Node parent, Node child)` Checks if a routing arc must be included.
`void`	`resetChildren()` Clears the children of this node so that it can be regenerated.
`void`	`setFlag(int index, boolean value)`
`void`	`setHistoricalCongestionCost(float historicalCongestionCost)` Gets the historical congestion cost of a RouteNode Object.
`void`	`setLowerBoundTotalPathCost(float totalPathCost)` Sets the lower bound total path cost.
`void`	`setPresentCongestionCost(float presentCongestionCost)` Sets the present congestion cost of a RouteNode Object.
`void`	`setPrev(RouteNode prev)` Sets the parent RouteNode instance for routing a connection.
`void`	`setTarget(boolean isTarget)` Sets the boolean value of target.
`void`	`setUpstreamPathCost(float newPartialPathCost)` Sets the upstream path cost.
`void`	`setVisited(int id)` Mark a RouteNode instance as being visited by a specific integer identifier.
`String`	`toString()`
`int`	`uniqueDriverCount()` Gets the number of unique drivers.
`int`	`uniqueUserCount()` Gets the number of unique users.
`void`	`updatePresentCongestionCost(float pres_fac)` Updates the present congestion cost based on the present congestion penalty factor.
`boolean`	`willOverUse(NetWrapper netWrapper)`

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - capacity
```
public static final short capacity
```
    Each RouteNode Object can be legally used by one net only
    
    See Also:
    
    Constant Field Values
  - EMPTY_ARRAY
```
public static final RouteNode[] EMPTY_ARRAY
```
    Memoized static array for use by Collection.toArray() or similar
  - initialPresentCongestionCost
```
public static final int initialPresentCongestionCost
```
    See Also:
    
    Constant Field Values
  - initialHistoricalCongestionCost
```
public static final int initialHistoricalCongestionCost
```
    See Also:
    
    Constant Field Values
- Method Detail
  - compareTo
```
public int compareTo(RouteNode that)
```
    Specified by:
    
    compareTo in interface Comparable<RouteNode>
  - isOverUsed
```
public boolean isOverUsed()
```
    Checks if a RouteNode Object has been used by more than one users.
    
    Returns:
    
    true, if a RouteNode Object has been used by multiple users.
  - willOverUse
```
public boolean willOverUse(NetWrapper netWrapper)
```
  - isUsed
```
public boolean isUsed()
```
    Checks if a RouteNode Object has been used.
    
    Returns:
    
    true, if a RouteNode Object has been used.
  - hasMultiDrivers
```
public boolean hasMultiDrivers()
```
    Checks if a RouteNode Object are illegally driven by multiple drivers.
    
    Returns:
    
    true, if a RouteNode Object has multiple drivers.
  - getLength
```
public static short getLength(Node node)
```
  - updatePresentCongestionCost
```
public void updatePresentCongestionCost(float pres_fac)
```
    Updates the present congestion cost based on the present congestion penalty factor.
    
    Parameters:
    
    pres_fac - The present congestion penalty factor.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isInConnectionBoundingBox
```
public boolean isInConnectionBoundingBox(Connection connection)
```
    Checks if coordinates of a RouteNode Object is within the connection's bounding box.
    
    Parameters:
    
    connection - The connection that is being routed.
    
    Returns:
    
    true, if coordinates of a RouteNode is within the connection's bounding box.
  - getNode
```
public Node getNode()
```
    Gets the associated Node of a RouteNode Object.
    
    Returns:
    
    The associated Node of a RouteNode Object.
  - isTarget
```
public boolean isTarget()
```
    Checks if a RouteNode Object is the current routing target.
    
    Returns:
    
    true, if a RouteNode Object is the current routing target.
  - setTarget
```
public void setTarget(boolean isTarget)
```
    Sets the boolean value of target.
    
    Parameters:
    
    isTarget - The value to be set.
  - getType
```
public RouteNodeType getType()
```
    Gets the type of a RouteNode Object.
    
    Returns:
    
    The RouteNodeType of a RouteNode Object.
  - getDelay
```
public float getDelay()
```
    Gets the delay of a RouteNode Object.
    
    Returns:
    
    The delay of a RouteNode Object.
  - getBeginTileXCoordinate
```
public short getBeginTileXCoordinate()
```
  - getBeginTileYCoordinate
```
public short getBeginTileYCoordinate()
```
  - getEndTileXCoordinate
```
public short getEndTileXCoordinate()
```
    Gets the x coordinate of the INT Tile instance that the associated Node instance stops at.
    
    Returns:
    
    The tileXCoordinate of the INT tile that the associated Node instance stops at.
  - getEndTileYCoordinate
```
public short getEndTileYCoordinate()
```
    Gets the Y coordinate of the INT Tile instance that the associated Node instance stops at. For bidirectional nodes, the prev member is used to determine the end node.
    
    Returns:
    
    The tileYCoordinate of the INT tile that the associated Node instance stops at.
  - getBaseCost
```
public float getBaseCost()
```
    Gets the base cost of a RouteNode Object.
    
    Returns:
    
    The base cost of a RouteNode Object.
  - getChildren
```
public RouteNode[] getChildren()
```
    Gets the children of a RouteNode Object.
    
    Returns:
    
    A list of RouteNode Objects.
  - resetChildren
```
public void resetChildren()
```
    Clears the children of this node so that it can be regenerated.
  - getLength
```
public short getLength()
```
    Gets the wirelength.
    
    Returns:
    
    The wirelength, i.e. the number of INT tiles that the associated Node instance spans.
  - setLowerBoundTotalPathCost
```
public void setLowerBoundTotalPathCost(float totalPathCost)
```
    Sets the lower bound total path cost.
    
    Parameters:
    
    totalPathCost - The cost value to be set.
  - setUpstreamPathCost
```
public void setUpstreamPathCost(float newPartialPathCost)
```
    Sets the upstream path cost.
    
    Parameters:
    
    newPartialPathCost - The new value to be set.
  - getLowerBoundTotalPathCost
```
public float getLowerBoundTotalPathCost()
```
    Gets the lower bound total path cost.
    
    Returns:
    
    The lower bound total path cost.
  - getUpstreamPathCost
```
public float getUpstreamPathCost()
```
    Gets the upstream path cost.
    
    Returns:
    
    The upstream path cost.
  - getUsersConnectionCounts
```
public Map<NetWrapper,Integer> getUsersConnectionCounts()
```
    Gets a map that records users of a RouteNode instance based on all routed connections. Each user is a NetWrapper instance representing a Net instance. It is often the case that multiple connections of a net are using a same rnode. So we count connections of each user to facilitate the sharing mechanism of RWRoute.
    
    Returns:
    
    A map between users, i.e., NetWrapper instances representing by Net instances, and numbers of connections from different users.
  - incrementUser
```
public void incrementUser(NetWrapper user)
```
    Adds an user NetWrapper instance to the user map, of which a key is a NetWrapper instance and the value is the number of connections that are using a rnode. If the user is already stored in the map, increment the connection count of the user by 1. Otherwise, put the user into the map and initialize the connection count as 1.
    
    Parameters:
    
    user - The user net in question.
  - uniqueUserCount
```
public int uniqueUserCount()
```
    Gets the number of unique users.
    
    Returns:
    
    The number of unique NetWrapper instances in the user map, i.e, the key set size of the user map.
  - decrementUser
```
public void decrementUser(NetWrapper user)
```
    Decrements the connection count of a user that is represented by a NetWrapper instance corresponding to a Net instance. If there is only one connection of the user that is using a RouteNode instance, remove the user from the map. Otherwise, decrement the connection count by 1.
    
    Parameters:
    
    user - The user to be decremented from the user map.
  - countConnectionsOfUser
```
public int countConnectionsOfUser(NetWrapper user)
```
    Counts the connections of a user that are using a rnode.
    
    Parameters:
    
    user - The user in question indicated by a NetWrapper instance.
    
    Returns:
    
    The total number of connections of the user.
  - uniqueDriverCount
```
public int uniqueDriverCount()
```
    Gets the number of unique drivers.
    
    Returns:
    
    The number of unique drivers of a rnode, i.e., the key set size of the driver map
  - incrementDriver
```
public void incrementDriver(RouteNode parent)
```
    Adds a driver to the driver map.
    
    Parameters:
    
    parent - The driver to be added.
  - decrementDriver
```
public void decrementDriver(RouteNode parent)
```
    Decrements the driver count of a RouteNode instance.
    
    Parameters:
    
    parent - The driver that should have its count reduced by 1.
  - getOccupancy
```
public int getOccupancy()
```
    Gets the number of users.
    
    Returns:
    
    The number of users.
  - getPrev
```
public RouteNode getPrev()
```
    Gets the parent RouteNode instance for routing a connection.
    
    Returns:
    
    The driving RouteNode instance.
  - setPrev
```
public void setPrev(RouteNode prev)
```
    Sets the parent RouteNode instance for routing a connection.
    
    Parameters:
    
    prev - The driving RouteNode instance to set. Cannot be null.
  - clearPrev
```
public void clearPrev()
```
    Clears the parent RouteNode instance.
  - getPresentCongestionCost
```
public float getPresentCongestionCost()
```
    Gets the present congestion cost of a RouteNode Object.
    
    Returns:
    
    The present congestion of a RouteNode Object.
  - setPresentCongestionCost
```
public void setPresentCongestionCost(float presentCongestionCost)
```
    Sets the present congestion cost of a RouteNode Object.
    
    Parameters:
    
    presentCongestionCost - The present congestion cost to be set.
  - getHistoricalCongestionCost
```
public float getHistoricalCongestionCost()
```
    Gets the historical congestion cost of a RouteNode Object.
    
    Returns:
    
    The historical congestion cost of a RouteNode Object.
  - setHistoricalCongestionCost
```
public void setHistoricalCongestionCost(float historicalCongestionCost)
```
    Gets the historical congestion cost of a RouteNode Object.
    
    Parameters:
    
    historicalCongestionCost - The historical congestion cost to be set.
  - everExpanded
```
public boolean everExpanded()
```
    Checks if a RouteNode instance has ever been expanded, as determined by whether its children member is null.
    
    Returns:
    
    true, if a RouteNode instance has been expanded before.
  - isVisited
```
public boolean isVisited(int id)
```
    Checks if a RouteNode instance has been visited by a specific integer identifier.
    
    Parameters:
    
    id - Integer identifier.
    
    Returns:
    
    true, if a RouteNode instance has been visited before.
  - setVisited
```
public void setVisited(int id)
```
    Mark a RouteNode instance as being visited by a specific integer identifier.
    
    Parameters:
    
    id - Integer identifier.
  - isExitNode
```
public static boolean isExitNode(Node node)
```
    Checks if a node is an exit node of a NodeGroup
    
    Parameters:
    
    node - The node in question
    
    Returns:
    
    true, if the node is a S/D/Q/L node or a local node with a GLOBAL and CTRL wire
  - mustInclude
```
public abstract boolean mustInclude(Node parent,
                                    Node child)
```
    Checks if a routing arc must be included.
    
    Parameters:
    
    parent - The routing arc's parent node.
    
    child - The routing arc's parent node.
    
    Returns:
    
    True, if the arc should be included in the routing resource graph.
  - isPreserved
```
public abstract boolean isPreserved(Node node)
```
    Checks if a node has been preserved and thus cannot be used.
    
    Parameters:
    
    node - The node in question.
    
    Returns:
    
    True, if the arc should be excluded from the routing resource graph.
  - isExcluded
```
public abstract boolean isExcluded(Node parent,
                                   Node child)
```
    Checks if a routing arc has been excluded thus cannot be used.
    
    Parameters:
    
    parent - The routing arc's parent node.
    
    child - The routing arc's parent node.
    
    Returns:
    
    True, if the arc should be excluded from the routing resource graph.
  - getSLRIndex
```
public abstract int getSLRIndex()
```
  - getFlag
```
public boolean getFlag(int index)
```
    Parameters:
    
    index - Bit index.
    
    Returns:
    
    True if index is set.
  - setFlag
```
public void setFlag(int index,
                    boolean value)
```
    Parameters:
    
    index - Bit index to change.
    
    value - True to set. False to clear.

Class RouteNode

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

capacity

EMPTY_ARRAY

initialPresentCongestionCost

initialHistoricalCongestionCost

Method Detail

compareTo

isOverUsed

willOverUse

isUsed

hasMultiDrivers

getLength

updatePresentCongestionCost

toString

hashCode

equals

isInConnectionBoundingBox

getNode

isTarget

setTarget

getType

getDelay

getBeginTileXCoordinate

getBeginTileYCoordinate

getEndTileXCoordinate

getEndTileYCoordinate

getBaseCost

getChildren

resetChildren

getLength

setLowerBoundTotalPathCost

setUpstreamPathCost

getLowerBoundTotalPathCost

getUpstreamPathCost

getUsersConnectionCounts

incrementUser

uniqueUserCount

decrementUser

countConnectionsOfUser

uniqueDriverCount

incrementDriver

decrementDriver

getOccupancy

getPrev

setPrev

clearPrev

getPresentCongestionCost

setPresentCongestionCost

getHistoricalCongestionCost

setHistoricalCongestionCost

everExpanded

isVisited

setVisited

isExitNode

mustInclude

isPreserved

isExcluded

getSLRIndex

getFlag

setFlag