Package org.variantsync.diffdetective.variation.diff.bad

Record Class BadVDiff<L extends Label>

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.variation.diff.bad.BadVDiff<L>

Record Components:

diff - The variation tree that models the tree diff.

matching - Memorization of which nodes are clones and can be safely merged when converting back to a variation diff.

coloring - Memorization of the diff types of all nodes.

lines - Memorization of line ranges within text diffs.

All Implemented Interfaces:

Source

public record BadVDiff<L extends Label>(VariationTree<L extends Label> diff, Map<VariationTreeNode<L extends Label>,VariationTreeNode<L extends Label>> matching, Map<VariationTreeNode<L extends Label>,DiffType> coloring, Map<VariationTreeNode<L extends Label>,DiffLineNumberRange> lines)
extends Record
implements Source

A bad variation diff is a variation diff that has no subtree sharing. This means that the diff is a tree. We thus can store the diff as a variation tree with some extra information. This allows us to prove the variation diff being a tree at the type level.

When converting a variation diff to a bad one, cycles

    .
   / \
  /   \
 .     .
 \    /
  \  /
   x
 

are resolved by cloning the deepest subtree x in the cycle.

    .
   / \
  /   \
 .     .
 |     |
 |     |
 x     x
 

The matching in a bad variation diff stores which nodes have been cloned.

As variation trees do not store any diff-specific information, we remember the nodes difftype in the original variation diff in a coloring map.

(Unproven) Invariants: for all VariationDiff d: fromGood(d).toGood() equals d

Author:

Paul Bittner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BadVDiff.FromGoodNodeTranslation<L extends Label>	Memoization of the VariationTreeNodes a DiffNode was converted to in fromGood(VariationDiff).

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<VariationTreeNode<L>,DiffType>	coloring	The field for the coloring record component.
private final VariationTree<L>	diff	The field for the diff record component.
private final Map<VariationTreeNode<L>,DiffLineNumberRange>	lines	The field for the lines record component.
private final Map<VariationTreeNode<L>,VariationTreeNode<L>>	matching	The field for the matching record component.

Fields inherited from interface org.variantsync.diffdetective.util.Source

Unknown

Constructor Summary

Constructors

Constructor	Description
BadVDiff(VariationTree<L> diff, Map<VariationTreeNode<L>,VariationTreeNode<L>> matching, Map<VariationTreeNode<L>,DiffType> coloring, Map<VariationTreeNode<L>,DiffLineNumberRange> lines)	Creates an instance of a BadVDiff record class.

Method Summary

Modifier and Type	Method	Description
Map<VariationTreeNode<L>,DiffType>	coloring()	Returns the value of the coloring record component.
BadVDiff<L>	deepCopy()
VariationTree<L>	diff()	Returns the value of the diff record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
private static <L extends Label> VariationTreeNode<L>	fromGood(DiffNode<L> n, BadVDiff.FromGoodNodeTranslation<L> nodeTranslation, Map<VariationTreeNode<L>,DiffType> coloring, Map<VariationTreeNode<L>,DiffLineNumberRange> lines)	Performs a plain conversion of the given DiffNode n to a VariationTreeNode.
static <L extends Label> BadVDiff<L>	fromGood(VariationDiff<L> d)	Creates a bad diff from a VariationDiff.
String	getSourceExplanation()	Returns a short, one line explanation or identifier of this source.
List<Source>	getSources()	Returns a list of sources that influenced this source.
final int	hashCode()	Returns a hash code value for this object.
Map<VariationTreeNode<L>,DiffLineNumberRange>	lines()	Returns the value of the lines record component.
Map<VariationTreeNode<L>,VariationTreeNode<L>>	matching()	Returns the value of the matching record component.
private DiffNode<L>	mergeToGood(VariationTreeNode<L> before, VariationTreeNode<L> after)	Merges two VariationTreeNodes that represent the same node to a single unchanged DiffNode.
private static <L extends Label> VariationTreeNode<L>	plain(DiffNode<L> n)	Plain conversion of DiffNodes to VariationTree nodes.
String	prettyPrint()
private void	prettyPrint(String indent, StringBuilder b, VariationTreeNode<L> n)
VariationDiff<L>	toGood()	Inverse of fromGood(VariationDiff).
private DiffNode<L>	toGood(VariationTreeNode<L> n)	Inverse of fromGood(DiffNode, FromGoodNodeTranslation, Map, Map).
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.variantsync.diffdetective.util.Source

