TimingModel

Object
- com.xilinx.rapidwright.timing.TimingModel

```
public class TimingModel
extends Object
```
A TimingModel calculates net delay by implementing the lightweight timing model described in our FPT'19 paper.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TimingModel.GetTileAt

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TimingModel.GetTileAt`

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`BOUNCE_DELAY`
`float`	`CARRY_CO_DELAY`
`boolean`	`debug`
`boolean`	`debugFile`
`int`	`FAR_MAX`
`int`	`FAR_MIN`
`HashMap<String,List<TimingGroup>>`	`forDebugTimingGroupByPorts`
`float`	`LOGIC_FF_DELAY`
`float`	`LOGIC_LUT_A1_DELAY`
`float`	`LOGIC_LUT_A2_DELAY`
`float`	`LOGIC_LUT_A3_DELAY`
`float`	`LOGIC_LUT_A4_DELAY`
`float`	`LOGIC_LUT_A5_DELAY`
`float`	`LOGIC_LUT_A6_DELAY`
`int`	`MID_MAX`
`int`	`MID_MIN`
`int`	`NEAR_MAX`
`int`	`NEAR_MIN`
`float`	`SITEPIN_A_I_DELAY`
`float`	`SITEPIN_A1_DELAY`
`float`	`SITEPIN_A2_DELAY`
`float`	`SITEPIN_A3_DELAY`
`float`	`SITEPIN_A4_DELAY`
`float`	`SITEPIN_A5_DELAY`
`float`	`SITEPIN_A6_DELAY`
`float`	`SITEPIN_AX_DELAY`
`float`	`SITEPIN_CKEN1_DELAY`
`float`	`SITEPIN_CKEN2_DELAY`
`float`	`SITEPIN_CKEN3_DELAY`
`float`	`SITEPIN_CKEN4_DELAY`
`float`	`SITEPIN_SRST1_DELAY`
`float`	`SITEPIN_SRST2_DELAY`
`float`	`SITEPIN_WCKEN_DELAY`
`static String`	`TIMING_DATA_DIR`
`boolean`	`verbose`

Constructor Summary

Constructors
Constructor and Description

TimingModel(Device device)
A TimingModel is the object for calculating the net delay between two pins on a net.

Constructors
Constructor and Description
`TimingModel(Device device)` A TimingModel is the object for calculating the net delay between two pins on a net.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`build()` This performs the initialization of the timing model.
`float`	`calcDelay(List<TimingGroup> groups)` Estimates the delay of a timing group in picoseconds.
`float`	`calcDelay(SitePinInst startPinInst, SitePinInst endPinInst, BELPin sourceBELPin, BELPin sinkBELPin, List<TimingGroup> groups)` Estimates the delay of a timing group in picoseconds.
`float`	`calcDelay(SitePinInst startPinInst, SitePinInst endPinInst, BELPin sourceBELPin, BELPin sinkBELPin, Net net)` Calculates the delay in picoseconds between a pair of pins on a physical "Net" object.
`float`	`calcDelay(SitePinInst startPinInst, SitePinInst endPinInst, Net net)` Calculates the delay in picoseconds between a pair of pins on a physical "Net" object.
`float`	`calcDelay(TimingGroup tGroup)` Estimates the delay of a timing group in picoseconds.
`int`	`checkTileType(Tile testT, GroupDelayType swt)` This checks in the horizontal direction a given tile and returns the value associated with type of tile used by the model.
`int`	`computeHorizontalDistFromArray(int left, int right, GroupDelayType swt)` Computes the Horizontal Distance used later by the delay calculation.
`int`	`computeVerticalDistFromArray(int top, int bottom, GroupDelayType swt)` Computes the Vertical Distance used later by the delay calculation.
`TimingGroup[]`	`filter(GroupDistance groupDistance, TimingDirection targetDirection, TimingGroup[] unfiltered)` Used for the router example to filter the unfiltered list based on a given group direction and given distance.
`TimingGroup[]`	`filter(int targetDist, TimingDirection targetDirection, TimingGroup[] unfiltered)` Used for the router example to filter the unfiltered list based on a given direction and given distance.
`TimingGroup[]`	`filter(TimingDirection targetDirection, TimingGroup[] unfiltered)` Used for the router example to filter the unfiltered list based on a given direction.
`DelayModel`	`getDelayModel()`
`Map<GroupDelayType,List<Short>>`	`getDistArrayInIntTileGrid(int maxCoor, int[] sDistArray, int[] dDistArray, int[] qDistArray, int[] lDistArray, int step, Pattern pattern, TimingModel.GetTileAt tileAt)`
`Map<GroupDelayType,List<Short>>`	`getHorDistArrayInIntTileGrid()`
`Map<GroupDelayType,Float>`	`getHorK0Coefficients()`
`Map<GroupDelayType,Float>`	`getHorK1Coefficients()`
`Map<GroupDelayType,Float>`	`getHorK2Coefficients()`
`Map<GroupDelayType,Short>`	`getHorLCoefficients()`
`Map<String,Short>`	`getInputSitePinDelay()`
`float`	`getIntraSiteDelay()`
`Tile`	`getRefIntTile()` Get the interconnect tile used as the starting point to point the model.
`TimingManager`	`getTimingManager()` Gets the TimingManager that created this TimingModel object.
`Map<GroupDelayType,List<Short>>`	`getVerDistArrayInIntTileGrid()`
`Map<GroupDelayType,Float>`	`getVerK0Coefficients()`
`Map<GroupDelayType,Float>`	`getVerK1Coefficients()`
`Map<GroupDelayType,Float>`	`getVerK2Coefficients()`
`Map<GroupDelayType,Short>`	`getVerLCoefficients()`

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - debug
```
public boolean debug
```
  - debugFile
```
public boolean debugFile
```
  - verbose
```
public boolean verbose
```
  - TIMING_DATA_DIR
```
public static final String TIMING_DATA_DIR
```
    See Also:
    
    Constant Field Values
  - BOUNCE_DELAY
```
public float BOUNCE_DELAY
```
  - LOGIC_FF_DELAY
```
public float LOGIC_FF_DELAY
```
  - CARRY_CO_DELAY
```
public float CARRY_CO_DELAY
```
  - LOGIC_LUT_A1_DELAY
```
public float LOGIC_LUT_A1_DELAY
```
  - LOGIC_LUT_A2_DELAY
```
public float LOGIC_LUT_A2_DELAY
```
  - LOGIC_LUT_A3_DELAY
```
public float LOGIC_LUT_A3_DELAY
```
  - LOGIC_LUT_A4_DELAY
```
public float LOGIC_LUT_A4_DELAY
```
  - LOGIC_LUT_A5_DELAY
```
public float LOGIC_LUT_A5_DELAY
```
  - LOGIC_LUT_A6_DELAY
```
public float LOGIC_LUT_A6_DELAY
```
  - SITEPIN_A1_DELAY
```
public float SITEPIN_A1_DELAY
```
  - SITEPIN_A2_DELAY
```
public float SITEPIN_A2_DELAY
```
  - SITEPIN_A3_DELAY
```
public float SITEPIN_A3_DELAY
```
  - SITEPIN_A4_DELAY
```
public float SITEPIN_A4_DELAY
```
  - SITEPIN_A5_DELAY
```
public float SITEPIN_A5_DELAY
```
  - SITEPIN_A6_DELAY
```
public float SITEPIN_A6_DELAY
```
  - SITEPIN_A_I_DELAY
```
public float SITEPIN_A_I_DELAY
```
  - SITEPIN_AX_DELAY
```
public float SITEPIN_AX_DELAY
```
  - SITEPIN_CKEN1_DELAY
```
public float SITEPIN_CKEN1_DELAY
```
  - SITEPIN_CKEN2_DELAY
```
public float SITEPIN_CKEN2_DELAY
```
  - SITEPIN_CKEN3_DELAY
```
public float SITEPIN_CKEN3_DELAY
```
  - SITEPIN_CKEN4_DELAY
```
public float SITEPIN_CKEN4_DELAY
```
  - SITEPIN_SRST1_DELAY
```
public float SITEPIN_SRST1_DELAY
```
  - SITEPIN_SRST2_DELAY
```
public float SITEPIN_SRST2_DELAY
```
  - SITEPIN_WCKEN_DELAY
```
public float SITEPIN_WCKEN_DELAY
```
  - NEAR_MIN
```
public int NEAR_MIN
```
  - NEAR_MAX
```
public int NEAR_MAX
```
  - MID_MIN
```
public int MID_MIN
```
  - MID_MAX
```
public int MID_MAX
```
  - FAR_MIN
```
public int FAR_MIN
```
  - FAR_MAX
```
public int FAR_MAX
```
  - forDebugTimingGroupByPorts
```
public HashMap<String,List<TimingGroup>> forDebugTimingGroupByPorts
```
- Constructor Detail
  - TimingModel
```
public TimingModel(Device device)
```
    A TimingModel is the object for calculating the net delay between two pins on a net.
    
    Parameters:
    
    device - A device supported by RapidWright.
- Method Detail
  - build
```
public void build()
```
    This performs the initialization of the timing model. Based on the selected device some data structures for the model are initialized.
  - getRefIntTile
```
public Tile getRefIntTile()
```
    Get the interconnect tile used as the starting point to point the model. The tile must have SLICE on both sides.
    
    Returns:
    
    an interconnect tile
  - calcDelay
```
public float calcDelay(SitePinInst startPinInst,
                       SitePinInst endPinInst,
                       Net net)
