sac-base 0.0.7

Base crate of the sac-signal and sac-control crates
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
145
146
147
148
149
150
151
152
153
154
155

use crate::network::node::Node;
use core::ops;
use alloc::boxed::Box;
use core::any::Any;
use crate::helper::iter::iter_n_inputs;

/// Divide two or more inputs.
pub struct Divide {}
pub struct IntegerDivide {}

impl Divide {
    /// Generate a new division operation
    ///
    /// ## Example
    /// ```rust
    /// use sac_base::operations::math::divide::{Divide, IntegerDivide};
    /// let mut div = Divide::new();
    /// let mut vec = Vec::new();
    /// vec.push(&[2.0][..]);
    /// vec.push(&[4.0][..]);
    /// vec.push(&[0.5][..]);
    /// div.process((vec, 1));
    /// assert_eq!(div.poll(), &[1.0][..]);
    /// ```
    /// TODO: Zero divisions currently return INF and is not defined for integer values. These have to be specifically implemented
    pub fn new<T>() -> Node<T>
        where T: Copy + ops::Div<Output=T> + Default {
        let storage = Box::new(0) as Box<dyn Any>;
        Node::new(storage, |data_input, _input, output| {
            iter_n_inputs(data_input, output, |left: T, right: T| {
                return left / right
            })
        })
    }
}

impl IntegerDivide {
    /// Generate a new division operation
    ///
    /// ## Example
    /// ```rust
    /// use sac_base::operations::math::divide::Divide;
    /// let mut div = Divide::new();
    /// let mut vec = Vec::new();
    /// vec.push(&[2.0][..]);
    /// vec.push(&[4.0][..]);
    /// vec.push(&[0.5][..]);
    /// div.process((vec, 1));
    /// assert_eq!(div.poll(), &[1.0][..]);
    /// ```
    pub fn new() -> Node<u32> {
        let storage = Box::new(0) as Box<dyn Any>;
        Node::new(storage, |data_input, _input, output| {
            iter_n_inputs(data_input, output, |left: u32, right: u32| {
                if right == 0 {
                    return 0;
                }
                return left / right
            })
        })
    }
}



#[cfg(test)]
mod tests {
    use alloc::vec::Vec;
    use crate::operations::math::divide::{Divide, IntegerDivide};

    #[test]
    fn test_div() {

        let mut inputs = Vec::new();
        inputs.push(&[1.0][..]);
        inputs.push(&[2.0][..]);

        let mut div = Divide::new();
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[0.5][..]);
    }

    #[test]
    fn test_multiple() {

        let mut inputs = Vec::new();
        inputs.push(&[1.0][..]);
        inputs.push(&[2.0][..]);
        inputs.push(&[2.0][..]);

        let mut div = Divide::new();
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[0.25][..]);
    }

    #[test]
    fn test_multiple_runs() {

        let mut inputs = Vec::new();
        inputs.push(&[1.0][..]);
        inputs.push(&[1.0][..]);

        let mut div = Divide::new();
        div.process((inputs, 1));


        let mut inputs = Vec::new();
        inputs.push(&[2.0][..]);
        inputs.push(&[4.0][..]);
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[0.5][..]);
    }

    #[test]
    fn test_multiple_single() {

        let mut inputs = Vec::new();
        inputs.push(&[1.0][..]);

        let mut div = Divide::new();
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[1.0][..]);
    }

    #[test]
    fn test_float_div_zero() {

        let mut inputs = Vec::new();
        inputs.push(&[1.0][..]);
        inputs.push(&[0.0][..]);

        let mut div = Divide::new();
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[f32::INFINITY][..]);
    }

    #[test]
    fn test_int_div_zero() {

        let mut inputs = Vec::new();
        inputs.push(&[1][..]);
        inputs.push(&[0][..]);

        let mut div = IntegerDivide::new();
        div.process((inputs, 1));

        assert_eq!(div.poll(), &[0][..]);
    }
}