com.xilinx.rapidwright.edif.compare

Class EDIFNetlistComparator

Object

com.xilinx.rapidwright.edif.compare.EDIFNetlistComparator

public class EDIFNetlistComparator
extends Object

This is a helper class designed to compare two EDIFNetlists for differences. It can filter out differences introduced by Vivado by reading in the EDIF and writing out as a DCP. It can also generate a report file describing all the differences found. Please see @link DesignComparator to compare the placement and routing information of a design.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	filterVivadoChanges A netlist will undergo several changes when loaded via DCP vs.
boolean	restoreBrackets Setting this to true will attempt to account for legalized square brackets replaced by underscores around an indexed suffix on a Library name.

Constructor Summary

Constructors

Constructor and Description
EDIFNetlistComparator()

Method Summary

Modifier and Type	Method and Description
int	compareNetlists(EDIFNetlist gold, EDIFNetlist test)
int	getDiffCount() Gets the total number of differences encountered since the last call of EDIFNetlistComparator.compareNetlists(EDIFNetlist, EDIFNetlist).
List<EDIFDiff>	getDiffList(EDIFDiffType type)
Map<EDIFDiffType,List<EDIFDiff>>	getDiffMap()
static void	main(String[] args)
void	printDiffReport(PrintStream ps)
void	printDiffReportSummary(PrintStream ps)

Methods inherited from class Object

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

Field Detail

restoreBrackets

public boolean restoreBrackets

Setting this to true will attempt to account for legalized square brackets replaced by underscores around an indexed suffix on a Library name. For example, if the Library name was originally 'my_signal[4]' but in translation by Vivado was changed to 'my_signal_4_', setting this flag to true will attempt to find the square bracketed name equivalent

filterVivadoChanges

public boolean filterVivadoChanges

A netlist will undergo several changes when loaded via DCP vs. via EDIF. This flag attempts to account for the majority of those changes.

Constructor Detail

EDIFNetlistComparator

public EDIFNetlistComparator()

Method Detail

getDiffCount

public int getDiffCount()

Gets the total number of differences encountered since the last call of EDIFNetlistComparator.compareNetlists(EDIFNetlist, EDIFNetlist).

Returns:

Total number of design differences found.

getDiffMap

public Map<EDIFDiffType,List<EDIFDiff>> getDiffMap()

getDiffList

public List<EDIFDiff> getDiffList(EDIFDiffType type)

compareNetlists

public int compareNetlists(EDIFNetlist gold,
                           EDIFNetlist test)

printDiffReportSummary

public void printDiffReportSummary(PrintStream ps)

printDiffReport

public void printDiffReport(PrintStream ps)

main

public static void main(String[] args)