```
    Calculates the delay in picoseconds between a pair of pins on a physical "Net" object.
    
    Parameters:
    
    startPinInst - Source SitePinInst from the Net.
    
    endPinInst - A selected sink SitePinInst from the Net.
    
    net - RapidWright physical "Net" object.
    
    Returns:
    
    The estimated delay in picoseconds.
  - calcDelay
```
public float calcDelay(SitePinInst startPinInst,
                       SitePinInst endPinInst,
                       BELPin sourceBELPin,
                       BELPin sinkBELPin,
                       Net net)
```
    Calculates the delay in picoseconds between a pair of pins on a physical "Net" object.
    
    Parameters:
    
    startPinInst - Source SitePinInst from the Net.
    
    endPinInst - A selected sink SitePinInst from the Net.
    
    sourceBELPin - The site BELPin connected to the source SitePinInst.
    
    sinkBELPin - The site BELPin connected to the sink SitePinInst.
    
    net - RapidWright physical "Net" object.
    
    Returns:
    
    The estimated delay in picoseconds.
  - computeHorizontalDistFromArray
```
public int computeHorizontalDistFromArray(int left,
                                          int right,
                                          GroupDelayType swt)
```
    Computes the Horizontal Distance used later by the delay calculation. Please note the initial distance terms are integers.
    
    Parameters:
    
    left - Leftmost tile column coordinate of a wire within a TimingGroup.
    
    right - Rightmost tile column coordinate of a wire within a TimingGroup.
    
    swt - Type of TimingGroup, for example SINGLE, DOUBLE, etc. The type is enumerated.
    
    Returns:
    
    Distance term used by the delay calculation.
  - computeVerticalDistFromArray
```
public int computeVerticalDistFromArray(int top,
                                        int bottom,
                                        GroupDelayType swt)
