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

//! Contains function expressions via the [`FluentExpression`] type.

use crate::types::{BinaryOp, FunctionHead, MultiOp, Number};

/// A function/fluent expression used e.g. in a [`DurationValue`](crate::types::DurationValue).
///
/// ## Requirements
/// Requires [Numeric Fluents](crate::Requirement::NumericFluents).
///
/// ## Usage
/// Used by [`FluentExpression`] itself, as well as [`PrimitiveEffect`](crate::PrimitiveEffect), [`DurationValue`](crate::DurationValue),
/// [`DurativeActionFluentExpression`](crate::DurativeActionFluentExpression) and [`TimedFluentExpression`](crate::TimedFluentExpression).
#[doc(alias("f-exp"))]
#[derive(Debug, Clone, PartialEq)]
pub enum FluentExpression {
    /// A numerical expression.
    Number(Number),
    /// A function that derives a value.
    Function(FunctionHead),
    /// The negative value of a fluent expression.
    Negative(Box<FluentExpression>),
    /// An operation applied to two fluent expressions.
    BinaryOp(BinaryOp, Box<FluentExpression>, Box<FluentExpression>),
    /// An operation applied to two or more fluent expressions.
    MultiOp(MultiOp, Box<FluentExpression>, Vec<FluentExpression>),
}

impl FluentExpression {
    #[inline(always)]
    #[doc(alias = "new_number")]
    pub fn number<N: Into<Number>>(number: N) -> Self {
        Self::Number(number.into())
    }

    pub fn new_number<N: Into<Number>>(number: N) -> Self {
        Self::number(number)
    }

    #[doc(alias = "new_binary_op")]
    pub fn binary_op(op: BinaryOp, lhs: FluentExpression, rhs: FluentExpression) -> Self {
        Self::BinaryOp(op, Box::new(lhs), Box::new(rhs))
    }

    pub fn new_binary_op(op: BinaryOp, lhs: FluentExpression, rhs: FluentExpression) -> Self {
        Self::binary_op(op, lhs, rhs)
    }

    #[doc(alias = "new_multi_op")]
    pub fn multi_op<I: IntoIterator<Item = FluentExpression>>(
        op: MultiOp,
        lhs: FluentExpression,
        rhs: I,
    ) -> Self {
        Self::MultiOp(op, Box::new(lhs), rhs.into_iter().collect())
    }

    pub fn new_multi_op<I: IntoIterator<Item = FluentExpression>>(
        op: MultiOp,
        lhs: FluentExpression,
        rhs: I,
    ) -> Self {
        Self::multi_op(op, lhs, rhs)
    }

    #[doc(alias = "new_negative")]
    pub fn negative(value: FluentExpression) -> Self {
        Self::Negative(Box::new(value))
    }

    pub fn new_negative(value: FluentExpression) -> Self {
        Self::negative(value)
    }

    #[doc(alias = "new_function")]
    pub const fn function(f_head: FunctionHead) -> Self {
        Self::Function(f_head)
    }

    pub fn new_function(f_head: FunctionHead) -> Self {
        Self::function(f_head)
    }
}

/// Alias for [`FluentExpression`]; matches BNF `<f-exp>`.
#[deprecated(since = "0.2.0", note = "Use `FluentExpression` instead")]
pub type FExp = FluentExpression;