wolfram_wxf 0.6.5

Convert a value to the Wolfram Language WXF format.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::{ToWolfram, WolframValue};
use std::fmt::{Debug, Display, Formatter};

mod display;

/// A symbol in the Wolfram Language.
#[derive(Clone, PartialEq, Eq, Ord, PartialOrd)]
pub struct WolframSymbol {
    namespace: String,
    name: String,
}

impl WolframSymbol {
    /// Creates a new [`WolframSymbol`] with the given name.
    pub fn new<T, S>(namespace: T, name: S) -> Self
    where
        T: ToString,
        S: ToString,
    {
        let namespace = namespace.to_string();
        let name = name.to_string();
        debug_assert!(Self::is_valid(namespace.as_ref()));
        debug_assert!(Self::is_valid(name.as_ref()));
        Self { namespace, name }
    }
    /// Creates a new [`WolframSymbol`] with the given name.
    pub fn global<S>(name: S) -> Self
    where
        S: ToString,
    {
        let name = name.to_string();
        debug_assert!(Self::is_valid(name.as_ref()));
        Self { namespace: "Global".to_string(), name }
    }
    /// Creates a new [`WolframSymbol`] with the given name.
    pub fn system<S>(name: S) -> Self
    where
        S: ToString,
    {
        let name = name.to_string();
        debug_assert!(Self::is_valid(name.as_ref()));
        Self { namespace: String::new(), name }
    }
    /// Creates a new [`WolframSymbol`] with the given name.
    pub fn is_valid(name: &str) -> bool {
        name.chars().all(|c| c.is_ascii_alphanumeric() || c == '`')
    }
}

/// f[x, y, z, ...]
#[derive(Debug, Clone, PartialEq, Eq, Ord, PartialOrd)]
pub struct WolframFunction {
    head: WolframValue,
    rest: Vec<WolframValue>,
}

impl WolframFunction {
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn new<V, I>(head: V, arguments: I) -> Self
    where
        V: ToWolfram,
        I: IntoIterator<Item = WolframValue>,
    {
        Self { head: head.to_wolfram(), rest: arguments.into_iter().collect() }
    }
    ///
    pub fn namespace<S, I>(namespace: S, name: S, arguments: I) -> Self
    where
        S: ToString,
        I: IntoIterator<Item = WolframValue>,
    {
        Self { head: WolframSymbol::new(namespace, name).to_wolfram(), rest: arguments.into_iter().collect() }
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn global<S, I>(name: S, arguments: I) -> Self
    where
        S: ToString,
        I: IntoIterator<Item = WolframValue>,
    {
        Self { head: WolframSymbol::global(name).to_wolfram(), rest: arguments.into_iter().collect() }
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn system<S, I>(name: S, arguments: I) -> Self
    where
        S: ToString,
        I: IntoIterator<Item = WolframValue>,
    {
        Self { head: WolframSymbol::system(name).to_wolfram(), rest: arguments.into_iter().collect() }
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn get_head(&self) -> &WolframValue {
        &self.head
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn mut_head(&mut self) -> &mut WolframValue {
        &mut self.head
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn set_head<V: ToWolfram>(&mut self, head: V) {
        self.head = head.to_wolfram();
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn with_head(mut self, head: WolframValue) -> Self {
        self.head = head;
        self
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn get_rest(&self) -> &[WolframValue] {
        self.rest.as_slice()
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn mut_rest(&mut self) -> &mut Vec<WolframValue> {
        &mut self.rest
    }
    /// Creates a new [`WolframFunction`] with the given name and arguments.
    pub fn add_rest(&mut self, rest: WolframValue) {
        self.rest.push(rest);
    }
}