Collection Extension Reference


                    
                    
                    diff(_:isEqual:)

Creates a diff between the calee and other collection

Complexity

O((N+M)*D)

Declaration

Swift

public func diff(
    _ other: Self,
    isEqual: EqualityChecker<Self>
    ) -> Diff

Parameters


                                other

a collection to compare the calee to

Return Value

a Diff between the calee and other collection


                    
                    
                    diffTraces(to:isEqual:)

Generates all traces required to create an output diff. See the paper for more information on traces.

Declaration

Swift

public func diffTraces(
    to: Self,
    isEqual: EqualityChecker<Self>
    ) -> [Trace]

Parameters

`to`	other collection

Return Value

all traces required to create an output diff


                    
                    
                    outputDiffPathTraces(to:isEqual:)

Returns the traces which mark the shortest diff path.

Declaration

Swift

public func outputDiffPathTraces(
    to: Self,
    isEqual: EqualityChecker<Self>
    ) -> [Trace]


                    
                    
                    diff(_:)

See also

diff(_:isEqual:)

Declaration

Swift

public func diff(
    _ other: Self
    ) -> Diff


                    
                    
                    diffTraces(to:)

See also

diffTraces(to:isEqual:)

Declaration

Swift

public func diffTraces(
    to: Self
    ) -> [Trace]

outputDiffPathTraces(to:)
See also
outputDiffPathTraces(to:isEqual:)
Declaration
Swift

public func outputDiffPathTraces( to: Self ) -> [Trace]


                    
                    
                    extendedDiff(_:isEqual:)

Creates an extended diff between the callee and other collection

Complexity

O((N+M)*D). There’s additional cost of O(D^2) to compute the moves.

Declaration

Swift

public func extendedDiff(_ other: Self, isEqual: EqualityChecker<Self>) -> ExtendedDiff

Parameters

`other`	a collection to compare the callee to
`isEqual`	instance comparator closure

Return Value

ExtendedDiff between the callee and other collection


                    
                    
                    extendedDiff(from:other:isEqual:)

Creates an extended diff between the callee and other collection

Complexity

O(D^2). where D is number of elements in diff.

Declaration

Swift

public func extendedDiff(from diff: Diff, other: Self, isEqual: EqualityChecker<Self>) -> ExtendedDiff

Parameters

`diff`	source diff
`other`	a collection to compare the callee to
`isEqual`	instance comparator closure

Return Value

ExtendedDiff between the callee and other collection


                    
                    
                    firstMatch(_:dirtyIndices:candidate:candidateIndex:other:isEqual:)

Undocumented

Declaration

Swift

func firstMatch(
    _ diff: Diff,
    dirtyIndices: Set<Diff.Index>,
    candidate: Diff.Element,
    candidateIndex: Diff.Index,
    other: Self,
    isEqual: EqualityChecker<Self>
) -> (ExtendedDiff.Element, Diff.Index)?


                    
                    
                    createMatch(_:match:other:isEqual:)

Undocumented

Declaration

Swift

func createMatch(_ candidate: Diff.Element, match: Diff.Element, other: Self, isEqual: EqualityChecker<Self>) -> ExtendedDiff.Element?

extendedDiff(_:)
See also
extendedDiff(_:isEqual:)
Declaration
Swift

public func extendedDiff(_ other: Self) -> ExtendedDiff


                    
                    
                    nestedDiff(to:isEqualSection:isEqualElement:)

Creates a diff between the callee and other collection. It diffs elements two levels deep (therefore nested)

Declaration

Swift

public func nestedDiff(
    to: Self,
    isEqualSection: EqualityChecker<Self>,
    isEqualElement: NestedElementEqualityChecker<Self>
) -> NestedDiff

Parameters


                                other

a collection to compare the calee to

Return Value

a NestedDiff between the calee and other collection


                    
                    
                    nestedDiff(to:isEqualSection:)

See also

nestedDiff(to:isEqualSection:isEqualElement:)

Declaration

Swift

public func nestedDiff(
    to: Self,
    isEqualSection: EqualityChecker<Self>
) -> NestedDiff


                    
                    
                    nestedDiff(to:isEqualElement:)

See also

nestedDiff(to:isEqualSection:isEqualElement:)

Declaration

Swift

public func nestedDiff(
    to: Self,
    isEqualElement: NestedElementEqualityChecker<Self>
) -> NestedDiff

nestedDiff(to:)
See also
nestedDiff(to:isEqualSection:isEqualElement:)
Declaration
Swift

public func nestedDiff(to: Self) -> NestedDiff


                    
                    
                    nestedExtendedDiff(to:isEqualSection:isEqualElement:)

Creates a diff between the callee and other collection. It diffs elements two levels deep (therefore nested)

Declaration

Swift

public func nestedExtendedDiff(
    to: Self,
    isEqualSection: EqualityChecker<Self>,
    isEqualElement: NestedElementEqualityChecker<Self>
) -> NestedExtendedDiff

Parameters


                                other

a collection to compare the calee to

Return Value

a NestedDiff between the calee and other collection


                    
                    
                    nestedExtendedDiff(to:isEqualSection:)

See also

nestedDiff(to:isEqualSection:isEqualElement:)

Declaration

Swift

public func nestedExtendedDiff(
    to: Self,
    isEqualSection: EqualityChecker<Self>
) -> NestedExtendedDiff


                    
                    
                    nestedExtendedDiff(to:isEqualElement:)

See also

nestedDiff(to:isEqualSection:isEqualElement:)

Declaration

Swift

public func nestedExtendedDiff(
    to: Self,
    isEqualElement: NestedElementEqualityChecker<Self>
) -> NestedExtendedDiff

nestedExtendedDiff(to:)
See also
nestedDiff(to:isEqualSection:isEqualElement:)
Declaration
Swift

public func nestedExtendedDiff(to: Self) -> NestedExtendedDiff