ommx 3.0.0-beta.5

Open Mathematical prograMming eXchange (OMMX)
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

#[cfg(test)]
use crate::function::operation::{
    associative_expression, binary_expression, AssociativeOperator, BinaryOperator,
};
use crate::function::{
    operation::{instructions, Atom, Instruction},
    Expression, Function,
};
use crate::logical_memory::{LogicalMemoryProfile, LogicalMemoryVisitor, Path};
use std::mem::size_of;

impl LogicalMemoryProfile for Atom {
    fn visit_logical_memory<V: LogicalMemoryVisitor>(&self, path: &mut Path, visitor: &mut V) {
        match self {
            Atom::Zero => visitor.visit_leaf(&path.with("Zero"), size_of::<Atom>()),
            Atom::Constant(_) => visitor.visit_leaf(&path.with("Constant"), size_of::<Atom>()),
            Atom::Linear(linear) => {
                linear.visit_logical_memory(path.with("Linear").as_mut(), visitor)
            }
            Atom::Quadratic(quadratic) => {
                quadratic.visit_logical_memory(path.with("Quadratic").as_mut(), visitor)
            }
            Atom::Polynomial(polynomial) => {
                polynomial.visit_logical_memory(path.with("Polynomial").as_mut(), visitor)
            }
        }
    }
}

impl LogicalMemoryProfile for Instruction {
    fn visit_logical_memory<V: LogicalMemoryVisitor>(&self, path: &mut Path, visitor: &mut V) {
        match self {
            Instruction::Push(atom) => {
                atom.visit_logical_memory(path.with("Push").as_mut(), visitor)
            }
            Instruction::Unary(_) => {
                visitor.visit_leaf(&path.with("Unary"), size_of::<Instruction>())
            }
            Instruction::Associative(_) => {
                visitor.visit_leaf(&path.with("Associative"), size_of::<Instruction>())
            }
            Instruction::Binary(_) => {
                visitor.visit_leaf(&path.with("Binary"), size_of::<Instruction>())
            }
        }
    }
}

impl LogicalMemoryProfile for Expression {
    fn visit_logical_memory<V: LogicalMemoryVisitor>(&self, path: &mut Path, visitor: &mut V) {
        visitor.visit_leaf(&path.with("Vec[stack]"), size_of::<Vec<Instruction>>());
        for instruction in instructions(self) {
            instruction.visit_logical_memory(path, visitor);
        }
    }
}

impl LogicalMemoryProfile for Function {
    fn visit_logical_memory<V: LogicalMemoryVisitor>(&self, path: &mut Path, visitor: &mut V) {
        match self {
            Function::Zero => {
                // Zero variant has no heap allocation, only stack size
                visitor.visit_leaf(&path.with("Zero"), size_of::<Function>());
            }
            Function::Constant(_c) => {
                // Constant variant has coefficient on stack, no heap allocation
                visitor.visit_leaf(&path.with("Constant"), size_of::<Function>());
            }
            Function::Linear(linear) => {
                linear.visit_logical_memory(path.with("Linear").as_mut(), visitor);
            }
            Function::Quadratic(quadratic) => {
                quadratic.visit_logical_memory(path.with("Quadratic").as_mut(), visitor);
            }
            Function::Polynomial(polynomial) => {
                polynomial.visit_logical_memory(path.with("Polynomial").as_mut(), visitor);
            }
            Function::Expression(expression) => {
                expression.visit_logical_memory(path.with("Expression").as_mut(), visitor);
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::logical_memory::logical_memory_to_folded;
    use crate::{coeff, linear, quadratic};

    #[test]
    fn test_function_zero_snapshot() {
        let func = Function::Zero;
        let folded = logical_memory_to_folded(&func);
        insta::assert_snapshot!(folded, @"Zero 40");
    }

    #[test]
    fn test_function_constant_snapshot() {
        let func = Function::Constant(coeff!(42.0));
        let folded = logical_memory_to_folded(&func);
        insta::assert_snapshot!(folded, @"Constant 40");
    }

    #[test]
    fn test_function_linear_snapshot() {
        let func = Function::Linear(
            ((coeff!(2.0) * linear!(1)).unwrap() + (coeff!(3.0) * linear!(2)).unwrap()).unwrap(),
        );
        let folded = logical_memory_to_folded(&func);
        insta::assert_snapshot!(folded, @"Linear;PolynomialBase.terms 80");
    }

    #[test]
    fn test_function_quadratic_snapshot() {
        let func = Function::Quadratic(
            ((coeff!(1.0) * quadratic!(1, 2)).unwrap() + (coeff!(2.0) * quadratic!(1)).unwrap())
                .unwrap(),
        );
        let folded = logical_memory_to_folded(&func);
        insta::assert_snapshot!(folded, @"Quadratic;PolynomialBase.terms 96");
    }

    #[test]
    fn expression_profile_visits_program_and_instruction_payloads() {
        let expression = binary_expression(
            BinaryOperator::Div,
            associative_expression(
                AssociativeOperator::Min,
                Function::from(linear!(1)).abs(),
                Function::one(),
            ),
            Function::from(coeff!(2.0)),
        );
        let folded = logical_memory_to_folded(&expression);

        assert!(folded.contains("Expression;Vec[stack]"));
        assert!(folded.contains("Expression;Push;Linear;PolynomialBase.terms"));
        assert!(folded.contains("Expression;Push;Constant"));
        assert!(folded.contains("Expression;Unary"));
        assert!(folded.contains("Expression;Associative"));
        assert!(folded.contains("Expression;Binary"));
    }
}