aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/algorithms/OrderedIterableMerge.java
blob: 1917e909af905608a7dbb6ec45aa3f4c7b56f334 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*******************************************************************************
 * Copyright (c) 2010-2018, Gabor Bergmann, IncQuery Labs Ltd.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-v20.html.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/
package tools.refinery.viatra.runtime.matchers.algorithms;

import java.util.Comparator;
import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * @author Gabor Bergmann
 * @since 2.1
 *
 */
public class OrderedIterableMerge {
    
    private OrderedIterableMerge() {
        // Hidden utility class constructor
    }
    
    /**
     * Lazily merges two iterables, each ordered according to a given comparator. 
     * Retains order in the result, and also eliminates any duplicates that appear in both arguments.
     */
    public static <T> Iterable<T> mergeUniques(Iterable<T> first, Iterable<T> second, Comparator<T> comparator) {
        return () -> new Iterator<T>() {
            Iterator<T> firstIterator = first.iterator();
            Iterator<T> secondIterator = second.iterator();
            T firstItem;
            T secondItem;
            
            {
                fetchFirst();
                fetchSecond();
            }
            
            private T fetchFirst() {
                T previous = firstItem;
                if (firstIterator.hasNext()) 
                    firstItem = firstIterator.next();
                else 
                    firstItem = null;
                return previous;
            }
            private T fetchSecond() {
               T previous = secondItem;
               if (secondIterator.hasNext()) 
                    secondItem = secondIterator.next();
                else 
                    secondItem = null;
               return previous;
            }
            
            @Override
            public boolean hasNext() {
                return firstItem != null || secondItem != null;
            }
            @Override
            public T next() {
                if (!hasNext()) throw new NoSuchElementException();
                if (firstItem != null && secondItem != null) {
                    if (secondItem == firstItem) { // duplicates
                        fetchFirst();
                        return fetchSecond();
                    } else if (comparator.compare(firstItem, secondItem) < 0) {
                        return fetchFirst();
                    } else {
                        return fetchSecond();
                    }
                } else if (firstItem != null) {
                    return fetchFirst();
                } else { // secondItem must be non-null
                    return fetchSecond();
                }
            }
        };
    }
}