PlacerDirective

Object
- Enum<PlacerDirective>
- - com.xilinx.rapidwright.util.PlacerDirective

All Implemented Interfaces:

Serializable, Comparable<PlacerDirective>
```
public enum PlacerDirective
extends Enum<PlacerDirective>
```
These are the directives found as options to 'place_design -directive', Created on: Mar 20, 2018

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AltSpreadLogic_high` Spreads logic throughout the device to avoid creating congested regions.
`AltSpreadLogic_low` Spreads logic throughout the device to avoid creating congested regions.
`AltSpreadLogic_medium` Spreads logic throughout the device to avoid creating congested regions.
`Auto_1` Instructs place_design to use machine learning to select the best predicted directive.
`Auto_2` Instructs place_design to use machine learning to select the second best predicted directive.
`Auto_3` Instructs place_design to use machine learning to select the third best predicted directive.
`Default` Run place_design with default settings.
`EarlyBlockPlacement` Timing-driven placement of RAM and DSP blocks.
`Explore` Increased placer effort in detail placement and post-placement optimization.
`ExtraNetDelay_high` Increases estimated delay of high fanout and long-distance nets.
`ExtraNetDelay_low` Increases estimated delay of high fanout and long-distance nets.
`ExtraPostPlacementOpt` Increased placer effort in post-placement optimization.
`ExtraTimingOpt` Use an alternate algorithm for timing-driven placement with greater effort for timing.
`Quick` Absolute, fastest runtime, non-timing-driven, performs the minimum required placement for a legal design.
`RQS` Instructs place_design to select the place_design directive specified by the report_qor_suggestion strategy suggestion.
`RuntimeOptimized` Run fewest iterations, trade higher design performance for faster runtime.
`SSI_BalanceSLLs` Partition across SLRs while attempting to balance SLLs between SLRs.
`SSI_BalanceSLRs` Partition across SLRs to balance number of cells between SLRs.
`SSI_HighUtilSLRs` Direct the placer to attempt to place logic closer together in each SLR.
`SSI_SpreadLogic_high` Distribute logic across SLRs.
`SSI_SpreadLogic_low` Distribute logic across SLRs.
`SSI_SpreadSLLs` Partition across SLRs and allocate extra area for regions of higher connectivity.
`WLDrivenBlockPlacement` Wire length-driven placement of RAM and DSP blocks.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PlacerDirective`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PlacerDirective[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - Explore
```
public static final PlacerDirective Explore
```
    Increased placer effort in detail placement and post-placement optimization.
  - EarlyBlockPlacement
```
public static final PlacerDirective EarlyBlockPlacement
```
    Timing-driven placement of RAM and DSP blocks. The RAM and DSP block locations are finalized early in the placement process and are used as anchors to place the remaining logic.
  - WLDrivenBlockPlacement
```
public static final PlacerDirective WLDrivenBlockPlacement
```
    Wire length-driven placement of RAM and DSP blocks. Override timing-driven placement by directing the Vivado placer to minimize the distance of connections to and from blocks.
  - ExtraNetDelay_high
```
public static final PlacerDirective ExtraNetDelay_high
```
    Increases estimated delay of high fanout and long-distance nets. Three levels of pessimism are supported: high, medium, and low. ExtraNetDelay_high applies the highest level of pessimism.
  - ExtraNetDelay_low
```
public static final PlacerDirective ExtraNetDelay_low
```
    Increases estimated delay of high fanout and long-distance nets. Three levels of pessimism are supported: high, medium, and low. ExtraNetDelay_low applies the lowest level of pessimism.
  - AltSpreadLogic_high
```
public static final PlacerDirective AltSpreadLogic_high
```
    Spreads logic throughout the device to avoid creating congested regions. Three levels are supported: high, medium, and low. AltSpreadLogic_high achieves the highest level of spreading.
  - AltSpreadLogic_medium
```
public static final PlacerDirective AltSpreadLogic_medium
```
    Spreads logic throughout the device to avoid creating congested regions. Three levels are supported: high, medium, and low. AltSpreadLogic_medium achieves a medium level of spreading compared to low and high.
  - AltSpreadLogic_low
```
public static final PlacerDirective AltSpreadLogic_low
```
    Spreads logic throughout the device to avoid creating congested regions. Three levels are supported: high, medium, and low. AltSpreadLogic_low achieves the lowest level of spreading.
  - ExtraPostPlacementOpt
```
public static final PlacerDirective ExtraPostPlacementOpt
```
    Increased placer effort in post-placement optimization.
  - ExtraTimingOpt
```
public static final PlacerDirective ExtraTimingOpt
```
    Use an alternate algorithm for timing-driven placement with greater effort for timing.
  - SSI_SpreadLogic_high
```
public static final PlacerDirective SSI_SpreadLogic_high
```
    Distribute logic across SLRs. SSI_SpreadLogic_high achieves the highest level of distribution.
  - SSI_SpreadLogic_low
```
public static final PlacerDirective SSI_SpreadLogic_low
```
    Distribute logic across SLRs. SSI_SpreadLogic_low achieves a minimum level of logic distribution, while reducing placement runtime.
  - SSI_SpreadSLLs
```
public static final PlacerDirective SSI_SpreadSLLs
```
    Partition across SLRs and allocate extra area for regions of higher connectivity.
  - SSI_BalanceSLLs
```
public static final PlacerDirective SSI_BalanceSLLs
```
    Partition across SLRs while attempting to balance SLLs between SLRs.
  - SSI_BalanceSLRs
```
public static final PlacerDirective SSI_BalanceSLRs
```
    Partition across SLRs to balance number of cells between SLRs.
  - SSI_HighUtilSLRs
```
public static final PlacerDirective SSI_HighUtilSLRs
```
    Direct the placer to attempt to place logic closer together in each SLR.
  - RuntimeOptimized
```
public static final PlacerDirective RuntimeOptimized
```
    Run fewest iterations, trade higher design performance for faster runtime.
  - Quick
```
public static final PlacerDirective Quick
```
    Absolute, fastest runtime, non-timing-driven, performs the minimum required placement for a legal design.
  - RQS
```
public static final PlacerDirective RQS
```
    Instructs place_design to select the place_design directive specified by the report_qor_suggestion strategy suggestion. Requires an RQS file with a strategy suggestion to be read in prior to calling this directive. See report_qor_suggestions -help for more details.
  - Auto_1
```
public static final PlacerDirective Auto_1
```
    Instructs place_design to use machine learning to select the best predicted directive.
  - Auto_2
```
public static final PlacerDirective Auto_2
```
    Instructs place_design to use machine learning to select the second best predicted directive.
  - Auto_3
```
public static final PlacerDirective Auto_3
```
    Instructs place_design to use machine learning to select the third best predicted directive.
  - Default
```
public static final PlacerDirective Default
```
    Run place_design with default settings.
- Method Detail
  - values
```
public static PlacerDirective[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PlacerDirective c : PlacerDirective.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PlacerDirective valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum PlacerDirective

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

Explore

EarlyBlockPlacement

WLDrivenBlockPlacement

ExtraNetDelay_high

ExtraNetDelay_low

AltSpreadLogic_high

AltSpreadLogic_medium

AltSpreadLogic_low

ExtraPostPlacementOpt

ExtraTimingOpt

SSI_SpreadLogic_high

SSI_SpreadLogic_low

SSI_SpreadSLLs

SSI_BalanceSLLs

SSI_BalanceSLRs

SSI_HighUtilSLRs

RuntimeOptimized

Quick

RQS

Auto_1

Auto_2

Auto_3

Default

Method Detail

values

valueOf