```
    Computes the Vertical Distance used later by the delay calculation. Please note the initial distance terms are integers.
    
    Parameters:
    
    top - Topmost tile column coordinate of a wire within a TimingGroup.
    
    bottom - Bottom most tile column coordinate of a wire within a TimingGroup.
    
    swt - Type of TimingGroup, for example SINGLE, DOUBLE, etc. The type is enumerated.
    
    Returns:
    
    Distance term used by the delay calculation.
  - getInputSitePinDelay
```
public Map<String,Short> getInputSitePinDelay()
```
  - getHorK0Coefficients
```
public Map<GroupDelayType,Float> getHorK0Coefficients()
```
  - getHorK1Coefficients
```
public Map<GroupDelayType,Float> getHorK1Coefficients()
```
  - getHorK2Coefficients
```
public Map<GroupDelayType,Float> getHorK2Coefficients()
```
  - getHorLCoefficients
```
public Map<GroupDelayType,Short> getHorLCoefficients()
```
  - getVerK0Coefficients
```
public Map<GroupDelayType,Float> getVerK0Coefficients()
```
  - getVerK1Coefficients
```
public Map<GroupDelayType,Float> getVerK1Coefficients()
```
  - getVerK2Coefficients
```
public Map<GroupDelayType,Float> getVerK2Coefficients()
```
  - getVerLCoefficients
```
public Map<GroupDelayType,Short> getVerLCoefficients()
```
  - getHorDistArrayInIntTileGrid
```
public Map<GroupDelayType,List<Short>> getHorDistArrayInIntTileGrid()
```
  - getVerDistArrayInIntTileGrid
```
public Map<GroupDelayType,List<Short>> getVerDistArrayInIntTileGrid()
```
  - getDistArrayInIntTileGrid
```
public Map<GroupDelayType,List<Short>> getDistArrayInIntTileGrid(int maxCoor,
                                                                 int[] sDistArray,
                                                                 int[] dDistArray,
                                                                 int[] qDistArray,
                                                                 int[] lDistArray,
                                                                 int step,
                                                                 Pattern pattern,
                                                                 TimingModel.GetTileAt tileAt)
```
  - checkTileType
```
public int checkTileType(Tile testT,
                         GroupDelayType swt)
