com.xilinx.rapidwright.design.compare

Class DesignComparator

Object

com.xilinx.rapidwright.design.compare.DesignComparator

public class DesignComparator
extends Object

A physical design comparison helper class that will compare two designs' placement and routing information and keep track of the differences. Please see EDIFNetlistComparator to compare logical netlists (EDIFNetlist).

Constructor Summary

Constructors

Constructor and Description
DesignComparator()

Method Summary

Modifier and Type	Method and Description
int	compareDesigns(Design gold, Design test) Compares two designs placement and routing (according to flags, see DesignComparator.comparePlacement, DesignComparator.comparePIPs, and DesignComparator.comparePIPFlags).
int	compareNets(Net gold, Net test) Compares two nets for differences in routing (PIPs).
boolean	comparePIPFlags() Gets the comparePIPFlags flag indicating if the routing flags on a design's PIPs should be compared by DesignComparator.
int	compareSiteInsts(SiteInst gold, SiteInst test) Compares two site instances for placement and site routing differences.
boolean	getComparePlacement() Gets the comparePlacement flag indicating if a design's placement (cells, sitepips, sitewire to net mappings) should be compared by DesignComparator.
int	getDiffCount() Gets the total number of differences encountered since the last call of DesignComparator.compareDesigns(Design, Design).
List<DesignDiff>	getDiffList(DesignDiffType type)
Map<DesignDiffType,List<DesignDiff>>	getDiffMap()
void	printDiffReport(PrintStream ps) Prints an exhaustive list of diffs with specific contextual information about each difference.
void	printDiffReportSummary(PrintStream ps) Prints a summary total for each difference type found in the recent comparisons since the last time the diff counter was reset.
void	resetDiffCount()
void	setComparePIPFlags(boolean comparePIPFlags) Sets a flag to tell the design comparator if PIP flags should also be compared.
void	setComparePIPs(boolean comparePIPs) Sets a flag to tell the design comparator if PIP should be compared.
void	setComparePIPs(Predicate<Net> predicate) Set the predicate for the design comparator if PIPs should be compared for the given Net.
void	setComparePlacement(boolean comparePlacement) Sets the flag to tell the design comparator if placement (cell placements, sitePIPs, and site wire to net mappings) should be compared.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DesignComparator

public DesignComparator()

Method Detail

compareDesigns

public int compareDesigns(Design gold,
                          Design test)

Compares two designs placement and routing (according to flags, see DesignComparator.comparePlacement, DesignComparator.comparePIPs, and DesignComparator.comparePIPFlags). It will return the total number of differences encountered and an optional report can be created by subsequently calling DesignComparator.printDiffReportSummary(PrintStream) or DesignComparator.printDiffReport(PrintStream). Note that the number of differences are stored in the class and can be retrieved afterward by calling DesignComparator.getDiffCount(). Calling this method a second and subsequent times will reset the counter and tracked diffs.

Parameters:

gold - The expected design or reference.

test - The design being compared with the reference.

Returns:

The total number of differences encountered.

getDiffCount

public int getDiffCount()

Gets the total number of differences encountered since the last call of DesignComparator.compareDesigns(Design, Design).

Returns:

Total number of design differences found.

resetDiffCount

public void resetDiffCount()

comparePIPFlags

public boolean comparePIPFlags()

Gets the comparePIPFlags flag indicating if the routing flags on a design's PIPs should be compared by DesignComparator.

Returns:

True if the flag is set, false otherwise (default: false).

setComparePIPFlags

public void setComparePIPFlags(boolean comparePIPFlags)

Sets a flag to tell the design comparator if PIP flags should also be compared.

Parameters:

comparePIPFlags - Desired flag value (default: false).

setComparePIPs

public void setComparePIPs(boolean comparePIPs)

Sets a flag to tell the design comparator if PIP should be compared.

Parameters:

comparePIPs - Desired flag value (default: true).

setComparePIPs

public void setComparePIPs(Predicate<Net> predicate)

Set the predicate for the design comparator if PIPs should be compared for the given Net.

Parameters:

predicate - Predicate.

getComparePlacement

public boolean getComparePlacement()

Gets the comparePlacement flag indicating if a design's placement (cells, sitepips, sitewire to net mappings) should be compared by DesignComparator.

Returns:

True if the flag is set, false otherwise (default: true).

setComparePlacement

public void setComparePlacement(boolean comparePlacement)

Sets the flag to tell the design comparator if placement (cell placements, sitePIPs, and site wire to net mappings) should be compared.

Parameters:

comparePlacement - Desired flag value (default: true);

getDiffMap

public Map<DesignDiffType,List<DesignDiff>> getDiffMap()

getDiffList

public List<DesignDiff> getDiffList(DesignDiffType type)

compareSiteInsts

public int compareSiteInsts(SiteInst gold,
                            SiteInst test)

Compares two site instances for placement and site routing differences. Specifically it detects differences in three categories, (1) cell placements, (2) site PIPs, and (3) site wire to net mappings.

Parameters:

gold - The expected or reference site instance.

test - The site instance being compared to the reference.

Returns:

The number of differences encountered while comparing the provided site instances. This number also mutates the total diff count stored in the class.

compareNets

public int compareNets(Net gold,
                       Net test)

Compares two nets for differences in routing (PIPs). Two flags can be set to affect its operation: DesignComparator.setComparePIPs(boolean) (default: true) and DesignComparator.setComparePIPFlags(boolean) (default: false).

Parameters:

gold - The expected or reference net.

test - The net to be compared against the reference net.

Returns:

The number of differences encountered while comparing the provided nets. This number also mutates the total diff count stored in the class.

printDiffReportSummary

public void printDiffReportSummary(PrintStream ps)

Prints a summary total for each difference type found in the recent comparisons since the last time the diff counter was reset.

Parameters:

ps - The desired print stream ('System.out', e.g. for immediate screen printing).

printDiffReport

public void printDiffReport(PrintStream ps)

Prints an exhaustive list of diffs with specific contextual information about each difference. This also begins by invoking DesignComparator.printDiffReportSummary(PrintStream) first.

Parameters:

ps - The desired print stream ('System.out', e.g. for immediate screen printing).