aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime-localsearch/src/main/java/tools/refinery/viatra/runtime/localsearch/planner/cost/IConstraintEvaluationContext.java
blob: 9b44612b589e3d5e85b5b4c2aa8feef4e9521fa0 (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
/*******************************************************************************
 * Copyright (c) 2010-2016, Grill Balázs, 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.localsearch.planner.cost;

import tools.refinery.viatra.runtime.matchers.backend.ResultProviderRequestor;
import tools.refinery.viatra.runtime.matchers.context.IQueryResultProviderAccess;
import tools.refinery.viatra.runtime.matchers.context.IQueryRuntimeContext;
import tools.refinery.viatra.runtime.matchers.psystem.PConstraint;
import java.util.Collection;
import tools.refinery.viatra.runtime.matchers.psystem.PVariable;
import tools.refinery.viatra.runtime.matchers.psystem.analysis.QueryAnalyzer;

/**
 * This interface denotes the evaluation context of a constraint, intended for cost estimation. Provides access to information
 * on which the cost function can base its calculation.
 * 
 * @author Grill Balázs
 * @since 1.4
 * @noimplement
 */
public interface IConstraintEvaluationContext {

    /**
     * Get the constraint to be evaluated
     */
    public PConstraint getConstraint();

    /**
     * Unbound variables at the time of evaluating the constraint
     */
    public Collection<PVariable> getFreeVariables();

    /**
     * Bound variables at the time of evaluating the constraint
     */
    public Collection<PVariable> getBoundVariables();
    
    public IQueryRuntimeContext getRuntimeContext();
    
    /**
     * @since 1.5
     */
    public QueryAnalyzer getQueryAnalyzer();
    
    /**
     * @deprecated use {@link #resultProviderRequestor()}
     * @since 1.5
     */
    @Deprecated
    public IQueryResultProviderAccess resultProviderAccess();
    
    /**
     * @since 2.1
     */
    public ResultProviderRequestor resultProviderRequestor();
    
}