```
    This checks in the horizontal direction a given tile and returns the value associated with type of tile used by the model.
    
    Parameters:
    
    testT - Test tile to check the type.
    
    swt - Type of the TimingGroup crossing the given tile.
    
    Returns:
    
    The value used by the model for the given tile type and also based on the type of TimingGroup.
  - calcDelay
```
public float calcDelay(TimingGroup tGroup)
```
    Estimates the delay of a timing group in picoseconds.
    
    Parameters:
    
    tGroup - TimingGroup to be analyzed.
    
    Returns:
    
    Estimated delay in picoseconds.
  - calcDelay
```
public float calcDelay(List<TimingGroup> groups)
```
    Estimates the delay of a timing group in picoseconds.
    
    Parameters:
    
    groups - List of TimingGroups to be analyzed.
    
    Returns:
    
    Estimated delay in picoseconds.
  - getIntraSiteDelay
```
public float getIntraSiteDelay()
```
  - getDelayModel
```
public DelayModel getDelayModel()
```
  - calcDelay
```
public float calcDelay(SitePinInst startPinInst,
                       SitePinInst endPinInst,
                       BELPin sourceBELPin,
                       BELPin sinkBELPin,
                       List<TimingGroup> groups)
```
    Estimates the delay of a timing group in picoseconds.
    
    Parameters:
    
    startPinInst - Source pin as a SitePinInst for the physical Net.
    
    endPinInst - Sink pin as a SitePinInst for the physical Net.
    
    groups - List of TimingGroups to be analyzed.
    
    Returns:
    
    Estimated delay in picoseconds.
  - filter
```
public TimingGroup[] filter(TimingDirection targetDirection,
                            TimingGroup[] unfiltered)
```
    Used for the router example to filter the unfiltered list based on a given direction.
    
    Parameters:
    
    targetDirection - Enumerated type TimingDirection representing the given direction.
    
    unfiltered - Unfiltered array of TimingGroup objects.
    
    Returns:
    
    Filtered array of TimingGroup objects in the given direction.
  - filter
```
public TimingGroup[] filter(int targetDist,
                            TimingDirection targetDirection,
                            TimingGroup[] unfiltered)
```
    Used for the router example to filter the unfiltered list based on a given direction and given distance.
    
    Parameters:
    
    targetDist - The given distance for filtering.
    
    targetDirection - Enumerated type TimingDirection representing the given direction.
    
    unfiltered - Unfiltered array of TimingGroup objects.
    
    Returns:
    
    Filtered array of TimingGroup objects in the given distance and direction.
  - filter
```
public TimingGroup[] filter(GroupDistance groupDistance,
                            TimingDirection targetDirection,
                            TimingGroup[] unfiltered)
```
    Used for the router example to filter the unfiltered list based on a given group direction and given distance.
    
    Parameters:
    
    groupDistance - Enumerated type for given group distance for filtering.
    
    targetDirection - Enumerated type TimingDirection representing the given direction.
    
    unfiltered - Unfiltered array of TimingGroup objects.
    
    Returns:
    
    Filtered array of TimingGroup objects in the given group distance and direction.
  - getTimingManager
```
public TimingManager getTimingManager()
```
    Gets the TimingManager that created this TimingModel object.
    
    Returns:
    
    TimingManager that created this TimingModel.

Class TimingModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

debug

debugFile

verbose

TIMING_DATA_DIR

BOUNCE_DELAY

LOGIC_FF_DELAY

CARRY_CO_DELAY

LOGIC_LUT_A1_DELAY

LOGIC_LUT_A2_DELAY

LOGIC_LUT_A3_DELAY

LOGIC_LUT_A4_DELAY

LOGIC_LUT_A5_DELAY

LOGIC_LUT_A6_DELAY

SITEPIN_A1_DELAY

SITEPIN_A2_DELAY

SITEPIN_A3_DELAY

SITEPIN_A4_DELAY

SITEPIN_A5_DELAY

SITEPIN_A6_DELAY

SITEPIN_A_I_DELAY

SITEPIN_AX_DELAY

SITEPIN_CKEN1_DELAY

SITEPIN_CKEN2_DELAY

SITEPIN_CKEN3_DELAY

SITEPIN_CKEN4_DELAY

SITEPIN_SRST1_DELAY

SITEPIN_SRST2_DELAY

SITEPIN_WCKEN_DELAY

NEAR_MIN

NEAR_MAX

MID_MIN

MID_MAX

FAR_MIN

FAR_MAX

forDebugTimingGroupByPorts

Constructor Detail

TimingModel

Method Detail

build

getRefIntTile

calcDelay

calcDelay

computeHorizontalDistFromArray

computeVerticalDistFromArray

getInputSitePinDelay

getHorK0Coefficients

getHorK1Coefficients

getHorK2Coefficients

getHorLCoefficients

getVerK0Coefficients

getVerK1Coefficients

getVerK2Coefficients

getVerLCoefficients

getHorDistArrayInIntTileGrid

getVerDistArrayInIntTileGrid

getDistArrayInIntTileGrid

checkTileType

calcDelay

calcDelay

getIntraSiteDelay

getDelayModel

calcDelay

filter

filter

filter

getTimingManager