pddl 0.2.0

A PDDL 3.1 parser, strongly typed
Documentation 
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

//! Contains the [`ProblemGoalDefinition`] type.

use crate::types::pre_gd::PreconditionGoalDefinitions;
use crate::PreconditionGoalDefinition;
use std::ops::Deref;

/// A problem goal definition; wraps a [`PreconditionGoalDefinitions`].
///
/// # BNF
/// Corresponds to the `(:goal ...)` section of a PDDL problem definition.
///
/// ## Usage
/// Used by [`Problem`](crate::Problem).
#[doc(alias("goal"))]
#[derive(Debug, Clone, PartialEq)]
pub struct ProblemGoalDefinition(PreconditionGoalDefinitions);

impl ProblemGoalDefinition {
    pub const fn new(gd: PreconditionGoalDefinitions) -> Self {
        Self(gd)
    }

    /// Gets the value.
    pub const fn value(&self) -> &PreconditionGoalDefinitions {
        &self.0
    }
}

impl PartialEq<PreconditionGoalDefinitions> for ProblemGoalDefinition {
    fn eq(&self, other: &PreconditionGoalDefinitions) -> bool {
        self.0.eq(other)
    }
}

impl From<PreconditionGoalDefinitions> for ProblemGoalDefinition {
    fn from(value: PreconditionGoalDefinitions) -> Self {
        Self::new(value)
    }
}

impl From<PreconditionGoalDefinition> for ProblemGoalDefinition {
    fn from(value: PreconditionGoalDefinition) -> Self {
        Self::new(PreconditionGoalDefinitions::from(value))
    }
}

impl FromIterator<PreconditionGoalDefinition> for ProblemGoalDefinition {
    fn from_iter<T: IntoIterator<Item = PreconditionGoalDefinition>>(iter: T) -> Self {
        ProblemGoalDefinition::new(PreconditionGoalDefinitions::from_iter(iter))
    }
}

impl Deref for ProblemGoalDefinition {
    type Target = PreconditionGoalDefinitions;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl From<ProblemGoalDefinition> for PreconditionGoalDefinitions {
    fn from(val: ProblemGoalDefinition) -> Self {
        val.0
    }
}

/// Alias for [`ProblemGoalDefinition`].
#[deprecated(since = "0.2.0", note = "Use `ProblemGoalDefinition` instead")]
pub type GoalDef = ProblemGoalDefinition;

#[cfg(test)]
mod tests {
    use super::*;
    use crate::GoalDefinition;

    #[test]
    fn problem_goal_definition_from_precondition_goal_definitions() {
        let defs = PreconditionGoalDefinitions::new(Vec::new());
        let pgd: ProblemGoalDefinition = defs.clone().into();
        assert_eq!(*pgd.value(), defs);
    }

    #[test]
    fn problem_goal_definition_from_precondition_goal_definition() {
        let pref_gd = crate::PreferenceGoalDefinition::from_gd(GoalDefinition::and(Vec::new()));
        let pre_gd = PreconditionGoalDefinition::preference(pref_gd);
        let pgd: ProblemGoalDefinition = pre_gd.into();
        assert_eq!(pgd.len(), 1);
    }

    #[test]
    #[allow(deprecated)]
    fn deprecated_alias_exists() {
        fn _assert_alias(_: GoalDef) {}
    }
}