xdl-matlab 0.1.1

Extended Data Language (XDL) - Rust implementation
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

//! MATLAB to XDL function name mapping

use once_cell::sync::Lazy;
use std::collections::HashMap;

/// Mapping of MATLAB function names to XDL equivalents
pub static MATLAB_FUNCTION_MAP: Lazy<HashMap<&'static str, &'static str>> = Lazy::new(|| {
    let mut map = HashMap::new();

    // Array creation
    map.insert("zeros", "FLTARR"); // zeros(n) -> FLTARR(n)
    map.insert("ones", "FLTARR"); // ones(n) -> FLTARR(n) + 1 (handled specially)
    map.insert("eye", "IDENTITY"); // eye(n) -> IDENTITY(n)
    map.insert("rand", "RANDOMU"); // rand(n) -> RANDOMU(seed, n)
    map.insert("randn", "RANDOMN"); // randn(n) -> RANDOMN(seed, n)

    // Array info
    map.insert("size", "SIZE");
    map.insert("length", "N_ELEMENTS");
    map.insert("numel", "N_ELEMENTS");

    // Math functions
    map.insert("sin", "SIN");
    map.insert("cos", "COS");
    map.insert("tan", "TAN");
    map.insert("asin", "ASIN");
    map.insert("acos", "ACOS");
    map.insert("atan", "ATAN");
    map.insert("atan2", "ATAN");
    map.insert("exp", "EXP");
    map.insert("log", "ALOG");
    map.insert("log10", "ALOG10");
    map.insert("sqrt", "SQRT");
    map.insert("abs", "ABS");
    map.insert("floor", "FLOOR");
    map.insert("ceil", "CEIL");
    map.insert("round", "ROUND");
    map.insert("mod", "MOD");

    // Statistics
    map.insert("mean", "MEAN");
    map.insert("median", "MEDIAN");
    map.insert("std", "STDDEV");
    map.insert("var", "VARIANCE");
    map.insert("min", "MIN");
    map.insert("max", "MAX");
    map.insert("sum", "TOTAL");

    // Linear algebra
    map.insert("transpose", "TRANSPOSE");
    map.insert("inv", "INVERT");
    map.insert("det", "DETERM");

    // Plotting
    map.insert("plot", "PLOT");
    map.insert("xlabel", "XTITLE");
    map.insert("ylabel", "YTITLE");
    map.insert("zlabel", "ZTITLE"); // Z-axis label (may not be supported in 2D plots)
    map.insert("title", "TITLE");
    map.insert("legend", "LEGEND"); // legend -> LEGEND (XDL may not support, will be ignored)
    map.insert("figure", "WINDOW");
    map.insert("hold", "OPLOT"); // hold on -> use OPLOT
    map.insert("clf", "ERASE");
    map.insert("close", "WDELETE");

    // MATLAB compatibility functions
    map.insert("linspace", "LINSPACE");
    map.insert("logspace", "LOGSPACE");
    map.insert("meshgrid", "MESHGRID");
    map.insert("ndgrid", "NDGRID");
    map.insert("repmat", "REPMAT");
    map.insert("squeeze", "SQUEEZE");
    map.insert("interp1", "INTERP1");

    // Array manipulation
    map.insert("reshape", "REFORM");
    map.insert("sort", "SORT");
    map.insert("find", "WHERE");

    // I/O
    map.insert("disp", "PRINT");
    map.insert("fprintf", "PRINTF");
    map.insert("sprintf", "STRING");

    // Logical
    map.insert("all", "MIN"); // all -> MIN (non-zero check)
    map.insert("any", "MAX"); // any -> MAX (non-zero check)

    // Type conversion
    map.insert("double", "DOUBLE");
    map.insert("single", "FLOAT");
    map.insert("int32", "LONG");
    map.insert("uint32", "ULONG");

    map
});

/// Get XDL equivalent for a MATLAB function name
pub fn get_xdl_function(matlab_func: &str) -> Option<&'static str> {
    MATLAB_FUNCTION_MAP.get(matlab_func).copied()
}

/// Check if a MATLAB function needs special handling during transpilation
pub fn needs_special_handling(matlab_func: &str) -> bool {
    matches!(matlab_func, "ones" | "rand" | "randn" | "eye")
}

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

    #[test]
    fn test_function_mapping() {
        assert_eq!(get_xdl_function("zeros"), Some("FLTARR"));
        assert_eq!(get_xdl_function("sin"), Some("SIN"));
        assert_eq!(get_xdl_function("plot"), Some("PLOT"));
        assert_eq!(get_xdl_function("nonexistent"), None);
    }
}