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

/*
 * Copyright (C) 2022 Vaticle
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

use std::collections::HashMap;

use crate::{answer::ConceptMap, logic::Rule};

/// An explanation of which rule was used for inferring the explained concept,
/// the condition of the rule, the conclusion of the rule,
/// and the mapping of variables between the query and the rule’s conclusion.
#[derive(Debug, PartialEq)]
pub struct Explanation {
    /// The Rule for this Explanation.
    pub rule: Rule,
    /// The Conclusion for this Explanation.
    pub conclusion: ConceptMap,
    /// The Condition for this Explanation.
    pub condition: ConceptMap,
    /// The mapping from query variables to rule variables for this `Explanation`.
    pub variable_mapping: HashMap<String, Vec<String>>,
}