fullExplanation, functionExplanation, getRootSource, getSourceArguments, shallowExplanation

Field Details

diff

private final VariationTree<L extends Label> diff

The field for the diff record component.

matching

private final Map<VariationTreeNode<L extends Label>,VariationTreeNode<L extends Label>> matching

The field for the matching record component.

coloring

private final Map<VariationTreeNode<L extends Label>,DiffType> coloring

The field for the coloring record component.

lines

private final Map<VariationTreeNode<L extends Label>,DiffLineNumberRange> lines

The field for the lines record component.

Constructor Details

BadVDiff

public BadVDiff(VariationTree<L> diff,
 Map<VariationTreeNode<L>,VariationTreeNode<L>> matching,
 Map<VariationTreeNode<L>,DiffType> coloring,
 Map<VariationTreeNode<L>,DiffLineNumberRange> lines)

Creates an instance of a BadVDiff record class.

Parameters:

diff - the value for the diff record component

matching - the value for the matching record component

coloring - the value for the coloring record component

lines - the value for the lines record component

Method Details

plain

private static <L extends Label>
VariationTreeNode<L> plain(DiffNode<L> n)

Plain conversion of DiffNodes to VariationTree nodes. Copies node type, formula, line numbers in the diff, and label but no edge information.

Parameters:

n - The node to convert to a plain VariationTreeNode.

fromGood

private static <L extends Label>
VariationTreeNode<L> fromGood(DiffNode<L> n,
 BadVDiff.FromGoodNodeTranslation<L> nodeTranslation,
 Map<VariationTreeNode<L>,DiffType> coloring,
 Map<VariationTreeNode<L>,DiffLineNumberRange> lines)

Performs a plain conversion of the given DiffNode n to a VariationTreeNode. Additionally, stores metadata to invert this operation in the given maps. For further information on these maps, have a look at the documentation of this class.

Parameters:

nodeTranslation - see BadVDiff.FromGoodNodeTranslation

toGood

private DiffNode<L> toGood(VariationTreeNode<L> n)

Inverse of fromGood(DiffNode, FromGoodNodeTranslation, Map, Map).

mergeToGood

private DiffNode<L> mergeToGood(VariationTreeNode<L> before,
 VariationTreeNode<L> after)

Merges two VariationTreeNodes that represent the same node to a single unchanged DiffNode. It is asserted that both given nodes have the same NodeType, label, formula, and line numbers.

fromGood

public static <L extends Label> BadVDiff<L> fromGood(VariationDiff<L> d)

Creates a bad diff from a VariationDiff.

Parameters:

d - The VariationDiff to convert to a bad diff.

See Also:

• BadVDiff

toGood

public VariationDiff<L> toGood()

Inverse of fromGood(VariationDiff). Restores the VariationDiff that is represented by this bad tree diff.

deepCopy

public BadVDiff<L> deepCopy()

prettyPrint

private void prettyPrint(String indent,
 StringBuilder b,
 VariationTreeNode<L> n)

prettyPrint

public String prettyPrint()

getSourceExplanation

public String getSourceExplanation()

Description copied from interface: Source

Returns a short, one line explanation or identifier of this source. The result is used by Source.shallowExplanation() and is formatted together with Source.getSourceArguments() like "sourceExplanation(argument1, argument2)".

Specified by:

getSourceExplanation in interface Source

getSources

public List<Source> getSources()

Description copied from interface: Source

Returns a list of sources that influenced this source. Noteworthy processing steps and incorporation of multiple sources are implemented as a tree of sources. This functions returns the children of this source.

By default, the first child source is treated specially in Source.getRootSource().

Specified by:

getSources in interface Source

Returns:

an empty list by default

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

diff

public VariationTree<L> diff()

Returns the value of the diff record component.

Returns:

the value of the diff record component

matching

public Map<VariationTreeNode<L>,VariationTreeNode<L>> matching()

Returns the value of the matching record component.

Returns:

the value of the matching record component

coloring

public Map<VariationTreeNode<L>,DiffType> coloring()

Returns the value of the coloring record component.

Returns:

the value of the coloring record component

lines

public Map<VariationTreeNode<L>,DiffLineNumberRange> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component