aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/store-reasoning/src/main/java/tools/refinery/store/reasoning/translator/typehierarchy/TypeAnalyzer.java
blob: e97ce95446c16da6ecbb38e75233fc792e9db45b (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.store.reasoning.translator.typehierarchy;

import tools.refinery.store.reasoning.representation.PartialRelation;

import java.util.*;

class TypeAnalyzer {
	private final Map<PartialRelation, ExtendedTypeInfo> extendedTypeInfoMap;
	private final Map<PartialRelation, PartialRelation> replacements = new LinkedHashMap<>();
	private final InferredType unknownType;
	private final Map<PartialRelation, TypeAnalysisResult> analysisResults;

	public TypeAnalyzer(Map<PartialRelation, TypeInfo> typeInfoMap) {
		int size = typeInfoMap.size();
		extendedTypeInfoMap = new LinkedHashMap<>(size);
		var concreteTypes = new LinkedHashSet<PartialRelation>();
		int index = 0;
		for (var entry : typeInfoMap.entrySet()) {
			var type = entry.getKey();
			var typeInfo = entry.getValue();
			extendedTypeInfoMap.put(type, new ExtendedTypeInfo(index, type, typeInfo));
			if (!typeInfo.abstractType()) {
				concreteTypes.add(type);
			}
			index++;
		}
		unknownType = new InferredType(Set.of(), concreteTypes, null);
		computeAllSupertypes();
		computeAllAndConcreteSubtypes();
		computeDirectSubtypes();
		eliminateTrivialSupertypes();
		analysisResults = computeAnalysisResults();
	}

	public InferredType getUnknownType() {
		return unknownType;
	}

	public Map<PartialRelation, TypeAnalysisResult> getAnalysisResults() {
		return analysisResults;
	}

	private void computeAllSupertypes() {
		boolean changed;
		do {
			changed = false;
			for (var extendedTypeInfo : extendedTypeInfoMap.values()) {
				var found = new HashSet<PartialRelation>();
				var allSupertypes = extendedTypeInfo.getAllSupertypes();
				for (var supertype : allSupertypes) {
					found.addAll(extendedTypeInfoMap.get(supertype).getAllSupertypes());
				}
				if (allSupertypes.addAll(found)) {
					changed = true;
				}
			}
		} while (changed);
	}

	private void computeAllAndConcreteSubtypes() {
		for (var extendedTypeInfo : extendedTypeInfoMap.values()) {
			var type = extendedTypeInfo.getType();
			if (!extendedTypeInfo.isAbstractType()) {
				extendedTypeInfo.getConcreteSubtypesAndSelf().add(type);
			}
			for (var supertype : extendedTypeInfo.getAllSupertypes()) {
				if (type.equals(supertype)) {
					throw new IllegalArgumentException("%s cannot be a supertype of itself".formatted(type));
				}
				var supertypeInfo = extendedTypeInfoMap.get(supertype);
				supertypeInfo.getAllSubtypes().add(type);
				if (!extendedTypeInfo.isAbstractType()) {
					supertypeInfo.getConcreteSubtypesAndSelf().add(type);
				}
			}
		}
	}

	private void computeDirectSubtypes() {
		for (var extendedTypeInfo : extendedTypeInfoMap.values()) {
			var allSubtypes = extendedTypeInfo.getAllSubtypes();
			var directSubtypes = new LinkedHashSet<>(allSubtypes);
			var indirectSubtypes = new LinkedHashSet<PartialRelation>(allSubtypes.size());
			for (var subtype : allSubtypes) {
				indirectSubtypes.addAll(extendedTypeInfoMap.get(subtype).getAllSubtypes());
			}
			directSubtypes.removeAll(indirectSubtypes);
			extendedTypeInfo.setDirectSubtypes(directSubtypes);
		}
	}

	private void eliminateTrivialSupertypes() {
		boolean changed;
		do {
			var toRemove = new ArrayList<PartialRelation>();
			for (var entry : extendedTypeInfoMap.entrySet()) {
				var extendedTypeInfo = entry.getValue();
				boolean isAbstract = extendedTypeInfo.isAbstractType();
				// Do not eliminate abstract types with 0 subtypes, because they can be used para-consistently, i.e.,
				// an object determined to <b>must</b> have an abstract type with 0 subtypes <b>may not</b> ever exist.
				boolean hasSingleDirectSubtype = extendedTypeInfo.getDirectSubtypes().size() == 1;
				if (isAbstract && hasSingleDirectSubtype) {
					toRemove.add(entry.getKey());
				}
			}
			toRemove.forEach(this::removeTrivialType);
			changed = !toRemove.isEmpty();
		} while (changed);
	}

	private void removeTrivialType(PartialRelation trivialType) {
		var extendedTypeInfo = extendedTypeInfoMap.get(trivialType);
		var iterator = extendedTypeInfo.getDirectSubtypes().iterator();
		if (!iterator.hasNext()) {
			throw new AssertionError("Expected trivial supertype %s to have a direct subtype"
					.formatted(trivialType));
		}
		PartialRelation replacement = setReplacement(trivialType, iterator.next());
		if (iterator.hasNext()) {
			throw new AssertionError("Expected trivial supertype %s to have at most 1 direct subtype"
					.formatted(trivialType));
		}
		replacements.put(trivialType, replacement);
		for (var supertype : extendedTypeInfo.getAllSupertypes()) {
			var extendedSupertypeInfo = extendedTypeInfoMap.get(supertype);
			if (!extendedSupertypeInfo.getAllSubtypes().remove(trivialType)) {
				throw new AssertionError("Expected %s to be subtype of %s".formatted(trivialType, supertype));
			}
			var directSubtypes = extendedSupertypeInfo.getDirectSubtypes();
			if (directSubtypes.remove(trivialType)) {
				directSubtypes.add(replacement);
			}
		}
		for (var subtype : extendedTypeInfo.getAllSubtypes()) {
			var extendedSubtypeInfo = extendedTypeInfoMap.get(subtype);
			if (!extendedSubtypeInfo.getAllSupertypes().remove(trivialType)) {
				throw new AssertionError("Expected %s to be supertype of %s".formatted(trivialType, subtype));
			}
		}
		extendedTypeInfoMap.remove(trivialType);
	}

	private PartialRelation setReplacement(PartialRelation trivialRelation, PartialRelation replacement) {
		if (replacement == null) {
			return trivialRelation;
		}
		var resolved = setReplacement(replacement, replacements.get(replacement));
		replacements.put(trivialRelation, resolved);
		return resolved;
	}

	private Map<PartialRelation, TypeAnalysisResult> computeAnalysisResults() {
		var allExtendedTypeInfoList = sortTypes();
		var results = new LinkedHashMap<PartialRelation, TypeAnalysisResult>(
				allExtendedTypeInfoList.size() + replacements.size());
		for (var extendedTypeInfo : allExtendedTypeInfoList) {
			var type = extendedTypeInfo.getType();
			results.put(type, new PreservedType(extendedTypeInfo, allExtendedTypeInfoList));
		}
		for (var entry : replacements.entrySet()) {
			var type = entry.getKey();
			results.put(type, new EliminatedType(entry.getValue()));
		}
		return Collections.unmodifiableMap(results);
	}

	private List<ExtendedTypeInfo> sortTypes() {
		// Invert {@code directSubtypes} to keep track of the out-degree of types.
		for (var extendedTypeInfo : extendedTypeInfoMap.values()) {
			for (var directSubtype : extendedTypeInfo.getDirectSubtypes()) {
				var extendedDirectSubtypeInfo = extendedTypeInfoMap.get(directSubtype);
				extendedDirectSubtypeInfo.getUnsortedDirectSupertypes().add(extendedTypeInfo.getType());
			}
		}
		// Build a <i>inverse</i> topological order ({@code extends} edges always points to earlier nodes in the order,
		// breaking ties according to the original order ({@link ExtendedTypeInfo#index}) to form a 'stable' sort.
		// See, e.g., https://stackoverflow.com/a/11236027.
		var priorityQueue = new PriorityQueue<ExtendedTypeInfo>();
		for (var extendedTypeInfo : extendedTypeInfoMap.values()) {
			if (extendedTypeInfo.getUnsortedDirectSupertypes().isEmpty()) {
				priorityQueue.add(extendedTypeInfo);
			}
		}
		var sorted = new ArrayList<ExtendedTypeInfo>(extendedTypeInfoMap.size());
		while (!priorityQueue.isEmpty()) {
			var extendedTypeInfo = priorityQueue.remove();
			sorted.add(extendedTypeInfo);
			for (var directSubtype : extendedTypeInfo.getDirectSubtypes()) {
				var extendedDirectSubtypeInfo = extendedTypeInfoMap.get(directSubtype);
				var unsortedDirectSupertypes = extendedDirectSubtypeInfo.getUnsortedDirectSupertypes();
				if (!unsortedDirectSupertypes.remove(extendedTypeInfo.getType())) {
					throw new AssertionError("Expected %s to be a direct supertype of %s"
							.formatted(extendedTypeInfo.getType(), directSubtype));
				}
				if (unsortedDirectSupertypes.isEmpty()) {
					priorityQueue.add(extendedDirectSubtypeInfo);
				}
			}
		}
		return Collections.unmodifiableList(sorted);
	}
}