aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/logic/src/main/java/tools/refinery/logic/literal/AbstractCountLiteral.java
blob: ee93259842087ecaf2114c3071ccf0700052fc20 (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
/*
 * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.logic.literal;

import tools.refinery.logic.Constraint;
import tools.refinery.logic.InvalidQueryException;
import tools.refinery.logic.equality.LiteralEqualityHelper;
import tools.refinery.logic.equality.LiteralHashCodeHelper;
import tools.refinery.logic.term.ConstantTerm;
import tools.refinery.logic.term.DataVariable;
import tools.refinery.logic.term.Variable;

import java.util.List;
import java.util.Objects;
import java.util.Set;

// {@link Object#equals(Object)} is implemented by {@link AbstractLiteral}.
@SuppressWarnings("squid:S2160")
public abstract class AbstractCountLiteral<T> extends AbstractCallLiteral {
	private final Class<T> resultType;
	private final DataVariable<T> resultVariable;

	protected AbstractCountLiteral(Class<T> resultType, DataVariable<T> resultVariable, Constraint target,
								   List<Variable> arguments) {
		super(target, arguments);
		if (!resultVariable.getType().equals(resultType)) {
			throw new InvalidQueryException("Count result variable %s must be of type %s, got %s instead".formatted(
					resultVariable, resultType, resultVariable.getType().getName()));
		}
		if (arguments.contains(resultVariable)) {
			throw new InvalidQueryException("Count result variable %s must not appear in the argument list"
					.formatted(resultVariable));
		}
		this.resultType = resultType;
		this.resultVariable = resultVariable;
	}

	public Class<T> getResultType() {
		return resultType;
	}

	public DataVariable<T> getResultVariable() {
		return resultVariable;
	}

	@Override
	public Set<Variable> getOutputVariables() {
		return Set.of(resultVariable);
	}

	protected abstract T zero();

	protected abstract T one();

	@Override
	public Literal reduce() {
		var reduction = getTarget().getReduction();
		return switch (reduction) {
			case ALWAYS_FALSE -> getResultVariable().assign(new ConstantTerm<>(resultType, zero()));
			// The only way a constant {@code true} predicate can be called in a negative position is to have all of
			// its arguments bound as input variables. Thus, there will only be a single match.
			case ALWAYS_TRUE -> getResultVariable().assign(new ConstantTerm<>(resultType, one()));
			case NOT_REDUCIBLE -> this;
		};
	}

	@Override
	public boolean equalsWithSubstitution(LiteralEqualityHelper helper, Literal other) {
		if (!super.equalsWithSubstitution(helper, other)) {
			return false;
		}
		var otherCountLiteral = (AbstractCountLiteral<?>) other;
		return Objects.equals(resultType, otherCountLiteral.resultType) &&
				helper.variableEqual(resultVariable, otherCountLiteral.resultVariable);
	}

	@Override
	public int hashCodeWithSubstitution(LiteralHashCodeHelper helper) {
		return Objects.hash(super.hashCodeWithSubstitution(helper), resultType,
				helper.getVariableHashCode(resultVariable));
	}

	protected abstract String operatorName();

	@Override
	public String toString() {
		var builder = new StringBuilder();
		builder.append(resultVariable);
		builder.append(" is ");
		builder.append(operatorName());
		builder.append(' ');
		builder.append(getTarget().toReferenceString());
		builder.append('(');
		var argumentIterator = getArguments().iterator();
		if (argumentIterator.hasNext()) {
			builder.append(argumentIterator.next());
			while (argumentIterator.hasNext()) {
				builder.append(", ").append(argumentIterator.next());
			}
		}
		builder.append(')');
		return builder.toString();
	}
}