Class GraphDifferenceReport

To be produced by a function differencing two graphs (e.g., DFGs or ControlFlowGraph|CFGs).

See

isEqual - to check whether the graphs are equal
addComment - to add comments to the report
comments - to get the attached comments
problematic - to get the problematic vertices/edges

Implements

WriteableDifferenceReport

Index

Constructors

Properties

_comments _problematic

Methods

addComment comments isEqual problematic

Constructors

constructor

new GraphDifferenceReport(): GraphDifferenceReport
Returns GraphDifferenceReport

Properties

_comments

_comments: string[] | undefined = undefined

_problematic

_problematic: ProblematicDiffInfo[] | undefined = undefined

Methods

addComment

addComment(comment: string, ...related: readonly ProblematicDiffInfo[]): void
Parameters
- comment: string
- ...related: readonly ProblematicDiffInfo[]
Returns void
Implementation of WriteableDifferenceReport.addComment
- Defined in src/util/diff-graph.ts:34

comments

comments(): readonly string[] | undefined
A human-readable description of differences during the comparison In combination with isEqual this can be used to provide detailed explanation on equal structures as well (e.g., if structures could be equal).

Returns readonly string[] | undefined
Implementation of WriteableDifferenceReport.comments
- Defined in src/util/diff-graph.ts:49

isEqual

isEqual(): boolean
Returns boolean
true iff the compared structures are equal (i.e., the diff is empty)
Implementation of WriteableDifferenceReport.isEqual
- Defined in src/util/diff-graph.ts:57

problematic

problematic(): readonly ProblematicDiffInfo[] | undefined
Returns readonly ProblematicDiffInfo[] | undefined
- Defined in src/util/diff-graph.ts:53